Package com.codahale.metrics
Class Timer
java.lang.Object
com.codahale.metrics.Timer
A timer metric which aggregates timing durations and provides duration statistics, plus
throughput statistics via
Meter
.-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionlong
getCount()
Returns the number of events which have been marked.double
Returns the fifteen-minute moving average rate at which events have occurred since the meter was created.double
Returns the five-minute 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 one-minute 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.<T> T
timeSupplier
(Supplier<T> event) Times and records the duration of event.void
Adds a recorded duration.void
Adds a recorded duration.
-
Constructor Details
-
Method Details
-
update
Adds a recorded duration.- Parameters:
duration
- the length of the durationunit
- the scale unit ofduration
-
update
Adds a recorded duration.- Parameters:
duration
- theDuration
to add to the timer. Negative or zero value are ignored.
-
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
-
timeSupplier
Times and records the duration of event. Should not throw exceptions, for that use thetime(Callable)
method.- Type Parameters:
T
- the type of the value returned byevent
- Parameters:
event
- aSupplier
whoseSupplier.get()
method implements a process whose duration should be timed- Returns:
- the value returned by
event
-
time
Times and records the duration of event.- Parameters:
event
- aRunnable
whoseRunnable.run()
method implements a process whose duration should be timed
-
time
Returns a newTimer.Context
.- Returns:
- a new
Timer.Context
- See Also:
-
getCount
public long getCount()Description copied from interface:Metered
Returns the number of events which have been marked. -
getFifteenMinuteRate
public double getFifteenMinuteRate()Description copied from interface:Metered
Returns the fifteen-minute moving average rate at which events have occurred since the meter was created.- Specified by:
getFifteenMinuteRate
in interfaceMetered
- Returns:
- the fifteen-minute moving average rate at which events have occurred since the meter was created
-
getFiveMinuteRate
public double getFiveMinuteRate()Description copied from interface:Metered
Returns the five-minute moving average rate at which events have occurred since the meter was created.- Specified by:
getFiveMinuteRate
in interfaceMetered
- Returns:
- the five-minute moving average rate at which events have occurred since the meter was created
-
getMeanRate
public 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
public double getOneMinuteRate()Description copied from interface:Metered
Returns the one-minute moving average rate at which events have occurred since the meter was created.- Specified by:
getOneMinuteRate
in interfaceMetered
- Returns:
- the one-minute moving average rate at which events have occurred since the meter was created
-
getSnapshot
Description copied from interface:Sampling
Returns a snapshot of the values.- Specified by:
getSnapshot
in interfaceSampling
- Returns:
- a snapshot of the values
-