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

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.Id, Meter.Type

Field Summary

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

histogram

Constructor Summary

Constructors

Constructor and Description
StepDistributionSummary(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, double scale) Deprecated. Use StepDistributionSummary(io.micrometer.core.instrument.Meter.Id, Clock, DistributionStatisticConfig, double, long, boolean)
StepDistributionSummary(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, double scale, boolean supportsAggregablePercentiles) Deprecated. Use StepDistributionSummary(io.micrometer.core.instrument.Meter.Id, Clock, DistributionStatisticConfig, double, long, boolean)
StepDistributionSummary(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, double scale, long stepMillis, boolean supportsAggregablePercentiles) Create a new StepDistributionSummary.

Method Summary

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

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

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

builder, histogramCountAtValue, mean, percentile

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

takeSnapshot

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

builder, close, getId, match, use

Constructor Detail

StepDistributionSummary

@Deprecated
public StepDistributionSummary(Meter.Id id,
                                           Clock clock,
                                           DistributionStatisticConfig distributionStatisticConfig,
                                           double scale)

Deprecated. Use StepDistributionSummary(io.micrometer.core.instrument.Meter.Id, Clock, DistributionStatisticConfig, double, long, boolean)

Create a new StepDistributionSummary.

Parameters:

id - ID

clock - clock

distributionStatisticConfig - distribution static configuration

scale - scale

StepDistributionSummary

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

Deprecated. Use StepDistributionSummary(io.micrometer.core.instrument.Meter.Id, Clock, DistributionStatisticConfig, double, long, boolean)

Create a new StepDistributionSummary.

Parameters:

id - ID

clock - clock

distributionStatisticConfig - distribution static configuration

scale - scale

supportsAggregablePercentiles - whether it supports aggregable percentiles

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 static configuration

scale - scale

stepMillis - step in milliseconds

supportsAggregablePercentiles - whether it supports aggregable percentiles

Method Detail

recordNonNegative

protected void recordNonNegative(double amount)

Specified by:

recordNonNegative in class AbstractDistributionSummary

count

public long count()

Returns:

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

totalAmount

public double totalAmount()

Returns:

The total amount of all recorded events.

max

public double max()

Returns:

The maximum time of a single event.

measure

public java.lang.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.

Returns:

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