io.micrometer.core.instrument.stats.hist

Class TimeHistogram.Builder

java.lang.Object

io.micrometer.core.instrument.stats.hist.Histogram.Builder<java.lang.Double>

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

Direct Known Subclasses:

PercentileTimeHistogram.Builder

Enclosing class:

TimeHistogram

public static class TimeHistogram.Builder
extends Histogram.Builder<java.lang.Double>

Method Summary

Modifier and Type	Method and Description
TimeHistogram.Builder	bucketTimeScale(java.util.concurrent.TimeUnit bucketTimeScale) Set the time scale that the buckets should be represented in.
TimeHistogram	create(Histogram.Summation defaultSummationMode)
TimeHistogram.Builder	filterBuckets(BucketFilter<java.lang.Double> filter)
TimeHistogram.Builder	summation(Histogram.Summation summation)

Methods inherited from class java.lang.Object

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

Method Detail

summation

public TimeHistogram.Builder summation(Histogram.Summation summation)

Overrides:

summation in class Histogram.Builder<java.lang.Double>

filterBuckets

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

Overrides:

filterBuckets in class Histogram.Builder<java.lang.Double>

bucketTimeScale

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

create

public TimeHistogram create(Histogram.Summation defaultSummationMode)

Specified by:

create in class Histogram.Builder<java.lang.Double>