chore: updated docs and code sturcture for Dataproc metric configuration

Google APIs · copybara-github · commit 2e19de1a9735 · 2022-09-27T01:12:59.000-07:00
Committer: @akshatbhargava123 PiperOrigin-RevId: 477101789
diff --git a/google/cloud/dataproc/v1/clusters.proto b/google/cloud/dataproc/v1/clusters.proto
@@ -285,8 +285,8 @@ message ClusterConfig {
   // Optional. Metastore configuration.
   MetastoreConfig metastore_config = 20 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. Dataproc metrics configuration.
-  DataprocMetricConfig dataproc_metric_config = 21 [(google.api.field_behavior) = OPTIONAL];
+  // Optional. The config for Dataproc metrics.
+  DataprocMetricConfig dataproc_metric_config = 23 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Dataproc cluster config for a cluster that does not directly control the
@@ -946,45 +946,78 @@ message MetastoreConfig {
 }
 
 
-// Specifies Dataproc OSS Metric.
-message Metric {
+// Dataproc metric config.
+message DataprocMetricConfig {
+  // A source for the collection of Dataproc OSS metrics (see [available OSS
+  // metrics]
+  // (https://cloud.google.com//dataproc/docs/guides/monitoring#available_oss_metrics)).
   enum MetricSource {
-    // Unspecified metric source
+    // Required unspecified metric source.
     METRIC_SOURCE_UNSPECIFIED = 0;
 
     // Default monitoring agent metrics. If this source is enabled,
-    // Dataproc enables the monitoring agent in Compute Engine, and collects
-    // default monitoring agent metrics, which are published with an
-    // agent.googleapis.com prefix.
+    // Dataproc enables the monitoring agent in Compute Engine,
+    // and collects default monitoring agent metrics, which are published
+    // with an `agent.googleapis.com` prefix.
     MONITORING_AGENT_DEFAULTS = 1;
 
-    // HDFS metric source
+    // HDFS metric source.
     HDFS = 2;
 
-    // SPARK metric source
+    // Spark metric source.
     SPARK = 3;
 
-    // YARN metric source
+    // YARN metric source.
     YARN = 4;
 
-    // Spark History Server metric source
+    // Spark History Server metric source.
     SPARK_HISTORY_SERVER = 5;
 
-    // Hiveserver2 metric source
+    // Hiveserver2 metric source.
     HIVESERVER2 = 6;
   }
 
-  // Required. Specified source of metric collection
-  MetricSource metric_source = 1 [(google.api.field_behavior) = REQUIRED];
-
-  // Optional. The set of available OSS metrics to collect from the metric
-  // source.
-  repeated string metric_overrides = 2 [(google.api.field_behavior) = OPTIONAL];
-}
+  // A Dataproc OSS metric.
+  message Metric {
+    // Required. Default metrics are collected unless `metricOverrides` are
+    // specified for the metric source (see [Available OSS metrics]
+    // (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_metrics)
+    // for more information).
+    MetricSource metric_source = 1 [(google.api.field_behavior) = REQUIRED];
+
+    // Optional. Specify one or more [available OSS metrics]
+    // (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_metrics)
+    // to collect for the metric course (for the `SPARK` metric source, any
+    // [Spark metric]
+    // (https://spark.apache.org/docs/latest/monitoring.html#metrics) can be
+    // specified).
+    //
+    // Provide metrics in the following format:
+    // <code><var>METRIC_SOURCE</var>:<var>INSTANCE</var>:<var>GROUP</var>:<var>METRIC</var></code>
+    // Use camelcase as appropriate.
+    //
+    // Examples:
+    //
+    // ```
+    // yarn:ResourceManager:QueueMetrics:AppsCompleted
+    // spark:driver:DAGScheduler:job.allJobs
+    // sparkHistoryServer:JVM:Memory:NonHeapMemoryUsage.committed
+    // hiveserver2:JVM:Memory:NonHeapMemoryUsage.used
+    // ```
+    //
+    // Notes:
+    //
+    // * Only the specified overridden metrics will be collected for the
+    //   metric source. For example, if one or more `spark:executive` metrics
+    //   are listed as metric overrides, other `SPARK` metrics will not be
+    //   collected. The collection of the default metrics for other OSS metric
+    //   sources is unaffected. For example, if both `SPARK` andd `YARN` metric
+    //   sources are enabled, and overrides are provided for Spark metrics only,
+    //   all default YARN metrics will be collected.
+    repeated string metric_overrides = 2 [(google.api.field_behavior) = OPTIONAL];
+  }
 
-// Specifies a Dataproc metric config
-message DataprocMetricConfig {
-  // Configuration set of metrics to collect from the cluster
+  // Required. Metrics sources to enable.
   repeated Metric metrics = 1 [(google.api.field_behavior) = REQUIRED];
 }
 
