io.micrometer.core.instrument.composite

Class CompositeTimer

java.lang.Object

io.micrometer.core.instrument.AbstractMeter

io.micrometer.core.instrument.composite.CompositeTimer

All Implemented Interfaces:

CompositeMeter, Meter, Timer

public class CompositeTimer
extends AbstractMeter
implements Timer, CompositeMeter

Nested Class Summary

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

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
void	add(MeterRegistry registry)
long	count() The number of times that record has been called on this timer.
double	histogramCountAtValue(long valueNanos)
double	max(java.util.concurrent.TimeUnit unit) The maximum time of a single event.
double	percentile(double percentile, java.util.concurrent.TimeUnit unit) The latency at a specific percentile.
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.
void	remove(MeterRegistry registry)
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.
java.lang.Runnable	wrap(java.lang.Runnable f) Wrap a Runnable so that it is timed when invoked.

Methods inherited from class io.micrometer.core.instrument.AbstractMeter

getId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micrometer.core.instrument.Timer

builder, getType, mean, measure

Methods inherited from interface io.micrometer.core.instrument.Meter

builder, getId

Method Detail

record

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

Description copied from interface: Timer

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

Specified by:

record in interface Timer

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

public void record(java.time.Duration duration)

Description copied from interface: Timer

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

Specified by:

record in interface Timer

Parameters:

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

record

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

Description copied from interface: Timer

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

Specified by:

record in interface Timer

Parameters:

f - Function to execute and measure the execution time.

Returns:

The return value of `f`.

recordCallable

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

Description copied from interface: Timer

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

Specified by:

recordCallable in interface Timer

Parameters:

f - Function to execute and measure the execution time.

Returns:

The return value of `f`.

Throws:

java.lang.Exception

record

public void record(java.lang.Runnable f)

Description copied from interface: Timer

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

Specified by:

record in interface Timer

Parameters:

f - Function to execute and measure the execution time.

wrap

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

Description copied from interface: Timer

Wrap a Runnable so that it is timed when invoked.

Specified by:

wrap in interface Timer

Parameters:

f - The Runnable to time when it is invoked.

Returns:

The wrapped Runnable.

wrap

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

Description copied from interface: Timer

Wrap a Callable so that it is timed when invoked.

Specified by:

wrap in interface Timer

Parameters:

f - The Callable to time when it is invoked.

Returns:

The wrapped Callable.

count

public long count()

Description copied from interface: Timer

The number of times that record has been called on this timer.

Specified by:

count in interface Timer

totalTime

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

Description copied from interface: Timer

The total time of recorded events.

Specified by:

totalTime in interface Timer

max

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

Description copied from interface: Timer

The maximum time of a single event.

Specified by:

max in interface Timer

percentile

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

Description copied from interface: Timer

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

Specified by:

percentile in interface Timer

histogramCountAtValue

public double histogramCountAtValue(long valueNanos)

Specified by:

histogramCountAtValue in interface Timer

add

public void add(MeterRegistry registry)

Specified by:

add in interface CompositeMeter

remove

public void remove(MeterRegistry registry)

Specified by:

remove in interface CompositeMeter