io.micrometer.core.instrument.stats.hist

Interface Histogram<T>

All Known Implementing Classes:

DefaultHistogram, DoubleHistogram, PercentileHistogram, PercentileTimeHistogram, TimeHistogram

public interface Histogram<T>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Histogram.Builder<T>
static class	Histogram.Summation

Method Summary

Modifier and Type	Method and Description
static DefaultHistogram.Builder<java.lang.Double>	exponential(double start, double exp, int count)
static BucketFunction<java.lang.Double>	exponentialFunction(double start, double exp, int count)
static TimeHistogram.Builder	exponentialTime(java.util.concurrent.TimeUnit unit, double start, double exp, int count)
Histogram<T>	filterBuckets(BucketFilter<T> filter)
static <U> DefaultHistogram.Builder<U>	function(BucketFunction<U> f)
Bucket<T>	getBucket(T tag)
java.util.Collection<Bucket<T>>	getBuckets()
boolean	isCumulative()
static DefaultHistogram.Builder<java.lang.Double>	linear(double start, double width, int count)
static BucketFunction<java.lang.Double>	linearFunction(double start, double width, int count)
static TimeHistogram.Builder	linearTime(java.util.concurrent.TimeUnit unit, double start, double width, int count)
void	observe(double value)
static PercentileHistogram.Builder	percentiles()
static PercentileTimeHistogram.Builder	percentilesTime()

Method Detail

getBuckets

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

filterBuckets

Histogram<T> filterBuckets(BucketFilter<T> filter)

getBucket

Bucket<T> getBucket(T tag)

observe

void observe(double value)

isCumulative

boolean isCumulative()

function

static <U> DefaultHistogram.Builder<U> function(BucketFunction<U> f)

linear

static DefaultHistogram.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

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

static DefaultHistogram.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

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

static PercentileHistogram.Builder percentiles()

percentilesTime

static PercentileTimeHistogram.Builder percentilesTime()

linearFunction

static BucketFunction<java.lang.Double> linearFunction(double start,
                                                       double width,
                                                       int count)

exponentialFunction

static BucketFunction<java.lang.Double> exponentialFunction(double start,
                                                            double exp,
                                                            int count)