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

Timer.Builder, Timer.Sample

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

Meter.Id, Meter.Type

Field Summary

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

clock, histogram

Constructor Summary

Constructors

Constructor and Description
StepTimer(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, PauseDetector pauseDetector, java.util.concurrent.TimeUnit baseTimeUnit) Deprecated. Use StepTimer(io.micrometer.core.instrument.Meter.Id, Clock, DistributionStatisticConfig, PauseDetector, TimeUnit, long, boolean)
StepTimer(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, PauseDetector pauseDetector, java.util.concurrent.TimeUnit baseTimeUnit, boolean supportsAggregablePercentiles) Deprecated. Use StepTimer(io.micrometer.core.instrument.Meter.Id, Clock, DistributionStatisticConfig, PauseDetector, TimeUnit, long, boolean)
StepTimer(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, PauseDetector pauseDetector, java.util.concurrent.TimeUnit baseTimeUnit, long stepMillis, boolean supportsAggregablePercentiles) Create a new StepTimer.

Method Summary

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

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

baseTimeUnit, close, equals, hashCode, record, record, record, recordCallable, takeSnapshot

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, histogramCountAtValue, mean, measure, percentile, record, start, start, start, wrap, wrap

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

takeSnapshot

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

builder, getId, match, use

Constructor Detail

StepTimer

@Deprecated
public StepTimer(Meter.Id id,
                             Clock clock,
                             DistributionStatisticConfig distributionStatisticConfig,
                             PauseDetector pauseDetector,
                             java.util.concurrent.TimeUnit baseTimeUnit)

Deprecated. Use StepTimer(io.micrometer.core.instrument.Meter.Id, Clock, DistributionStatisticConfig, PauseDetector, TimeUnit, long, boolean)

Create a new StepTimer.

Parameters:

id - ID

clock - clock

distributionStatisticConfig - distribution statistic configuration

pauseDetector - pause detector

baseTimeUnit - base time unit

StepTimer

@Deprecated
public StepTimer(Meter.Id id,
                             Clock clock,
                             DistributionStatisticConfig distributionStatisticConfig,
                             PauseDetector pauseDetector,
                             java.util.concurrent.TimeUnit baseTimeUnit,
                             boolean supportsAggregablePercentiles)

Deprecated. Use StepTimer(io.micrometer.core.instrument.Meter.Id, Clock, DistributionStatisticConfig, PauseDetector, TimeUnit, long, boolean)

Create a new StepTimer.

Parameters:

id - ID

clock - clock

distributionStatisticConfig - distribution statistic configuration

pauseDetector - pause detector

baseTimeUnit - base time unit

supportsAggregablePercentiles - whether it supports aggregable percentiles

StepTimer

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

Create a new StepTimer.

Parameters:

id - ID

clock - clock

distributionStatisticConfig - distribution statistic configuration

pauseDetector - pause detector

baseTimeUnit - base time unit

stepMillis - step in milliseconds

supportsAggregablePercentiles - whether it supports aggregable percentiles

Method Detail

recordNonNegative

protected void recordNonNegative(long amount,
                                 java.util.concurrent.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(java.util.concurrent.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(java.util.concurrent.TimeUnit unit)

Parameters:

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

Returns:

The maximum time of a single event.