net.openhft.chronicle.core.util

Class RecordingHistogram

java.lang.Object

net.openhft.chronicle.core.util.Histogram

net.openhft.chronicle.core.util.RecordingHistogram

All Implemented Interfaces:

NanoSampler

public class RecordingHistogram
extends Histogram

An extension of the Histogram class which not only samples and records data, but also keeps track of the top 5 or 10 longest samples including the delay from the last reset.

Example output:

 { 50/90 99/99.9 99.99 - worst  was: 500 / 900  1000 / 1000  1000 - 1000, top: [{ off: 10.0, dur: 1000.0 }, { off: 11.0, dur: 950.0 }, { off: 9.0, dur: 900.0 }, { off: 12.0, dur: 850.0 }, { off: 8.0, dur: 800.0 }] }
 

Constructor Summary

Constructors

Constructor and Description
RecordingHistogram() Constructs a new RecordingHistogram with specified parameters.

Method Summary

Modifier and Type	Method and Description
protected long	currentTimeNanos() Retrieves the current time in nanoseconds.
void	reset() Resets the state of this RecordingHistogram.
void	sampleNanos(long durationNs) Records a sample duration in nanoseconds and keeps track of the top durations.
@NotNull String	toLongMicrosFormat(@NotNull DoubleFunction<Double> toMicros) Formats the histogram to a long string with duration in microseconds.
@NotNull String	toMicrosFormat(@NotNull DoubleFunction<Double> toMicros) Formats the histogram to a string with duration in microseconds.
protected String	was()

Methods inherited from class net.openhft.chronicle.core.util.Histogram

add, equals, floor, fractionBits, getPercentiles, getPercentiles, hashCode, init, max, min, overRange, percentageLessThan, percentile, percentilesFor, powersOf2, sample, sampleCount, timeMicros, toLongMicrosFormat, toMicrosFormat, toString, totalCount, typical

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RecordingHistogram

public RecordingHistogram()

Constructs a new RecordingHistogram with specified parameters.

Method Detail

sampleNanos

public void sampleNanos(long durationNs)

Records a sample duration in nanoseconds and keeps track of the top durations.

Specified by:

sampleNanos in interface NanoSampler

Overrides:

sampleNanos in class Histogram

Parameters:

durationNs - The sample duration in nanoseconds.

currentTimeNanos

protected long currentTimeNanos()

Retrieves the current time in nanoseconds.

Returns:

The current time in nanoseconds.

toMicrosFormat

@NotNull
public @NotNull String toMicrosFormat(@NotNull
                                               @NotNull DoubleFunction<Double> toMicros)

Formats the histogram to a string with duration in microseconds.

Overrides:

toMicrosFormat in class Histogram

Parameters:

toMicros - A function to convert nanoseconds to microseconds.

Returns:

A formatted string representation of the histogram.

toLongMicrosFormat

@NotNull
public @NotNull String toLongMicrosFormat(@NotNull
                                                   @NotNull DoubleFunction<Double> toMicros)

Formats the histogram to a long string with duration in microseconds.

Overrides:

toLongMicrosFormat in class Histogram

Parameters:

toMicros - A function to convert nanoseconds to microseconds.

Returns:

A formatted string representation of the histogram.

reset

public void reset()

Resets the state of this RecordingHistogram.

Overrides:

reset in class Histogram

was

protected String was()

Overrides:

was in class Histogram