Google Cloud Dataproc V1 Client - Class Metric (3.2.2)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class Metric.

A Dataproc OSS metric.

Generated from protobuf message google.cloud.dataproc.v1.DataprocMetricConfig.Metric

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ metric_source`	`int` Required. Default metrics are collected unless `metricOverrides` are specified for the metric source (see Available OSS metrics for more information).
`↳ metric_overrides`	`array` Optional. Specify one or more available OSS metrics to collect for the metric course (for the `SPARK` metric source, any Spark metric can be specified). Provide metrics in the following format: `METRIC_SOURCE:INSTANCE:GROUP:METRIC` 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.

getMetricSource

Required. Default metrics are collected unless metricOverrides are specified for the metric source (see Available OSS metrics for more information).

Generated from protobuf field .google.cloud.dataproc.v1.DataprocMetricConfig.MetricSource metric_source = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`

setMetricSource

Required. Default metrics are collected unless metricOverrides are specified for the metric source (see Available OSS metrics for more information).

Generated from protobuf field .google.cloud.dataproc.v1.DataprocMetricConfig.MetricSource metric_source = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getMetricOverrides

Optional. Specify one or more available OSS metrics to collect for the metric course (for the SPARK metric source, any Spark metric can be specified).

Provide metrics in the following format: METRIC_SOURCE:INSTANCE:GROUP:METRIC 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.

Generated from protobuf field repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setMetricOverrides

Optional. Specify one or more available OSS metrics to collect for the metric course (for the SPARK metric source, any Spark metric can be specified).

Provide metrics in the following format: METRIC_SOURCE:INSTANCE:GROUP:METRIC 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.

Generated from protobuf field repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`