Package io.micrometer.core.instrument

Class AbstractDistributionSummary

java.lang.Object

io.micrometer.core.instrument.AbstractMeter

io.micrometer.core.instrument.AbstractDistributionSummary

All Implemented Interfaces:

HistogramSupport, DistributionSummary, Meter

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.Builder, Meter.Id, Meter.MeterProvider<T extends Meter>, Meter.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected final Histogram	histogram

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDistributionSummary(Meter.Id id, double scale, Histogram histogram)	Creates an AbstractDistributionSummary instance.
protected	AbstractDistributionSummary(Meter.Id id, Clock clock, DistributionStatisticConfig distributionStatisticConfig, double scale, boolean supportsAggregablePercentiles)

Method Summary

Modifier and Type	Method	Description
protected static Histogram	defaultHistogram(Clock clock, DistributionStatisticConfig distributionStatisticConfig, boolean supportsAggregablePercentiles)	Creates a default histogram.
final void	record(double amount)	Updates the statistics kept by the summary with the specified amount.
protected abstract void	recordNonNegative(double amount)
HistogramSnapshot	takeSnapshot()	Summary statistics should be published off of a single snapshot instance so that, for example, there isn't disagreement between the distribution's bucket counts because more events continue to stream in.

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

count, histogramCountAtValue, max, mean, measure, percentile, totalAmount

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

takeSnapshot

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

close, getId, match, use

Field Details

histogram

protected final Histogram histogram

Constructor Details

AbstractDistributionSummary

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

AbstractDistributionSummary

protected AbstractDistributionSummary(Meter.Id id,
 double scale,
 @Nullable
 Histogram histogram)

Creates an AbstractDistributionSummary instance.

Parameters:

id - meter ID

scale - scale

histogram - histogram

Since:

1.11.0

Method Details

defaultHistogram

protected static Histogram defaultHistogram(Clock clock,
 DistributionStatisticConfig distributionStatisticConfig,
 boolean supportsAggregablePercentiles)

Creates a default histogram.

Parameters:

clock - clock

distributionStatisticConfig - distribution statistic configuration

supportsAggregablePercentiles - whether to support aggregable percentiles

Returns:

a default histogram

Since:

1.11.0

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)

takeSnapshot

public HistogramSnapshot takeSnapshot()

Description copied from interface: HistogramSupport

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

Specified by:

takeSnapshot in interface HistogramSupport

Returns:

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