Class QueueMetricProducer

java.lang.Object

io.opencensus.metrics.export.MetricProducer

io.opencensus.exporter.metrics.util.QueueMetricProducer

public final class QueueMetricProducer
extends MetricProducer

Wrapper of MetricProducer which allows metrics to be pushed and buffered.

Since:

0.20

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueueMetricProducer.Options	Options for QueueMetricProducer.

Field Summary

Fields

Modifier and Type	Field	Description
private final Queue<Metric>	bufferedMetrics
private static final int	DEFAULT_BUFFER_SIZE
private static final Object	monitor

Constructor Summary

Constructors

Modifier	Constructor	Description
private	QueueMetricProducer(int bufferSize)

Method Summary

Modifier and Type	Method	Description
static QueueMetricProducer	create(QueueMetricProducer.Options options)	Creates a new QueueMetricProducer.
Collection<Metric>	getMetrics()	Returns a collection of produced Metrics to be exported.
void	pushMetrics(Collection<Metric> metrics)	Pushes Metrics to this QueueMetricProducer.

Methods inherited from class Object

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

Field Details

monitor

private static final Object monitor

DEFAULT_BUFFER_SIZE

private static final int DEFAULT_BUFFER_SIZE

See Also:

• Constant Field Values

bufferedMetrics

private final Queue<Metric> bufferedMetrics

Constructor Details

QueueMetricProducer

private QueueMetricProducer(int bufferSize)

Method Details

create

public static QueueMetricProducer create(QueueMetricProducer.Options options)

Creates a new QueueMetricProducer.

Parameters:

options - the options for QueueMetricProducer.

Returns:

a QueueMetricProducer.

Since:

0.20

pushMetrics

public void pushMetrics(Collection<Metric> metrics)

Pushes Metrics to this QueueMetricProducer.

When buffer of this QueueMetricProducer is full, the oldest Metrics will be dropped.

Parameters:

metrics - Metrics to be added to this QueueMetricProducer.

Since:

0.20

getMetrics

public Collection<Metric> getMetrics()

Description copied from class: MetricProducer

Returns a collection of produced Metrics to be exported.

Specified by:

getMetrics in class MetricProducer

Returns:

a collection of produced Metrics to be exported.