Interface DataprocMetricConfig.MetricOrBuilder (4.24.0)

Version 4.24.0

• 4.52.0 (latest)
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.46.0
• 4.45.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.34.0
• 4.33.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.8
• 3.1.2
• 3.0.3
• 2.3.1

public static interface DataprocMetricConfig.MetricOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getMetricOverrides(int index)

public abstract String getMetricOverrides(int index)

Optional. Specify one or more Custom metrics to collect for the metric course (for the SPARK metric source (any Spark metric 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 are collected for the metric source. For example, if one or more

spark:executive metrics are listed as metric overrides, other SPARK metrics are not collected. The collection of the metrics for other enabled custom metric sources is unaffected. For example, if both SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all YARN metrics are collected.

repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The metricOverrides at the given index.

getMetricOverridesBytes(int index)

public abstract ByteString getMetricOverridesBytes(int index)

Optional. Specify one or more Custom metrics to collect for the metric course (for the SPARK metric source (any Spark metric 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 are collected for the metric source. For example, if one or more

spark:executive metrics are listed as metric overrides, other SPARK metrics are not collected. The collection of the metrics for other enabled custom metric sources is unaffected. For example, if both SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all YARN metrics are collected.

repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the metricOverrides at the given index.

getMetricOverridesCount()

public abstract int getMetricOverridesCount()

Optional. Specify one or more Custom metrics to collect for the metric course (for the SPARK metric source (any Spark metric 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 are collected for the metric source. For example, if one or more

spark:executive metrics are listed as metric overrides, other SPARK metrics are not collected. The collection of the metrics for other enabled custom metric sources is unaffected. For example, if both SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all YARN metrics are collected.

repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of metricOverrides.

getMetricOverridesList()

public abstract List<String> getMetricOverridesList()

Optional. Specify one or more Custom metrics to collect for the metric course (for the SPARK metric source (any Spark metric 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 are collected for the metric source. For example, if one or more

spark:executive metrics are listed as metric overrides, other SPARK metrics are not collected. The collection of the metrics for other enabled custom metric sources is unaffected. For example, if both SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all YARN metrics are collected.

repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the metricOverrides.

getMetricSource()

public abstract DataprocMetricConfig.MetricSource getMetricSource()

Required. A standard set of metrics is collected unless metricOverrides are specified for the metric source (see Custom metrics for more information).

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

Returns
Type	Description
DataprocMetricConfig.MetricSource	The metricSource.

getMetricSourceValue()

public abstract int getMetricSourceValue()

Required. A standard set of metrics is collected unless metricOverrides are specified for the metric source (see Custom metrics for more information).

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

Returns
Type	Description
int	The enum numeric value on the wire for metricSource.