Package io.micrometer.core.instrument.cumulative

Class CumulativeTimer

java.lang.Object

io.micrometer.core.instrument.AbstractMeter

io.micrometer.core.instrument.AbstractTimer

io.micrometer.core.instrument.cumulative.CumulativeTimer

All Implemented Interfaces:

HistogramSupport, Meter, Timer

public class CumulativeTimer
extends AbstractTimer

Nested Class Summary

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

Meter.Builder, Meter.Id, Meter.MeterProvider<T extends Meter>, Meter.Type

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

Timer.Builder, Timer.ResourceSample, Timer.Sample

Field Summary

Fields inherited from class io.micrometer.core.instrument.AbstractTimer

clock, histogram

Constructor Summary

Constructors

Modifier	Constructor	Description
	CumulativeTimer(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, PauseDetector pauseDetector, TimeUnit baseTimeUnit)
	CumulativeTimer(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, PauseDetector pauseDetector, TimeUnit baseTimeUnit, boolean supportsAggregablePercentiles)
protected	CumulativeTimer(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, PauseDetector pauseDetector, TimeUnit baseTimeUnit, Histogram histogram)	Creates a CumulativeTimer instance.

Method Summary

Modifier and Type	Method	Description
long	count()
double	max(TimeUnit unit)
protected void	recordNonNegative(long amount, TimeUnit unit)
double	totalTime(TimeUnit unit)

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

baseTimeUnit, close, defaultHistogram, record, record, record, record, record, record, record, recordCallable, takeSnapshot

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

equals, getId, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micrometer.core.instrument.distribution.HistogramSupport

takeSnapshot

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

getId, match, use

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

histogramCountAtValue, mean, measure, percentile, record, wrap, wrap, wrap

Constructor Details

CumulativeTimer

public CumulativeTimer(Meter.Id id,
 Clock clock,
 DistributionStatisticConfig distributionStatisticConfig,
 PauseDetector pauseDetector,
 TimeUnit baseTimeUnit)

CumulativeTimer

public CumulativeTimer(Meter.Id id,
 Clock clock,
 DistributionStatisticConfig distributionStatisticConfig,
 PauseDetector pauseDetector,
 TimeUnit baseTimeUnit,
 boolean supportsAggregablePercentiles)

CumulativeTimer

protected CumulativeTimer(Meter.Id id,
 Clock clock,
 DistributionStatisticConfig distributionStatisticConfig,
 PauseDetector pauseDetector,
 TimeUnit baseTimeUnit,
 Histogram histogram)

Creates a CumulativeTimer instance.

Parameters:

id - meter ID

clock - clock

distributionStatisticConfig - distribution statistic configuration

pauseDetector - pause detector

baseTimeUnit - base time unit

histogram - histogram

Since:

1.11.0

Method Details

recordNonNegative

protected void recordNonNegative(long amount,
 TimeUnit unit)

Specified by:

recordNonNegative in class AbstractTimer

count

public long count()

Returns:

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

totalTime

public double totalTime(TimeUnit unit)

Parameters:

unit - The base unit of time to scale the total to.

Returns:

The total time of recorded events.

max

public double max(TimeUnit unit)

Parameters:

unit - The base unit of time to scale the max to.

Returns:

The maximum time of a single event.