org.apache.beam.sdk.metrics

Interface MetricsOptions

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 and 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 and Description
java.lang.String	getMetricsGraphiteHost()
java.lang.Integer	getMetricsGraphitePort()
java.lang.String	getMetricsHttpSinkUrl()
java.lang.Long	getMetricsPushPeriod()
java.lang.Class<? extends MetricsSink>	getMetricsSink()
void	setMetricsGraphiteHost(java.lang.String host)
void	setMetricsGraphitePort(java.lang.Integer port)
void	setMetricsHttpSinkUrl(java.lang.String metricsSink)
void	setMetricsPushPeriod(java.lang.Long period)
void	setMetricsSink(java.lang.Class<? extends MetricsSink> metricsSink)

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

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

populateDisplayData

Method Detail

getMetricsSink

@Default.InstanceFactory(value=MetricsOptions.NoOpMetricsSink.class)
java.lang.Class<? extends MetricsSink> getMetricsSink()

setMetricsSink

void setMetricsSink(java.lang.Class<? extends MetricsSink> metricsSink)

getMetricsPushPeriod

@Default.Long(value=5L)
java.lang.Long getMetricsPushPeriod()

setMetricsPushPeriod

void setMetricsPushPeriod(java.lang.Long period)

getMetricsHttpSinkUrl

java.lang.String getMetricsHttpSinkUrl()

setMetricsHttpSinkUrl

void setMetricsHttpSinkUrl(java.lang.String metricsSink)

getMetricsGraphiteHost

java.lang.String getMetricsGraphiteHost()

setMetricsGraphiteHost

void setMetricsGraphiteHost(java.lang.String host)

getMetricsGraphitePort

@Default.Integer(value=2003)
java.lang.Integer getMetricsGraphitePort()

setMetricsGraphitePort

void setMetricsGraphitePort(java.lang.Integer port)