@DefaultAnnotation(org.checkerframework.checker.nullness.qual.NonNull.class) @Experimental(METRICS)
Package org.apache.beam.sdk.metrics
Metrics allow exporting information about the execution of a pipeline. They are intended to be
used for monitoring and understanding the execution.
Metrics may also be queried from the PipelineResult
object.
Runners should look at MetricsContainer
for details on how
to support metrics.
-
Interface Summary Interface Description Counter A metric that reports a single long value and can be incremented or decremented.Distribution A metric that reports information about the distribution of reported values.Gauge A metric that reports the latest value out of reported values.Histogram A metric that reports information about the histogram of reported values.Metric Marker interface for all user-facing metrics.MetricsContainer Holds the metrics for a single step.MetricsEnvironment.MetricsEnvironmentState Set theMetricsContainer
for the associatedMetricsEnvironment
.MetricsOptions Extension ofPipelineOptions
that definesMetricsSink
specific options.MetricsSink Interface for all metric sinks. -
Class Summary Class Description DelegatingCounter Implementation ofCounter
that delegates to the instance for the current context.DelegatingDistribution Implementation ofDistribution
that delegates to the instance for the current context.DelegatingHistogram Implementation ofHistogram
that delegates to the instance for the current context.DistributionResult The result of aDistribution
metric.GaugeResult The result of aGauge
metric.GaugeResult.EmptyGaugeResult EmptyGaugeResult
, representing no values reported.MetricFiltering Implements matching for metrics filters.MetricKey Metrics are keyed by the step name they are associated with and the name of the metric.MetricName The name of a metric consists of aMetricName.getNamespace()
and aMetricName.getName()
.MetricNameFilter The name of a metric.MetricQueryResults The results of a query for metrics.MetricResult<T> The results of a single current metric.MetricResults Methods for interacting with the metrics of a pipeline that has been executed.Metrics TheMetrics
is a utility class for producing various kinds of metrics for reporting properties of an executing pipeline.MetricsEnvironment Manages and provides the metrics container associated with each thread.MetricsEnvironment.MetricsContainerHolder MetricsFilter Simple POJO representing a filter for querying metrics.MetricsFilter.Builder Builder for creating aMetricsFilter
.MetricsOptions.NoOpMetricsSink ADefaultValueFactory
that obtains the class of theNoOpMetricsSink
if it exists on the classpath, and throws an exception otherwise.SinkMetrics Standard Sink Metrics.SourceMetrics StandardSource
Metrics.