Class MetricsCollector.Histogram

java.lang.Object

com.soklet.MetricsCollector.Histogram

Enclosing interface:

MetricsCollector

@ThreadSafe
public static final class MetricsCollector.Histogram
extends Object

A thread-safe histogram with fixed bucket boundaries.

Negative values are ignored. Buckets use inclusive upper bounds, and snapshots include an overflow bucket represented by a MetricsCollector.HistogramSnapshot.getBucketBoundary(int) of Long.MAX_VALUE.

Author:

Mark Allen

Constructor Summary

Constructors

Constructor	Description
Histogram(@NonNull long[] bucketBoundaries)	Creates a histogram with the provided bucket boundaries.

Method Summary

Modifier and Type	Method	Description
void	record(long value)	Records a value into the histogram.
void	reset()	Resets all counts and min/max values.
@NonNull MetricsCollector.HistogramSnapshot	snapshot()	Captures an immutable snapshot of the histogram.

Methods inherited from class Object

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

Constructor Details

Histogram

public Histogram(@NonNull long[] bucketBoundaries)

Creates a histogram with the provided bucket boundaries.

Parameters:

bucketBoundaries - inclusive upper bounds for buckets

Method Details

record

public void record(long value)

Records a value into the histogram.

Parameters:

value - the value to record

snapshot

public @NonNull MetricsCollector.HistogramSnapshot snapshot()

Captures an immutable snapshot of the histogram.

Returns:

the histogram snapshot

reset

public void reset()

Resets all counts and min/max values.