org.springframework.metrics.instrument

Interface Timer

All Superinterfaces:

Meter

All Known Implementing Classes:

AbstractTimer, PrometheusTimer, SimpleTimer, SpectatorTimer

public interface Timer
extends Meter

Timer intended to track of a large number of short running events. Example would be something like an HTTP request. Though "short running" is a bit subjective the assumption is that it should be under a minute.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Timer.Builder

Nested classes/interfaces inherited from interface org.springframework.metrics.instrument.Meter

Meter.Type

Method Summary

Modifier and Type	Method and Description
long	count() The number of times that record has been called since this timer was created.
default Meter.Type	getType()
void	record(long amount, java.util.concurrent.TimeUnit unit) Updates the statistics kept by the counter with the specified amount.
void	record(java.lang.Runnable f) Executes the runnable `f` and records the time taken.
<T> T	record(java.util.function.Supplier<T> f) Executes the Supplier `f` and records the time taken.
<T> T	recordCallable(java.util.concurrent.Callable<T> f) Executes the callable `f` and records the time taken.
double	totalTime(java.util.concurrent.TimeUnit unit) The total time of all recorded events since this timer was created.
default double	totalTimeNanos() The total time in nanoseconds of all recorded events since this timer was created.
<T> java.util.concurrent.Callable<T>	wrap(java.util.concurrent.Callable<T> f) Wrap a Callable so that it is timed when invoked.
default java.lang.Runnable	wrap(java.lang.Runnable f) Wrap a Runnable so that it is timed when invoked.

Methods inherited from interface org.springframework.metrics.instrument.Meter

getName, getTags, measure

Method Detail

record

void record(long amount,
            java.util.concurrent.TimeUnit unit)

Updates the statistics kept by the counter with the specified amount.

Parameters:

amount - Duration of a single event being measured by this timer. If the amount is less than 0 the value will be dropped.

unit - Time unit for the amount being recorded.

record

<T> T record(java.util.function.Supplier<T> f)

Executes the Supplier `f` and records the time taken.

Parameters:

f - Function to execute and measure the execution time.

Returns:

The return value of `f`.

recordCallable

<T> T recordCallable(java.util.concurrent.Callable<T> f)
              throws java.lang.Exception

Executes the callable `f` and records the time taken.

Parameters:

f - Function to execute and measure the execution time.

Returns:

The return value of `f`.

Throws:

java.lang.Exception

record

void record(java.lang.Runnable f)

Executes the runnable `f` and records the time taken.

Parameters:

f - Function to execute and measure the execution time.

wrap

default java.lang.Runnable wrap(java.lang.Runnable f)

Wrap a Runnable so that it is timed when invoked.

Parameters:

f - The Runnable to time when it is invoked.

Returns:

The wrapped Runnable.

wrap

<T> java.util.concurrent.Callable<T> wrap(java.util.concurrent.Callable<T> f)

Wrap a Callable so that it is timed when invoked.

Parameters:

f - The Callable to time when it is invoked.

Returns:

The wrapped Callable.

count

long count()

The number of times that record has been called since this timer was created.

totalTime

double totalTime(java.util.concurrent.TimeUnit unit)

The total time of all recorded events since this timer was created.

totalTimeNanos

default double totalTimeNanos()

The total time in nanoseconds of all recorded events since this timer was created.

getType

default Meter.Type getType()

Specified by:

getType in interface Meter