Package io.micrometer.core.instrument.distribution

Class TimeWindowFixedBoundaryHistogram

java.lang.Object

io.micrometer.core.instrument.distribution.TimeWindowFixedBoundaryHistogram

All Implemented Interfaces:

Histogram, AutoCloseable

public class TimeWindowFixedBoundaryHistogram
extends Object

A histogram implementation that does not support precomputed percentiles but supports aggregable percentile histograms and SLO boundaries. There is no need for a high dynamic range histogram and its more expensive memory footprint if all we are interested in is fixed histogram counts.

Since:

1.0.3

Constructor Summary

Constructors

Modifier	Constructor	Description
	TimeWindowFixedBoundaryHistogram(Clock clock, DistributionStatisticConfig config, boolean supportsAggregablePercentiles)	Create a TimeWindowFixedBoundaryHistogram instance with cumulative bucket counts and buckets based on the config and supportsAggregablePercentiles.
	TimeWindowFixedBoundaryHistogram(Clock clock, DistributionStatisticConfig config, boolean supportsAggregablePercentiles, boolean isCumulativeBucketCounts)	Create a TimeWindowFixedBoundaryHistogram instance with buckets based on the config and supportsAggregablePercentiles.
protected	TimeWindowFixedBoundaryHistogram(Clock clock, DistributionStatisticConfig config, boolean supportsAggregablePercentiles, boolean isCumulativeBucketCounts, boolean includeInfinityBucket)	Create a TimeWindowFixedBoundaryHistogram instance with buckets based on the config and supportsAggregablePercentiles.

Method Summary

Modifier and Type	Method	Description
protected Void	accumulatedHistogram()
protected io.micrometer.core.instrument.distribution.FixedBoundaryHistogram	currentHistogram()
protected double[]	getBuckets()	Return buckets.
void	recordDouble(double value)
void	recordLong(long value)
final HistogramSnapshot	takeSnapshot(long count, double total, double max)

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.distribution.Histogram

close

Constructor Details

TimeWindowFixedBoundaryHistogram

public TimeWindowFixedBoundaryHistogram(Clock clock,
 DistributionStatisticConfig config,
 boolean supportsAggregablePercentiles)

Create a TimeWindowFixedBoundaryHistogram instance with cumulative bucket counts and buckets based on the config and supportsAggregablePercentiles.

Parameters:

clock - clock

config - distribution statistic configuration

supportsAggregablePercentiles - whether the backend supports aggregable percentiles

See Also:

• PercentileHistogramBuckets

TimeWindowFixedBoundaryHistogram

public TimeWindowFixedBoundaryHistogram(Clock clock,
 DistributionStatisticConfig config,
 boolean supportsAggregablePercentiles,
 boolean isCumulativeBucketCounts)

Create a TimeWindowFixedBoundaryHistogram instance with buckets based on the config and supportsAggregablePercentiles.

Parameters:

clock - clock

config - distribution statistic configuration

supportsAggregablePercentiles - whether the backend supports aggregable percentiles

isCumulativeBucketCounts - whether to use cumulative bucket counts

Since:

1.9.0

See Also:

• PercentileHistogramBuckets

TimeWindowFixedBoundaryHistogram

protected TimeWindowFixedBoundaryHistogram(Clock clock,
 DistributionStatisticConfig config,
 boolean supportsAggregablePercentiles,
 boolean isCumulativeBucketCounts,
 boolean includeInfinityBucket)

Create a TimeWindowFixedBoundaryHistogram instance with buckets based on the config and supportsAggregablePercentiles. This constructor allows for use cases that always need an infinity bucket in the histogram.

Parameters:

clock - clock

config - distribution statistic configuration

supportsAggregablePercentiles - whether the backend supports aggregable percentiles

isCumulativeBucketCounts - whether to use cumulative bucket counts

includeInfinityBucket - whether to always include an infinity bucket

Since:

1.13.11

See Also:

• PercentileHistogramBuckets

Method Details

getBuckets

protected double[] getBuckets()

Return buckets.

Returns:

buckets

Since:

1.9.0

takeSnapshot

public final HistogramSnapshot takeSnapshot(long count,
 double total,
 double max)

Specified by:

takeSnapshot in interface Histogram

recordLong

public void recordLong(long value)

Specified by:

recordLong in interface Histogram

recordDouble

public void recordDouble(double value)

Specified by:

recordDouble in interface Histogram

accumulatedHistogram

protected Void accumulatedHistogram()

currentHistogram

protected io.micrometer.core.instrument.distribution.FixedBoundaryHistogram currentHistogram()