Package io.micrometer.core.instrument.step

Class StepDistributionSummary

java.lang.Object

io.micrometer.core.instrument.AbstractMeter

io.micrometer.core.instrument.AbstractDistributionSummary

io.micrometer.core.instrument.step.StepDistributionSummary

All Implemented Interfaces:

HistogramSupport, DistributionSummary, Meter

public class StepDistributionSummary
extends AbstractDistributionSummary

Step-normalized DistributionSummary.

Nested Class Summary

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

DistributionSummary.Builder

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

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

Field Summary

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

histogram

Constructor Summary

Constructors

Modifier	Constructor	Description
	StepDistributionSummary(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, double scale, long stepMillis, boolean supportsAggregablePercentiles)	Create a new StepDistributionSummary.
protected	StepDistributionSummary(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, double scale, long stepMillis, Histogram histogram)	Create a new StepDistributionSummary.

Method Summary

Modifier and Type	Method	Description
void	_closingRollover()
long	count()
double	max()
Iterable<Measurement>	measure()	Get a set of measurements.
protected void	recordNonNegative(double amount)
double	totalAmount()

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

defaultHistogram, record, 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.DistributionSummary

histogramCountAtValue, mean, percentile

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

takeSnapshot

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

close, getId, match, use

Constructor Details

StepDistributionSummary

public StepDistributionSummary(Meter.Id id,
 Clock clock,
 DistributionStatisticConfig distributionStatisticConfig,
 double scale,
 long stepMillis,
 boolean supportsAggregablePercentiles)

Create a new StepDistributionSummary.

Parameters:

id - ID

clock - clock

distributionStatisticConfig - distribution statistic configuration

scale - scale

stepMillis - step in milliseconds

supportsAggregablePercentiles - whether it supports aggregable percentiles

StepDistributionSummary

protected StepDistributionSummary(Meter.Id id,
 Clock clock,
 DistributionStatisticConfig distributionStatisticConfig,
 double scale,
 long stepMillis,
 Histogram histogram)

Create a new StepDistributionSummary.

Parameters:

id - ID

clock - clock

distributionStatisticConfig - distribution static configuration

scale - scale

stepMillis - step in milliseconds

histogram - histogram

Since:

1.11.1

Method Details

recordNonNegative

protected void recordNonNegative(double amount)

Specified by:

recordNonNegative in class AbstractDistributionSummary

count

public long count()

Specified by:

count in interface DistributionSummary

Returns:

The number of times that record has been called since this timer was created.

totalAmount

public double totalAmount()

Specified by:

totalAmount in interface DistributionSummary

Returns:

The total amount of all recorded events.

max

public double max()

Specified by:

max in interface DistributionSummary

Returns:

The maximum time of a single event.

measure

public Iterable<Measurement> measure()

Description copied from interface: Meter

Get a set of measurements. Should always return the same number of measurements and in the same order, regardless of the level of activity or the lack thereof.

Specified by:

measure in interface DistributionSummary

Specified by:

measure in interface Meter

Returns:

The set of measurements that represents the instantaneous value of this meter.

_closingRollover

public void _closingRollover()