aboutsummaryrefslogtreecommitdiff
path: root/api/src/main/java/io/opencensus/metrics/MetricRegistry.java
blob: ae4d90b066d28ca91989fe4e51abe306b90de44f (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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/*
 * 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.common.ToDoubleFunction;
import io.opencensus.common.ToLongFunction;
import io.opencensus.internal.Utils;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;

/**
 * Creates and manages your application's set of metrics. Exporters use the metric registry to
 * iterate over the set of metrics instrumenting your application, and then further export each
 * metric to the backend of choice.
 *
 * @since 0.16
 */
@ExperimentalApi
public abstract class MetricRegistry extends MetricProducer {
  /**
   * Build a new long gauge to be added to the registry.
   *
   * <p>Must be called only once.
   *
   * @param name the name of the metric.
   * @param description the description of the metric.
   * @param unit the unit of the metric.
   * @param obj the function argument.
   * @param function the function to be called.
   * @since 0.16 @ExperimentalApi
   */
  public abstract <T> void addLongGauge(
      String name,
      String description,
      String unit,
      LinkedHashMap<LabelKey, LabelValue> labels,
      T obj,
      ToLongFunction<T> function);

  /**
   * Build a new double gauge to be added to the registry.
   *
   * <p>Must be called only once.
   *
   * @param name the name of the metric.
   * @param description the description of the metric.
   * @param unit the unit of the metric.
   * @param obj the function argument.
   * @param function the function to be called.
   * @since 0.16 @ExperimentalApi
   */
  public abstract <T> void addDoubleGauge(
      String name,
      String description,
      String unit,
      LinkedHashMap<LabelKey, LabelValue> labels,
      T obj,
      ToDoubleFunction<T> function);

  static MetricRegistry newNoopMetricRegistry() {
    return new NoopMetricRegistry();
  }

  private static final class NoopMetricRegistry extends MetricRegistry {

    @Override
    public <T> void addLongGauge(
        String name,
        String description,
        String unit,
        LinkedHashMap<LabelKey, LabelValue> labels,
        T obj,
        ToLongFunction<T> function) {
      Utils.checkNotNull(name, "name");
      Utils.checkNotNull(description, "description");
      Utils.checkNotNull(unit, "unit");
      Utils.checkNotNull(labels, "labels");
      Utils.checkNotNull(function, "function");
    }

    @Override
    public <T> void addDoubleGauge(
        String name,
        String description,
        String unit,
        LinkedHashMap<LabelKey, LabelValue> labels,
        T obj,
        ToDoubleFunction<T> function) {
      Utils.checkNotNull(name, "name");
      Utils.checkNotNull(description, "description");
      Utils.checkNotNull(unit, "unit");
      Utils.checkNotNull(labels, "labels");
      Utils.checkNotNull(function, "function");
    }

    @Override
    public Collection<Metric> getMetrics() {
      return Collections.emptyList();
    }
  }
}