Package io.micrometer.registry.otlp.internal

Class CumulativeBase2ExponentialHistogram

java.lang.Object

io.micrometer.registry.otlp.internal.Base2ExponentialHistogram

io.micrometer.registry.otlp.internal.CumulativeBase2ExponentialHistogram

All Implemented Interfaces:

io.micrometer.core.instrument.distribution.Histogram, AutoCloseable

public class CumulativeBase2ExponentialHistogram
extends Base2ExponentialHistogram

A Base2ExponentialHistogram that tracks values cumulatively from first recorded value. *

* This is an internal class and might have breaking changes, external * implementations SHOULD NOT rely on this implementation. *

Since:

1.14.0

Constructor Summary

Constructors

Constructor	Description
CumulativeBase2ExponentialHistogram(int maxScale, int maxBucketsCount, double zeroThreshold, TimeUnit baseUnit)	Creates an Base2ExponentialHistogram that record positive values cumulatively.

Method Summary

Modifier and Type	Method	Description
ExponentialHistogramSnapShot	getLatestExponentialHistogramSnapshot()	Returns the latest snapshot of recordings from Base2ExponentialHistogram.takeExponentialHistogramSnapShot() and not the current set of values.

Methods inherited from class io.micrometer.registry.otlp.internal.Base2ExponentialHistogram

recordDouble, recordLong, takeSnapshot

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

CumulativeBase2ExponentialHistogram

public CumulativeBase2ExponentialHistogram(int maxScale,
 int maxBucketsCount,
 double zeroThreshold,
 @Nullable
 TimeUnit baseUnit)

Creates an Base2ExponentialHistogram that record positive values cumulatively.

Parameters:

maxScale - - maximum scale that can be used. The recordings start with this scale and gets downscaled to the scale that supports recording data within maxBucketsCount.

maxBucketsCount - - maximum number of buckets that can be used for distribution.

zeroThreshold - - values less than or equal to this are considered in zero count and recorded in the histogram. If less than 0, this is rounded to zero. In case of recording time, this should be in nanoseconds.

baseUnit - - an Optional TimeUnit. If set to a non-null unit, the recorded values are converted to this unit.

Method Details

getLatestExponentialHistogramSnapshot

public ExponentialHistogramSnapShot getLatestExponentialHistogramSnapshot()

Description copied from class: Base2ExponentialHistogram

Returns the latest snapshot of recordings from Base2ExponentialHistogram.takeExponentialHistogramSnapShot() and not the current set of values. It is recommended to use this method to consume values recorded in this Histogram as this will provide consistency in recorded values.

Specified by:

getLatestExponentialHistogramSnapshot in class Base2ExponentialHistogram