io.dropwizard.metrics

Class HdrHistogramResetOnSnapshotReservoir

java.lang.Object

io.dropwizard.metrics.HdrHistogramResetOnSnapshotReservoir

All Implemented Interfaces:

Reservoir

@ThreadSafe
public final class HdrHistogramResetOnSnapshotReservoir
extends Object
implements Reservoir

A Reservoir that resets its internal state every time a snapshot is taken. This is useful if you're using snapshots as a means of defining the window in which you want to calculate, say, the 99.9th percentile.

Constructor Summary

Constructors

Constructor and Description
HdrHistogramResetOnSnapshotReservoir() Create a reservoir with a default recorder.
HdrHistogramResetOnSnapshotReservoir(org.HdrHistogram.Recorder recorder) Create a reservoir with a user-specified recorder.

Method Summary

Modifier and Type	Method and Description
Snapshot	getSnapshot() Returns a snapshot of the reservoir's values.
int	size() Returns the number of values recorded.
void	update(long value) Adds a new recorded value to the reservoir.

Methods inherited from class java.lang.Object

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

Constructor Detail

HdrHistogramResetOnSnapshotReservoir

public HdrHistogramResetOnSnapshotReservoir()

Create a reservoir with a default recorder. This recorder should be suitable for most usage.

HdrHistogramResetOnSnapshotReservoir

public HdrHistogramResetOnSnapshotReservoir(org.HdrHistogram.Recorder recorder)

Create a reservoir with a user-specified recorder.

Parameters:

recorder - Recorder to use

Method Detail

size

public int size()

Description copied from interface: Reservoir

Returns the number of values recorded.

Specified by:

size in interface Reservoir

Returns:

the number of values recorded

update

public void update(long value)

Description copied from interface: Reservoir

Adds a new recorded value to the reservoir.

Specified by:

update in interface Reservoir

Parameters:

value - a new recorded value

getSnapshot

public Snapshot getSnapshot()

Description copied from interface: Reservoir

Returns a snapshot of the reservoir's values.

Specified by:

getSnapshot in interface Reservoir

Returns:

the data since the last snapshot was taken