org.apache.beam.sdk.metrics

Class DelegatingHistogram

java.lang.Object

org.apache.beam.sdk.metrics.DelegatingHistogram

All Implemented Interfaces:

java.io.Serializable, Histogram, Metric

@Internal
public class DelegatingHistogram
extends java.lang.Object
implements Metric, Histogram, java.io.Serializable

Implementation of Histogram that delegates to the instance for the current context.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DelegatingHistogram(MetricName name, org.apache.beam.sdk.util.HistogramData.BucketType bucketType, boolean processWideContainer) Create a DelegatingHistogram with perWorkerHistogram set to false.
DelegatingHistogram(MetricName name, org.apache.beam.sdk.util.HistogramData.BucketType bucketType, boolean processWideContainer, boolean perWorkerHistogram)

Method Summary

Modifier and Type	Method and Description
MetricName	getName() The MetricName given to this metric.
void	update(double... values) Add observations to this histogram.
void	update(double value) Add an observation to this histogram.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DelegatingHistogram

public DelegatingHistogram(MetricName name,
                           org.apache.beam.sdk.util.HistogramData.BucketType bucketType,
                           boolean processWideContainer)

Create a DelegatingHistogram with perWorkerHistogram set to false.

Parameters:

name - Metric name for this metric.

bucketType - Histogram bucketing strategy.

processWideContainer - Whether this Counter is stored in the ProcessWide container or the current thread's container.

DelegatingHistogram

public DelegatingHistogram(MetricName name,
                           org.apache.beam.sdk.util.HistogramData.BucketType bucketType,
                           boolean processWideContainer,
                           boolean perWorkerHistogram)

Parameters:

name - Metric name for this metric.

bucketType - Histogram bucketing strategy.

processWideContainer - Whether this Counter is stored in the ProcessWide container or the current thread's container.

perWorkerHistogram - Whether this Histogram refers to a perWorker metric or not.

Method Detail

update

public void update(double value)

Description copied from interface: Histogram

Add an observation to this histogram.

Specified by:

update in interface Histogram

update

public void update(double... values)

Description copied from interface: Histogram

Add observations to this histogram.

Specified by:

update in interface Histogram

getName

public MetricName getName()

Description copied from interface: Metric

The MetricName given to this metric.

Specified by:

getName in interface Metric