org.apache.samza.metrics

Class SlidingTimeWindowReservoir

java.lang.Object

org.apache.samza.metrics.SlidingTimeWindowReservoir

All Implemented Interfaces:

Reservoir

public class SlidingTimeWindowReservoir
extends java.lang.Object
implements Reservoir

An implemented Reservoir used to store values that appear in a sliding time window

Constructor Summary

Constructors

Constructor and Description
SlidingTimeWindowReservoir() Default constructor using default window size
SlidingTimeWindowReservoir(long windowMs) Construct the SlidingTimeWindowReservoir with window size
SlidingTimeWindowReservoir(long windowMs, Clock clock)
SlidingTimeWindowReservoir(long windowMs, int collisionBuffer, Clock clock)

Method Summary

Modifier and Type	Method and Description
Snapshot	getSnapshot() Return a Snapshot of this reservoir
int	size() Return the number of values in this reservoir
void	update(long value) Update the reservoir with the new value

Methods inherited from class java.lang.Object

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

Constructor Detail

SlidingTimeWindowReservoir

public SlidingTimeWindowReservoir()

Default constructor using default window size

SlidingTimeWindowReservoir

public SlidingTimeWindowReservoir(long windowMs)

Construct the SlidingTimeWindowReservoir with window size

Parameters:

windowMs - the size of the window. unit is millisecond.

SlidingTimeWindowReservoir

public SlidingTimeWindowReservoir(long windowMs,
                                  Clock clock)

SlidingTimeWindowReservoir

public SlidingTimeWindowReservoir(long windowMs,
                                  int collisionBuffer,
                                  Clock clock)

Method Detail

size

public int size()

Description copied from interface: Reservoir

Return the number of values in this reservoir

Specified by:

size in interface Reservoir

Returns:

the number of values;

update

public void update(long value)

Description copied from interface: Reservoir

Update the reservoir with the new value

Specified by:

update in interface Reservoir

Parameters:

value - a value to update

getSnapshot

public Snapshot getSnapshot()

Description copied from interface: Reservoir

Return a Snapshot of this reservoir

Specified by:

getSnapshot in interface Reservoir

Returns:

a statistical snapshot of this reservoir