Package org.eclipse.microprofile.metrics
Interface Timer
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Timer.Context
A timing context.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
getCount()
Returns the number of events which have been marked.double
getFifteenMinuteRate()
Returns the fifteen-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.double
getFiveMinuteRate()
Returns the five-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.double
getMeanRate()
Returns the mean rate at which events have occurred since the meter was created.double
getOneMinuteRate()
Returns the one-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.Snapshot
getSnapshot()
Returns a snapshot of the values.Timer.Context
time()
Returns a newTimer.Context
.void
time(java.lang.Runnable event)
Times and records the duration of event.<T> T
time(java.util.concurrent.Callable<T> event)
Times and records the duration of event.void
update(long duration, java.util.concurrent.TimeUnit unit)
Adds a recorded duration.
-
-
-
Method Detail
-
update
void update(long duration, java.util.concurrent.TimeUnit unit)
Adds a recorded duration.- Parameters:
duration
- the length of the durationunit
- the scale unit ofduration
-
time
<T> T time(java.util.concurrent.Callable<T> event) throws java.lang.Exception
Times and records the duration of event.- Type Parameters:
T
- the type of the value returned byevent
- Parameters:
event
- aCallable
whoseCallable.call()
method implements a process whose duration should be timed- Returns:
- the value returned by
event
- Throws:
java.lang.Exception
- ifevent
throws anException
-
time
void time(java.lang.Runnable event)
Times and records the duration of event.- Parameters:
event
- aRunnable
whoseRunnable.run()
method implements a process whose duration should be timed
-
time
Timer.Context time()
Returns a newTimer.Context
.- Returns:
- a new
Timer.Context
- See Also:
Timer.Context
-
getCount
long getCount()
Description copied from interface:Metered
Returns the number of events which have been marked.
-
getFifteenMinuteRate
double getFifteenMinuteRate()
Description copied from interface:Metered
Returns the fifteen-minute exponentially-weighted moving average rate at which events have occurred since the meter was created. This rate has the same exponential decay factor as the fifteen-minute load average in thetop
Unix command.- Specified by:
getFifteenMinuteRate
in interfaceMetered
- Returns:
- the fifteen-minute exponentially-weighted moving average rate at which events have occurred since the meter was created
-
getFiveMinuteRate
double getFiveMinuteRate()
Description copied from interface:Metered
Returns the five-minute exponentially-weighted moving average rate at which events have occurred since the meter was created. This rate has the same exponential decay factor as the five-minute load average in thetop
Unix command.- Specified by:
getFiveMinuteRate
in interfaceMetered
- Returns:
- the five-minute exponentially-weighted moving average rate at which events have occurred since the meter was created
-
getMeanRate
double getMeanRate()
Description copied from interface:Metered
Returns the mean rate at which events have occurred since the meter was created.- Specified by:
getMeanRate
in interfaceMetered
- Returns:
- the mean rate at which events have occurred since the meter was created
-
getOneMinuteRate
double getOneMinuteRate()
Description copied from interface:Metered
Returns the one-minute exponentially-weighted moving average rate at which events have occurred since the meter was created. This rate has the same exponential decay factor as the one-minute load average in thetop
Unix command.- Specified by:
getOneMinuteRate
in interfaceMetered
- Returns:
- the one-minute exponentially-weighted moving average rate at which events have occurred since the meter was created
-
getSnapshot
Snapshot getSnapshot()
Description copied from interface:Sampling
Returns a snapshot of the values.- Specified by:
getSnapshot
in interfaceSampling
- Returns:
- a snapshot of the values
-
-