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.hadoop.hbase.metrics;
19
20 import java.util.concurrent.TimeUnit;
21
22 import org.apache.hadoop.hbase.HBaseInterfaceAudience;
23 import org.apache.hadoop.hbase.classification.InterfaceAudience;
24 import org.apache.hadoop.hbase.classification.InterfaceStability;
25
26 /**
27 * A metric which encompasses a {@link Histogram} and {@link Meter}.
28 */
29 @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
30 @InterfaceStability.Evolving
31 public interface Timer extends Metric {
32 /**
33 * Update the timer with the given duration in given time unit.
34 * @param duration the duration of the event
35 * @param unit the time unit for the duration
36 */
37 void update(long duration, TimeUnit unit);
38
39 /**
40 * Update the timer with the given duration in milliseconds
41 * @param durationMillis the duration of the event in ms
42 */
43 void updateMillis(long durationMillis);
44
45 /**
46 * Update the timer with the given duration in microseconds
47 * @param durationMicros the duration of the event in microseconds
48 */
49 void updateMicros(long durationMicros);
50
51 /**
52 * Update the timer with the given duration in nanoseconds
53 * @param durationNanos the duration of the event in ns
54 */
55 void updateNanos(long durationNanos);
56
57 @InterfaceAudience.Private
58 Histogram getHistogram();
59
60 @InterfaceAudience.Private
61 Meter getMeter();
62 }