View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.omid.metrics;
19  
20  public interface MetricsRegistry {
21  
22      /**
23       * Registers the {@link Gauge} under the given name.
24       *
25       * @param name the name of the metric
26       * @returns a new {@link Counter}
27       */
28      <T extends Number> void gauge(String name, Gauge<T> gauge);
29  
30      /**
31       * Creates a new {@link Counter} and registers it under the given name.
32       *
33       * @param name the name of the metric
34       * @return a new {@link Counter}
35       */
36      Counter counter(String name);
37  
38      /**
39       * Creates a new {@link Timer} and registers it under the given name.
40       *
41       * @param name the name of the metric
42       * @return a new {@link Timer}
43       */
44      Timer timer(String name);
45  
46      /**
47       * Creates a new {@link Meter} and registers it under the given name.
48       *
49       * @param name the name of the metric
50       * @return a new {@link Meter}
51       */
52      Meter meter(String name);
53  
54      /**
55       * Creates a new {@link Histogram} and registers it under the given name.
56       *
57       * @param name the name of the metric
58       * @return a new {@link Histogram}
59       */
60      Histogram histogram(String name);
61  }