Class Histogram

java.lang.Object

com.codahale.metrics.Histogram

All Implemented Interfaces:

Counting, Metric, Sampling

public class Histogram
extends Object
implements Metric, Sampling, Counting

A metric which calculates the distribution of a value.

See Also:

• Accurately computing running variance

Field Summary

Fields

Modifier and Type	Field	Description
private final LongAdder	count
private final Reservoir	reservoir

Constructor Summary

Constructors

Constructor	Description
Histogram(Reservoir reservoir)	Creates a new Histogram with the given reservoir.

Method Summary

Modifier and Type	Method	Description
long	getCount()	Returns the number of values recorded.
Snapshot	getSnapshot()	Returns a snapshot of the values.
void	update(int value)	Adds a recorded value.
void	update(long value)	Adds a recorded value.

Methods inherited from class Object

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

Field Details

reservoir

private final Reservoir reservoir

count

private final LongAdder count

Constructor Details

Histogram

public Histogram(Reservoir reservoir)

Creates a new Histogram with the given reservoir.

Parameters:

reservoir - the reservoir to create a histogram from

Method Details

update

public void update(int value)

Adds a recorded value.

Parameters:

value - the length of the value

update

public void update(long value)

Adds a recorded value.

Parameters:

value - the length of the value

getCount

public long getCount()

Returns the number of values recorded.

Specified by:

getCount in interface Counting

Returns:

the number of values recorded

getSnapshot

public Snapshot getSnapshot()

Description copied from interface: Sampling

Returns a snapshot of the values.

Specified by:

getSnapshot in interface Sampling

Returns:

a snapshot of the values