Package org.apache.beam.sdk.metrics

@DefaultAnnotation(org.checkerframework.checker.nullness.qual.NonNull.class) 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.

Related Packages

Package	Description
org.apache.beam.sdk	Provides a simple, powerful model for building both batch and streaming parallel data processing Pipelines.

Class	Description
BoundedTrie	Internal: For internal use only and not for public consumption.
BoundedTrieResult	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.
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.
Distribution	A metric that reports information about the distribution of reported values.
DistributionResult	The result of a Distribution metric.
Gauge	A metric that reports the latest value out of reported values.
GaugeResult	The result of a Gauge metric.
GaugeResult.EmptyGaugeResult	Empty GaugeResult, representing no values reported.
Histogram	A metric that reports information about the histogram of reported values.
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.
Lineage.Type	Lineage metrics resource types.
Metric	Marker interface for all user-facing metrics.
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.
MetricsContainer	Holds the metrics for a single step.
MetricsEnvironment	Manages and provides the metrics container associated with each thread.
MetricsEnvironment.MetricsContainerHolder
MetricsEnvironment.MetricsEnvironmentState	Set the MetricsContainer for the associated MetricsEnvironment.
MetricsFilter	Simple POJO representing a filter for querying metrics.
MetricsFilter.Builder	Builder for creating a MetricsFilter.
MetricsOptions	Extension of PipelineOptions that defines MetricsSink specific options.
MetricsOptions.NoOpMetricsSink	A DefaultValueFactory that obtains the class of the NoOpMetricsSink if it exists on the classpath, and throws an exception otherwise.
MetricsSink	Interface for all metric sinks.
NoOpCounter	A no-op implementation of Counter.
NoOpHistogram	A no-op implementation of Histogram.
SinkMetrics	Standard Sink Metrics.
SourceMetrics	Standard Source Metrics.
StringSet	A metric that reports set of unique string values.
StringSetResult	The result of a StringSet metric.
StringSetResult.EmptyStringSetResult	Empty StringSetResult, representing no values reported and is immutable.