Package com.codahale.metrics

Class SlidingTimeWindowReservoir

java.lang.Object

com.codahale.metrics.SlidingTimeWindowReservoir

All Implemented Interfaces:

Reservoir

public class SlidingTimeWindowReservoir
extends Object
implements Reservoir

A Reservoir implementation backed by a sliding window that stores only the measurements made in the last N seconds (or other time unit).

Field Summary

Fields

Modifier and Type	Field	Description
private final Clock	clock
private static final int	COLLISION_BUFFER
private final AtomicLong	count
private final AtomicLong	lastTick
private final ConcurrentSkipListMap<Long,Long>	measurements
private static final int	TRIM_THRESHOLD
private final long	window

Constructor Summary

Constructors

Constructor	Description
SlidingTimeWindowReservoir(long window, TimeUnit windowUnit)	Creates a new SlidingTimeWindowReservoir with the given window of time.
SlidingTimeWindowReservoir(long window, TimeUnit windowUnit, Clock clock)	Creates a new SlidingTimeWindowReservoir with the given clock and window of time.

Method Summary

Modifier and Type	Method	Description
Snapshot	getSnapshot()	Returns a snapshot of the reservoir's values.
private long	getTick()
int	size()	Returns the number of values recorded.
private void	trim()
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

Field Details

COLLISION_BUFFER

private static final int COLLISION_BUFFER

See Also:

• Constant Field Values

TRIM_THRESHOLD

private static final int TRIM_THRESHOLD

See Also:

• Constant Field Values

clock

private final Clock clock

measurements

private final ConcurrentSkipListMap<Long,Long> measurements

window

private final long window

lastTick

private final AtomicLong lastTick

count

private final AtomicLong count

Constructor Details

SlidingTimeWindowReservoir

public SlidingTimeWindowReservoir(long window,
 TimeUnit windowUnit)

Creates a new SlidingTimeWindowReservoir with the given window of time.

Parameters:

window - the window of time

windowUnit - the unit of window

SlidingTimeWindowReservoir

public SlidingTimeWindowReservoir(long window,
 TimeUnit windowUnit,
 Clock clock)

Creates a new SlidingTimeWindowReservoir with the given clock and window of time.

Parameters:

window - the window of time

windowUnit - the unit of window

clock - the Clock to use

Method Details

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:

a snapshot of the reservoir's values

getTick

private long getTick()

trim

private void trim()