Class MetricProducerManager

java.lang.Object

io.opencensus.metrics.export.MetricProducerManager

Direct Known Subclasses:

MetricProducerManager.NoopMetricProducerManager, MetricProducerManagerImpl

@ExperimentalApi
@ThreadSafe
public abstract class MetricProducerManager
extends Object

Keeps a set of MetricProducer that is used by exporters to determine the metrics that need to be exported.

Since:

0.17

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	MetricProducerManager.NoopMetricProducerManager

Constructor Summary

Constructors

Constructor	Description
MetricProducerManager()

Method Summary

Modifier and Type	Method	Description
abstract void	add(MetricProducer metricProducer)	Adds the MetricProducer to the manager if it is not already present.
abstract Set<MetricProducer>	getAllMetricProducer()	Returns all registered MetricProducers that should be exported.
(package private) static MetricProducerManager	newNoopMetricProducerManager()	Returns a no-op implementation for MetricProducerManager.
abstract void	remove(MetricProducer metricProducer)	Removes the MetricProducer to the manager if it is present.

Methods inherited from class Object

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

Constructor Details

MetricProducerManager

public MetricProducerManager()

Method Details

add

public abstract void add(MetricProducer metricProducer)

Adds the MetricProducer to the manager if it is not already present.

Parameters:

metricProducer - the MetricProducer to be added to the manager.

Since:

0.17

remove

public abstract void remove(MetricProducer metricProducer)

Removes the MetricProducer to the manager if it is present.

Parameters:

metricProducer - the MetricProducer to be removed from the manager.

Since:

0.17

getAllMetricProducer

public abstract Set<MetricProducer> getAllMetricProducer()

Returns all registered MetricProducers that should be exported.

This method should be used by any metrics exporter that automatically exports data for MetricProducer registered with the MetricProducerManager.

Returns:

all registered MetricProducers that should be exported.

Since:

0.17

newNoopMetricProducerManager

static MetricProducerManager newNoopMetricProducerManager()

Returns a no-op implementation for MetricProducerManager.

Returns:

a no-op implementation for MetricProducerManager.