io.micrometer.core.instrument

Class AbstractTimer

java.lang.Object

io.micrometer.core.instrument.AbstractMeter

io.micrometer.core.instrument.AbstractTimer

All Implemented Interfaces:

Meter, Timer, java.lang.AutoCloseable

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, Timer.Sample

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, DistributionStatisticConfig distributionStatisticConfig, PauseDetector pauseDetector, java.util.concurrent.TimeUnit baseTimeUnit)

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.TimeUnit	baseTimeUnit()
void	close()
boolean	equals(java.lang.Object o)
int	hashCode()
double	histogramCountAtValue(long valueNanos) Provides cumulative histogram counts.
double	percentile(double percentile, java.util.concurrent.TimeUnit unit)
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)
DistributionStatisticConfig	statsConfig()
HistogramSnapshot	takeSnapshot(boolean supportsAggregablePercentiles) Summary statistics should be published off of a single snapshot instance so that, for example, there isn't disagreement between the distribution's count and total because more events continue to stream in.

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, builder, count, max, mean, measure, record, start, start, totalTime, 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,
                        DistributionStatisticConfig distributionStatisticConfig,
                        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

Type Parameters:

T - The return type of the Callable.

Parameters:

f - Function to execute and measure the execution time.

Returns:

The return value of `f`.

Throws:

java.lang.Exception - Any exception bubbling up from the callable.

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

Type Parameters:

T - The return type of the Supplier.

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)

Specified by:

percentile in interface Timer

Parameters:

percentile - A percentile in the domain [0, 1]. For example, 0.5 represents the 50th percentile of the distribution.

unit - The base unit of time to scale the percentile value to.

Returns:

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

histogramCountAtValue

public double histogramCountAtValue(long valueNanos)

Description copied from interface: Timer

Provides cumulative histogram counts.

Specified by:

histogramCountAtValue in interface Timer

Parameters:

valueNanos - The histogram bucket to retrieve a count for.

Returns:

The count of all events less than or equal to the bucket.

takeSnapshot

public HistogramSnapshot takeSnapshot(boolean supportsAggregablePercentiles)

Description copied from interface: Timer

Summary statistics should be published off of a single snapshot instance so that, for example, there isn't disagreement between the distribution's count and total because more events continue to stream in.

Specified by:

takeSnapshot in interface Timer

Parameters:

supportsAggregablePercentiles - Whether percentile histogram buckets should be included in the list of CountAtBucket.

Returns:

A snapshot of all distribution statistics at a point in time.

baseTimeUnit

public java.util.concurrent.TimeUnit baseTimeUnit()

Specified by:

baseTimeUnit in interface Timer

Returns:

The base time unit of the timer to which all published metrics will be scaled

equals

public boolean equals(@Nullable
                      java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

statsConfig

public DistributionStatisticConfig statsConfig()

close

public void close()

Specified by:

close in interface Meter

Specified by:

close in interface java.lang.AutoCloseable