Package org.eclipse.microprofile.metrics
Interface Timer
A timer metric which aggregates timing durations and provides duration statistics, plus
throughput statistics via
Meter
.
The timer measures duration in nanoseconds.
Nested Class Summary

Method Summary
Modifier and TypeMethodDescriptionlong
getCount()
Returns the number of events which have been marked.double
Returns the fifteenminute exponentiallyweighted moving average rate at which events have occurred since the meter was created.double
Returns the fiveminute exponentiallyweighted moving average rate at which events have occurred since the meter was created.double
Returns the mean rate at which events have occurred since the meter was created.double
Returns the oneminute exponentiallyweighted moving average rate at which events have occurred since the meter was created.Returns a snapshot of the values.time()
Returns a newTimer.Context
.void
Times and records the duration of event.<T> T
Times and records the duration of event.void
Adds a recorded duration.

Method Details

update
Adds a recorded duration. Parameters:
duration
 the length of the durationunit
 the scale unit ofduration

time
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:
Exception
 ifevent
throws anException

time
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:

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 fifteenminute exponentiallyweighted moving average rate at which events have occurred since the meter was created. This rate has the same exponential decay factor as the fifteenminute load average in thetop
Unix command. Specified by:
getFifteenMinuteRate
in interfaceMetered
 Returns:
 the fifteenminute exponentiallyweighted moving average rate at which events have occurred since the meter was created

getFiveMinuteRate
double getFiveMinuteRate()Description copied from interface:Metered
Returns the fiveminute exponentiallyweighted moving average rate at which events have occurred since the meter was created. This rate has the same exponential decay factor as the fiveminute load average in thetop
Unix command. Specified by:
getFiveMinuteRate
in interfaceMetered
 Returns:
 the fiveminute exponentiallyweighted 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 oneminute exponentiallyweighted moving average rate at which events have occurred since the meter was created. This rate has the same exponential decay factor as the oneminute load average in thetop
Unix command. Specified by:
getOneMinuteRate
in interfaceMetered
 Returns:
 the oneminute exponentiallyweighted 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
