@DefaultAnnotation(value=org.checkerframework.checker.nullness.qual.NonNull.class)

Package org.apache.beam.sdk.metrics

Metrics allow exporting information about the execution of a pipeline.

See: Description

Interface Summary

Interface	Description
BoundedTrie	Internal: For internal use only and not for public consumption.
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 the MetricsContainer for the associated MetricsEnvironment.
MetricsOptions	Extension of PipelineOptions that defines MetricsSink specific options.
MetricsSink	Interface for all metric sinks.
StringSet	A metric that reports set of unique string values.

Class Summary

Class	Description
BoundedTrieResult	Internal: For internal use only and not for public consumption.
DelegatingCounter	Implementation of Counter that delegates to the instance for the current context.
DelegatingDistribution	Implementation of Distribution that delegates to the instance for the current context.
DelegatingGauge	Implementation of Gauge that delegates to the instance for the current context.
DelegatingHistogram	Implementation of Histogram that delegates to the instance for the current context.
DistributionResult	The result of a Distribution metric.
GaugeResult	The result of a Gauge metric.
GaugeResult.EmptyGaugeResult	Empty GaugeResult, representing no values reported.
LabeledMetricNameUtils	Util class for building/parsing labeled MetricName.
LabeledMetricNameUtils.MetricNameBuilder	Builder class for a labeled MetricName.
LabeledMetricNameUtils.ParsedMetricName
Lineage	Standard collection of metrics used to record source and sinks information for lineage tracking.
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 a MetricName.getNamespace() and a MetricName.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	The Metrics 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 a MetricsFilter.
MetricsOptions.NoOpMetricsSink	A DefaultValueFactory that obtains the class of the NoOpMetricsSink if it exists on the classpath, and throws an exception otherwise.
NoOpCounter	A no-op implementation of Counter.
NoOpGauge	A no-op implementation of Gauge.
NoOpHistogram	A no-op implementation of Histogram.
SinkMetrics	Standard Sink Metrics.
SourceMetrics	Standard Source Metrics.
StringSetResult	The result of a StringSet metric.
StringSetResult.EmptyStringSetResult	Empty StringSetResult, representing no values reported and is immutable.

Enum Summary

Enum	Description
Lineage.Type	Lineage metrics resource types.

Package org.apache.beam.sdk.metrics Description

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.