io.micrometer.core.instrument.noop

Class NoopDistributionSummary

java.lang.Object

io.micrometer.core.instrument.AbstractMeter

io.micrometer.core.instrument.noop.NoopMeter

io.micrometer.core.instrument.noop.NoopDistributionSummary

All Implemented Interfaces:

DistributionSummary, Meter, java.lang.AutoCloseable

public class NoopDistributionSummary
extends NoopMeter
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

Constructor and Description
NoopDistributionSummary(Meter.Id id)

Method Summary

Modifier and Type	Method and Description
long	count()
double	histogramCountAtValue(long value) Provides cumulative histogram counts.
double	max()
double	percentile(double percentile)
void	record(double amount) Updates the statistics kept by the summary with the specified amount.
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.
double	totalAmount()

Methods inherited from class io.micrometer.core.instrument.noop.NoopMeter

measure

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

getId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

builder, mean, measure

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

builder, close, getId

Constructor Detail

NoopDistributionSummary

public NoopDistributionSummary(Meter.Id id)

Method Detail

record

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

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.

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.