MetricsOptions (Apache Beam 2.67.0)

All Superinterfaces:: HasDisplayData, PipelineOptions

public interface MetricsOptions extends PipelineOptions

Extension of PipelineOptions that defines MetricsSink specific options.

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static class

MetricsOptions.NoOpMetricsSink

A DefaultValueFactory that obtains the class of the NoOpMetricsSink if it exists on the classpath, and throws an exception otherwise.

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.PipelineOptions
PipelineOptions.AtomicLongFactory, PipelineOptions.CheckEnabled, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory
Method Summary

Modifier and Type

Method

Description

String

getMetricsGraphiteHost()

Integer

getMetricsGraphitePort()

String

getMetricsHttpSinkUrl()

Long

getMetricsPushPeriod()

Class<? extends MetricsSink>

getMetricsSink()

void

setMetricsGraphiteHost(String host)

void

setMetricsGraphitePort(Integer port)

void

setMetricsHttpSinkUrl(String metricsSink)

void

setMetricsPushPeriod(Long period)

void

setMetricsSink(Class<? extends MetricsSink> metricsSink)

Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData
populateDisplayData

Methods inherited from interface org.apache.beam.sdk.options.PipelineOptions
as, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, revision, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent

Method Details
- getMetricsSink
  
  @InstanceFactory(NoOpMetricsSink.class) Class<? extends MetricsSink> getMetricsSink()
- setMetricsSink
  
  void setMetricsSink(Class<? extends MetricsSink> metricsSink)
- getMetricsPushPeriod
  
  @Long(5L) Long getMetricsPushPeriod()
- setMetricsPushPeriod
  
  void setMetricsPushPeriod(Long period)
- getMetricsHttpSinkUrl
  
  String getMetricsHttpSinkUrl()
- setMetricsHttpSinkUrl
  
  void setMetricsHttpSinkUrl(String metricsSink)
- getMetricsGraphiteHost
  
  String getMetricsGraphiteHost()
- setMetricsGraphiteHost
  
  void setMetricsGraphiteHost(String host)
- getMetricsGraphitePort
  
  @Integer(2003) Integer getMetricsGraphitePort()
- setMetricsGraphitePort
  
  void setMetricsGraphitePort(Integer port)