io.micrometer.core.instrument.stats.hist

Class Histogram<T>

java.lang.Object

io.micrometer.core.instrument.stats.hist.Histogram<T>

public class Histogram<T>
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Histogram.Builder<T>
static class	Histogram.Type

Constructor Summary

Constructors

Constructor and Description
Histogram(BucketFunction<? extends T> f, Histogram.Type type, java.util.List<BucketListener<T>> listeners, boolean percentiles)

Method Summary

Modifier and Type	Method and Description
static Histogram.Builder<java.lang.Double>	exponential(double start, double exp, int count)
static Histogram.Builder<java.lang.Double>	exponentialTime(java.util.concurrent.TimeUnit unit, double start, double exp, int count)
static <U> Histogram.Builder<U>	function(BucketFunction<U> f)
java.util.Collection<Bucket<T>>	getBuckets()
Histogram.Type	getType()
boolean	isCumulative()
boolean	isPercentiles()
static Histogram.Builder<java.lang.Double>	linear(double start, double width, int count)
static Histogram.Builder<java.lang.Double>	linearTime(java.util.concurrent.TimeUnit unit, double start, double width, int count)
void	observe(double value)
static Histogram.Builder<java.lang.Double>	percentiles()
static Histogram.Builder<java.lang.Double>	percentilesTime()

Methods inherited from class java.lang.Object

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

Constructor Detail

Histogram

public Histogram(BucketFunction<? extends T> f,
                 Histogram.Type type,
                 java.util.List<BucketListener<T>> listeners,
                 boolean percentiles)

Method Detail

getBuckets

public java.util.Collection<Bucket<T>> getBuckets()

isCumulative

public boolean isCumulative()

isPercentiles

public boolean isPercentiles()

getType

public Histogram.Type getType()

function

public static <U> Histogram.Builder<U> function(BucketFunction<U> f)

linear

public static Histogram.Builder<java.lang.Double> linear(double start,
                                                         double width,
                                                         int count)

Parameters:

start - Leftmost bucket

width - The interval between nonZeroBuckets

count - The total number of nonZeroBuckets, yielding count-1 intervals between them

Returns:

Fixed-width nonZeroBuckets

linearTime

public static Histogram.Builder<java.lang.Double> linearTime(java.util.concurrent.TimeUnit unit,
                                                             double start,
                                                             double width,
                                                             int count)

Parameters:

unit - The time unit of start.

start - Leftmost bucket

width - The interval between nonZeroBuckets

count - The total number of nonZeroBuckets, yielding count-1 intervals between them

Returns:

Fixed-width nonZeroBuckets time scaled

exponential

public static Histogram.Builder<java.lang.Double> exponential(double start,
                                                              double exp,
                                                              int count)

Parameters:

start - Leftmost bucket is start*factor

exp - The exponent

count - The total number of nonZeroBuckets, yielding count-1 intervals between them

Returns:

Exponential-width nonZeroBuckets

exponentialTime

public static Histogram.Builder<java.lang.Double> exponentialTime(java.util.concurrent.TimeUnit unit,
                                                                  double start,
                                                                  double exp,
                                                                  int count)

Parameters:

unit - The time unit of start.

start - Leftmost bucket is start*factor

exp - The exponent

count - The total number of nonZeroBuckets, yielding count-1 intervals between them

Returns:

Exponential-width nonZeroBuckets

percentiles

public static Histogram.Builder<java.lang.Double> percentiles()

percentilesTime

public static Histogram.Builder<java.lang.Double> percentilesTime()

observe

public void observe(double value)