org.attribyte.essem.metrics

Class HDRReservoir

java.lang.Object

org.attribyte.essem.metrics.HDRReservoir

public class HDRReservoir
extends java.lang.Object

A High Dynamic Range (HDR) histogram implementation.

See Also:

HdrHistogram.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HDRReservoir.HDRSnapshot A specialized snapshot that contains both the "total" histogram (since start), and the one collected since getSnapshot was last called.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	REPORT_SNAPSHOT_HISTOGRAM Indicates that the snapshot histogram should be reported.
static boolean	REPORT_TOTAL_HISTOGRAM Indicates that the total histogram should be reported.

Constructor Summary

Constructors

Constructor and Description
HDRReservoir(int numberOfSignificantValueDigits, boolean reportTotalHistogram) Creates a HDR histogram.
HDRReservoir(long highestTrackableValue, int numberOfSignificantValueDigits, boolean reportTotalHistogram) Creates a HDR histogram.

Method Summary

Modifier and Type	Method and Description
Snapshot	getSnapshot()
int	size()
void	update(long value)

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_TOTAL_HISTOGRAM

public static final boolean REPORT_TOTAL_HISTOGRAM

Indicates that the total histogram should be reported.

See Also:

Constant Field Values

REPORT_SNAPSHOT_HISTOGRAM

public static final boolean REPORT_SNAPSHOT_HISTOGRAM

Indicates that the snapshot histogram should be reported.

See Also:

Constant Field Values

Constructor Detail

HDRReservoir

public HDRReservoir(int numberOfSignificantValueDigits,
                    boolean reportTotalHistogram)

Creates a HDR histogram.

Parameters:

numberOfSignificantValueDigits - The number of significant digits in the value.

reportTotalHistogram - If true, the long-running histogram will be reported. Otherwise, the histogram collected since the last snapshot was acquired will be reported.

HDRReservoir

public HDRReservoir(long highestTrackableValue,
                    int numberOfSignificantValueDigits,
                    boolean reportTotalHistogram)

Creates a HDR histogram.

Parameters:

highestTrackableValue - The highest value tracked. Anything larger will be set to the maximum.

numberOfSignificantValueDigits - The number of significant digits in the value.

reportTotalHistogram - If true, the long-running histogram will be reported. Otherwise, the histogram collected since the last snapshot was acquired will be reported.

Method Detail

size

public int size()

update

public void update(long value)

getSnapshot

public Snapshot getSnapshot()