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
90
91
92
93
94
95
96
|
/*
* 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;
import io.opencensus.common.ExperimentalApi;
import io.opencensus.internal.Utils;
import java.util.List;
/**
* Creates and manages your application's set of metrics. The default implementation of this creates
* a {@link io.opencensus.metrics.export.MetricProducer} and registers it to the global {@link
* io.opencensus.metrics.export.MetricProducerManager}.
*
* @since 0.17
*/
@ExperimentalApi
public abstract class MetricRegistry {
/**
* Builds a new long gauge to be added to the registry. This is more convenient form when you want
* to manually increase and decrease values as per your service requirements.
*
* @param name the name of the metric.
* @param description the description of the metric.
* @param unit the unit of the metric.
* @param labelKeys the list of the label keys.
* @throws NullPointerException if {@code labelKeys} is null OR any element of {@code labelKeys}
* is null OR {@code name}, {@code description}, {@code unit} is null.
* @throws IllegalArgumentException if different metric with the same name already registered.
* @since 0.17
*/
@ExperimentalApi
public abstract LongGauge addLongGauge(
String name, String description, String unit, List<LabelKey> labelKeys);
/**
* Builds a new double gauge to be added to the registry. This is more convenient form when you
* want to manually increase and decrease values as per your service requirements.
*
* @param name the name of the metric.
* @param description the description of the metric.
* @param unit the unit of the metric.
* @param labelKeys the list of the label keys.
* @throws NullPointerException if {@code labelKeys} is null OR any element of {@code labelKeys}
* is null OR {@code name}, {@code description}, {@code unit} is null.
* @throws IllegalArgumentException if different metric with the same name already registered.
* @since 0.17
*/
@ExperimentalApi
public abstract DoubleGauge addDoubleGauge(
String name, String description, String unit, List<LabelKey> labelKeys);
static MetricRegistry newNoopMetricRegistry() {
return new NoopMetricRegistry();
}
private static final class NoopMetricRegistry extends MetricRegistry {
@Override
public LongGauge addLongGauge(
String name, String description, String unit, List<LabelKey> labelKeys) {
Utils.checkListElementNotNull(
Utils.checkNotNull(labelKeys, "labelKeys"), "labelKey element should not be null.");
return LongGauge.newNoopLongGauge(
Utils.checkNotNull(name, "name"),
Utils.checkNotNull(description, "description"),
Utils.checkNotNull(unit, "unit"),
labelKeys);
}
@Override
public DoubleGauge addDoubleGauge(
String name, String description, String unit, List<LabelKey> labelKeys) {
Utils.checkListElementNotNull(
Utils.checkNotNull(labelKeys, "labelKeys"), "labelKey element should not be null.");
return DoubleGauge.newNoopDoubleGauge(
Utils.checkNotNull(name, "name"),
Utils.checkNotNull(description, "description"),
Utils.checkNotNull(unit, "unit"),
labelKeys);
}
}
}
|
