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       */
27      <T extends Number> void gauge(String name, Gauge<T> gauge);
28  
29      /**
30       * Creates a new {@link Counter} and registers it under the given name.
31       *
32       * @param name the name of the metric
33       * @return a new {@link Counter}
34       */
35      Counter counter(String name);
36  
37      /**
38       * Creates a new {@link Timer} and registers it under the given name.
39       *
40       * @param name the name of the metric
41       * @return a new {@link Timer}
42       */
43      Timer timer(String name);
44  
45      /**
46       * Creates a new {@link Meter} and registers it under the given name.
47       *
48       * @param name the name of the metric
49       * @return a new {@link Meter}
50       */
51      Meter meter(String name);
52  
53      /**
54       * Creates a new {@link Histogram} and registers it under the given name.
55       *
56       * @param name the name of the metric
57       * @return a new {@link Histogram}
58       */
59      Histogram histogram(String name);
60  }