blob: fc864200df4712fcd80e2af3bbb0e3bf6710e42d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/*
* Copyright 2018, OpenCensus Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.opencensus.metrics.export;
import io.opencensus.common.ExperimentalApi;
import io.opencensus.internal.Utils;
import io.opencensus.metrics.MetricProducer;
import java.util.Collections;
import java.util.Set;
import javax.annotation.concurrent.ThreadSafe;
/**
* Keeps a set of {@link MetricProducer} that is used by exporters to determine the metrics that
* need to be exported.
*
* @since 0.17
*/
@ExperimentalApi
@ThreadSafe
public abstract class MetricProducerManager {
/**
* Adds the {@link MetricProducer} to the manager if it is not already present.
*
* @param metricProducer the {@code MetricProducer} to be added to the manager.
* @since 0.17
*/
public abstract void add(MetricProducer metricProducer);
/**
* Removes the {@link MetricProducer} to the manager if it is present.
*
* @param metricProducer the {@code MetricProducer} to be removed from the manager.
* @since 0.17
*/
public abstract void remove(MetricProducer metricProducer);
/**
* Returns all registered {@link MetricProducer}s that should be exported.
*
* <p>This method should be used by any metrics exporter that automatically exports data for
* {@code MetricProducer} registered with the {@code MetricProducerManager}.
*
* @return all registered {@code MetricProducer}s that should be exported.
* @since 0.17
*/
public abstract Set<MetricProducer> getAllMetricProducer();
/**
* Returns a no-op implementation for {@link MetricProducerManager}.
*
* @return a no-op implementation for {@code MetricProducerManager}.
*/
static MetricProducerManager newNoopMetricProducerManager() {
return new NoopMetricProducerManager();
}
private static final class NoopMetricProducerManager extends MetricProducerManager {
@Override
public void add(MetricProducer metricProducer) {
Utils.checkNotNull(metricProducer, "metricProducer");
}
@Override
public void remove(MetricProducer metricProducer) {
Utils.checkNotNull(metricProducer, "metricProducer");
}
@Override
public Set<MetricProducer> getAllMetricProducer() {
return Collections.emptySet();
}
}
}
|
