Package io.micrometer.core.instrument.step

Class StepTimer

java.lang.Object

io.micrometer.core.instrument.AbstractMeter

io.micrometer.core.instrument.AbstractTimer

io.micrometer.core.instrument.step.StepTimer

All Implemented Interfaces:

HistogramSupport, Meter, Timer

public class StepTimer
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
	StepTimer(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, PauseDetector pauseDetector, TimeUnit baseTimeUnit, long stepDurationMillis, boolean supportsAggregablePercentiles)	Create a new StepTimer.
protected	StepTimer(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, PauseDetector pauseDetector, TimeUnit baseTimeUnit, long stepDurationMillis, Histogram histogram)	Create a new StepTimer.

Method Summary

Modifier and Type	Method	Description
void	_closingRollover()
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

StepTimer

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

Create a new StepTimer.

Parameters:

id - ID

clock - clock

distributionStatisticConfig - distribution statistic configuration

pauseDetector - pause detector

baseTimeUnit - base time unit

stepDurationMillis - step in milliseconds

supportsAggregablePercentiles - whether it supports aggregable percentiles

StepTimer

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

Create a new StepTimer.

Parameters:

id - ID

clock - clock

distributionStatisticConfig - distribution statistic configuration

pauseDetector - pause detector

baseTimeUnit - base time unit

stepDurationMillis - step in milliseconds

histogram - histogram

Since:

1.11.1

Method Details

recordNonNegative

protected void recordNonNegative(long amount,
 TimeUnit unit)

Specified by:

recordNonNegative in class AbstractTimer

count

public long count()

Specified by:

count in interface Timer

Returns:

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

totalTime

public double totalTime(TimeUnit unit)

Specified by:

totalTime in interface Timer

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)

Specified by:

max in interface Timer

Parameters:

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

Returns:

The maximum time of a single event.

_closingRollover

public void _closingRollover()