io.micrometer.core.instrument

Interface Timer

All Superinterfaces:

Meter

All Known Implementing Classes:

AbstractTimer, CompositeTimer, DropwizardTimer, NoopTimer, StepTimer

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 class	Timer.Builder

Nested classes/interfaces inherited from interface io.micrometer.core.instrument.Meter

Meter.Id, Meter.Type

Method Summary

Modifier and Type	Method and Description
static Timer.Builder	builder(java.lang.String name)
long	count() The number of times that record has been called on this timer.
default Meter.Type	getType()
double	histogramCountAtValue(long valueNanos)
double	max(java.util.concurrent.TimeUnit unit) The maximum time of a single event.
default double	mean(java.util.concurrent.TimeUnit unit)
default java.lang.Iterable<Measurement>	measure() Get a set of measurements.
double	percentile(double percentile, java.util.concurrent.TimeUnit unit) The latency at a specific percentile.
default void	record(java.time.Duration duration) Updates the statistics kept by the counter with the specified amount.
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 recorded events.
<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 io.micrometer.core.instrument.Meter

builder, getId

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

default void record(java.time.Duration duration)

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

Parameters:

duration - Duration of a single event being measured by this timer.

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 on this timer.

totalTime

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

The total time of recorded events.

mean

default double mean(java.util.concurrent.TimeUnit unit)

max

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

The maximum time of a single event.

percentile

double percentile(double percentile,
                  java.util.concurrent.TimeUnit unit)

The latency at a specific percentile. This value is non-aggregable across dimensions.

histogramCountAtValue

double histogramCountAtValue(long valueNanos)

measure

default java.lang.Iterable<Measurement> measure()

Description copied from interface: Meter

Get a set of measurements. Should always return the same number of measurements and in the same order, regardless of the level of activity or the lack thereof.

Specified by:

measure in interface Meter

getType

default Meter.Type getType()

Specified by:

getType in interface Meter

builder

static Timer.Builder builder(java.lang.String name)