Package org.apache.beam.sdk.metrics
Interface MetricsContainer
-
- All Superinterfaces:
java.io.Serializable
@Experimental(METRICS) public interface MetricsContainer extends java.io.Serializable
Holds the metrics for a single step. Each of the methods should return an implementation of the appropriate metrics interface for the "current" step.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Counter
getCounter(MetricName metricName)
Return theCounter
that should be used for implementing the givenmetricName
in this container.Distribution
getDistribution(MetricName metricName)
Return theDistribution
that should be used for implementing the givenmetricName
in this container.Gauge
getGauge(MetricName metricName)
Return theGauge
that should be used for implementing the givenmetricName
in this container.default Histogram
getHistogram(MetricName metricName, HistogramData.BucketType bucketType)
Return theHistogram
that should be used for implementing the givenmetricName
in this container.default java.lang.Iterable<org.apache.beam.model.pipeline.v1.MetricsApi.MonitoringInfo>
getMonitoringInfos()
Return the cumulative values for any metrics in this container as MonitoringInfos.
-
-
-
Method Detail
-
getCounter
Counter getCounter(MetricName metricName)
Return theCounter
that should be used for implementing the givenmetricName
in this container.
-
getDistribution
Distribution getDistribution(MetricName metricName)
Return theDistribution
that should be used for implementing the givenmetricName
in this container.
-
getGauge
Gauge getGauge(MetricName metricName)
Return theGauge
that should be used for implementing the givenmetricName
in this container.
-
getHistogram
default Histogram getHistogram(MetricName metricName, HistogramData.BucketType bucketType)
Return theHistogram
that should be used for implementing the givenmetricName
in this container.
-
getMonitoringInfos
default java.lang.Iterable<org.apache.beam.model.pipeline.v1.MetricsApi.MonitoringInfo> getMonitoringInfos()
Return the cumulative values for any metrics in this container as MonitoringInfos.
-
-