io.micrometer.core.instrument

Class AbstractTimer

java.lang.Object

io.micrometer.core.instrument.AbstractMeter

io.micrometer.core.instrument.AbstractTimer

All Implemented Interfaces:

Meter, Timer

Direct Known Subclasses:

CumulativeTimer, DropwizardTimer, StepTimer

public abstract class AbstractTimer
extends AbstractMeter
implements Timer

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Clock	clock
protected TimeWindowLatencyHistogram	histogram

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTimer(Meter.Id id, Clock clock, HistogramConfig histogramConfig, PauseDetector pauseDetector, java.util.concurrent.TimeUnit baseTimeUnit)

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.TimeUnit	baseTimeUnit()
boolean	equals(java.lang.Object o)
int	hashCode()
double	histogramCountAtValue(long valueNanos)
double	percentile(double percentile, java.util.concurrent.TimeUnit unit) The latency at a specific percentile.
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.
protected abstract void	recordNonNegative(long amount, java.util.concurrent.TimeUnit unit)
HistogramConfig	statsConfig()
HistogramSnapshot	takeSnapshot(boolean supportsAggregablePercentiles)

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

getId

Methods inherited from class java.lang.Object

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

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

builder, count, max, mean, measure, record, totalTime, type, wrap, wrap

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

builder, getId

Field Detail

clock

protected final Clock clock

histogram

protected final TimeWindowLatencyHistogram histogram

Constructor Detail

AbstractTimer

protected AbstractTimer(Meter.Id id,
                        Clock clock,
                        HistogramConfig histogramConfig,
                        PauseDetector pauseDetector,
                        java.util.concurrent.TimeUnit baseTimeUnit)

Method Detail

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 <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`.

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.

record

public final 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.

recordNonNegative

protected abstract void recordNonNegative(long amount,
                                          java.util.concurrent.TimeUnit unit)

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

takeSnapshot

public HistogramSnapshot takeSnapshot(boolean supportsAggregablePercentiles)

Specified by:

takeSnapshot in interface Timer

baseTimeUnit

public java.util.concurrent.TimeUnit baseTimeUnit()

Specified by:

baseTimeUnit in interface Timer

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

statsConfig

public HistogramConfig statsConfig()