io.micrometer.core.instrument.stats.hist

Class TimeHistogram

java.lang.Object

io.micrometer.core.instrument.stats.hist.TimeHistogram

All Implemented Interfaces:

Histogram<java.lang.Double>

Direct Known Subclasses:

PercentileTimeHistogram

public class TimeHistogram
extends java.lang.Object
implements Histogram<java.lang.Double>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeHistogram.Builder

Nested classes/interfaces inherited from interface io.micrometer.core.instrument.stats.hist.Histogram

Histogram.Summation

Method Summary

Modifier and Type	Method and Description
void	bucketTimeScale(java.util.concurrent.TimeUnit bucketTimeScale) Set the time scale that the buckets should be represented in.
Histogram<java.lang.Double>	filterBuckets(BucketFilter<java.lang.Double> filter)
Bucket<java.lang.Double>	getBucket(java.lang.Double tag)
java.util.Collection<Bucket<java.lang.Double>>	getBuckets()
void	infinityBucket()
boolean	isCumulative()
void	observe(double value)

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.stats.hist.Histogram

exponential, exponentialFunction, exponentialTime, function, linear, linearFunction, linearTime, percentiles, percentilesTime

Method Detail

bucketTimeScale

public void bucketTimeScale(java.util.concurrent.TimeUnit bucketTimeScale)

Set the time scale that the buckets should be represented in. For example, if the bucket function is a linear function from 1-10 ms and the bucketTimeScale is seconds, then the buckets that are reported will be [0.001, ..., 0.01]. Future values observed by this histogram will also be assumed to be in bucketTimeScale units and scaled to the bucket function's base unit.

Parameters:

bucketTimeScale - Should always correspond to the base time unit of the monitoring system for consistency.

getBuckets

public java.util.Collection<Bucket<java.lang.Double>> getBuckets()

Specified by:

getBuckets in interface Histogram<java.lang.Double>

filterBuckets

public Histogram<java.lang.Double> filterBuckets(BucketFilter<java.lang.Double> filter)

Specified by:

filterBuckets in interface Histogram<java.lang.Double>

infinityBucket

public void infinityBucket()

getBucket

public Bucket<java.lang.Double> getBucket(java.lang.Double tag)

Specified by:

getBucket in interface Histogram<java.lang.Double>

observe

public void observe(double value)

Specified by:

observe in interface Histogram<java.lang.Double>

isCumulative

public boolean isCumulative()

Specified by:

isCumulative in interface Histogram<java.lang.Double>