Package io.opencensus.metrics.export
Class MetricProducerManager
- java.lang.Object
-
- io.opencensus.metrics.export.MetricProducerManager
-
- Direct Known Subclasses:
MetricProducerManager.NoopMetricProducerManager
,MetricProducerManagerImpl
@ExperimentalApi @ThreadSafe public abstract class MetricProducerManager extends java.lang.Object
Keeps a set ofMetricProducer
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 class
MetricProducerManager.NoopMetricProducerManager
-
Constructor Summary
Constructors Constructor Description MetricProducerManager()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
add(MetricProducer metricProducer)
Adds theMetricProducer
to the manager if it is not already present.abstract java.util.Set<MetricProducer>
getAllMetricProducer()
Returns all registeredMetricProducer
s that should be exported.(package private) static MetricProducerManager
newNoopMetricProducerManager()
Returns a no-op implementation forMetricProducerManager
.abstract void
remove(MetricProducer metricProducer)
Removes theMetricProducer
to the manager if it is present.
-
-
-
Method Detail
-
add
public abstract void add(MetricProducer metricProducer)
Adds theMetricProducer
to the manager if it is not already present.- Parameters:
metricProducer
- theMetricProducer
to be added to the manager.- Since:
- 0.17
-
remove
public abstract void remove(MetricProducer metricProducer)
Removes theMetricProducer
to the manager if it is present.- Parameters:
metricProducer
- theMetricProducer
to be removed from the manager.- Since:
- 0.17
-
getAllMetricProducer
public abstract java.util.Set<MetricProducer> getAllMetricProducer()
Returns all registeredMetricProducer
s that should be exported.This method should be used by any metrics exporter that automatically exports data for
MetricProducer
registered with theMetricProducerManager
.- Returns:
- all registered
MetricProducer
s that should be exported. - Since:
- 0.17
-
newNoopMetricProducerManager
static MetricProducerManager newNoopMetricProducerManager()
Returns a no-op implementation forMetricProducerManager
.- Returns:
- a no-op implementation for
MetricProducerManager
.
-
-