/
Timer.java
107 lines (97 loc) · 3.31 KB
/
Timer.java
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
/*
**********************************************************************
* Copyright (c) 2017, 2020 Contributors to the Eclipse Foundation
* 2010, 2013 Coda Hale, Yammer.com
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* 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.
*
* SPDX-License-Identifier: Apache-2.0
**********************************************************************/
package org.eclipse.microprofile.metrics;
import java.io.Closeable;
import java.time.Duration;
import java.util.concurrent.Callable;
/**
* A timer metric which aggregates timing durations and provides duration statistics, plus throughput statistics via
* {@link Meter}.
*
* See {@link SimpleTimer} for a lightweight alternative that only tracks elapsed time duration and count.
*
* The timer measures duration in nanoseconds.
*/
public interface Timer extends Sampling {
/**
* A timing context.
*
* @see Timer#time()
*/
interface Context extends Closeable {
/**
* Updates the timer with the difference between current and start time. Call to this method will not reset the
* start time. Multiple calls result in multiple updates.
*
* @return the elapsed time in nanoseconds
*/
long stop();
/** Equivalent to calling {@link #stop()}. */
@Override
void close();
}
/**
* Adds a recorded duration.
*
* @param duration
* the length of the {@link java.time.Duration duration}
*/
void update(Duration duration);
/**
* Times and records the duration of event.
*
* @param event
* a {@link Callable} whose {@link Callable#call()} method implements a process whose duration should be
* timed
* @param <T>
* the type of the value returned by {@code event}
* @return the value returned by {@code event}
* @throws Exception
* if {@code event} throws an {@link Exception}
*/
<T> T time(Callable<T> event) throws Exception;
/**
* Times and records the duration of event.
*
* @param event
* a {@link Runnable} whose {@link Runnable#run()} method implements a process whose duration should be
* timed
*/
void time(Runnable event);
/**
* Returns a new {@link Context}.
*
* @return a new {@link Context}
* @see Context
*/
Context time();
/**
* Returns the total elapsed timing durations of all completed timing events that are recorded with
* {@link #update(Duration)}.
*
* @return the elapsed time {@link java.time.Duration duration}
*/
Duration getElapsedTime();
@Override
Snapshot getSnapshot();
}