Class: Google::Apis::DataprocV1::Metric

Inherits:

Object

• Object
• Google::Apis::DataprocV1::Metric

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/dataproc_v1/classes.rb,
lib/google/apis/dataproc_v1/representations.rb,
lib/google/apis/dataproc_v1/representations.rb

Overview

A Dataproc OSS metric.

Instance Attribute Summary

• #metric_overrides ⇒ Array<String>

  Optional.

• #metric_source ⇒ String

  Required.

Instance Method Summary

• #initialize(**args) ⇒ Metric constructor

  A new instance of Metric.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ Metric

Returns a new instance of Metric.

# File 'lib/google/apis/dataproc_v1/classes.rb', line 3171

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#metric_overrides ⇒ Array<String>

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: 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. Corresponds to the JSON property metricOverrides

Returns:

• (Array<String>)

# File 'lib/google/apis/dataproc_v1/classes.rb', line 3162

def metric_overrides
  @metric_overrides
end

#metric_source ⇒ String

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). Corresponds to the JSON property metricSource

Returns:

• (String)

# File 'lib/google/apis/dataproc_v1/classes.rb', line 3169

def metric_source
  @metric_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/dataproc_v1/classes.rb', line 3176

def update!(**args)
  @metric_overrides = args[:metric_overrides] if args.key?(:metric_overrides)
  @metric_source = args[:metric_source] if args.key?(:metric_source)
end