io.micrometer.core.instrument

Class AbstractDistributionSummary

java.lang.Object

io.micrometer.core.instrument.AbstractMeter

io.micrometer.core.instrument.AbstractDistributionSummary

All Implemented Interfaces:

DistributionSummary, Meter, java.lang.AutoCloseable

Direct Known Subclasses:

CumulativeDistributionSummary, DropwizardDistributionSummary, StepDistributionSummary

public abstract class AbstractDistributionSummary
extends AbstractMeter
implements 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.Id, Meter.Type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDistributionSummary(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, double scale)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	hashCode()
double	histogramCountAtValue(long value) Provides cumulative histogram counts.
double	percentile(double percentile)
void	record(double amount) Updates the statistics kept by the summary with the specified amount.
protected abstract void	recordNonNegative(double amount)
DistributionStatisticConfig	statsConfig()
HistogramSnapshot	takeSnapshot(boolean supportsAggregablePercentiles) Summary statistics should be published off of a single snapshot instance so that, for example, there isn't disagreement between the distribution's count and total because more events continue to stream in.

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, count, max, mean, measure, totalAmount

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

builder, close, getId

Constructor Detail

AbstractDistributionSummary

protected AbstractDistributionSummary(Meter.Id id,
                                      Clock clock,
                                      DistributionStatisticConfig distributionStatisticConfig,
                                      double scale)

Method Detail

record

public final void record(double amount)

Description copied from interface: DistributionSummary

Updates the statistics kept by the summary with the specified amount.

Specified by:

record in interface DistributionSummary

Parameters:

amount - Amount for an event being measured. For example, if the size in bytes of responses from a server. If the amount is less than 0 the value will be dropped.

recordNonNegative

protected abstract void recordNonNegative(double amount)

percentile

public double percentile(double percentile)

Specified by:

percentile in interface DistributionSummary

Parameters:

percentile - A percentile in the domain [0, 1]. For example, 0.5 represents the 50th percentile of the distribution.

Returns:

The value at a specific percentile. This value is non-aggregable across dimensions.

histogramCountAtValue

public double histogramCountAtValue(long value)

Description copied from interface: DistributionSummary

Provides cumulative histogram counts.

Specified by:

histogramCountAtValue in interface DistributionSummary

Parameters:

value - The histogram bucket to retrieve a count for.

Returns:

The count of all events less than or equal to the bucket.

takeSnapshot

public HistogramSnapshot takeSnapshot(boolean supportsAggregablePercentiles)

Description copied from interface: DistributionSummary

Summary statistics should be published off of a single snapshot instance so that, for example, there isn't disagreement between the distribution's count and total because more events continue to stream in.

Specified by:

takeSnapshot in interface DistributionSummary

Parameters:

supportsAggregablePercentiles - Whether percentile histogram buckets should be included in the list of CountAtBucket.

Returns:

A snapshot of all distribution statistics at a point in time.

equals

public boolean equals(@Nullable
                      java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

statsConfig

public DistributionStatisticConfig statsConfig()