Package org.pipecraft.infra.monitoring.sliding

Class EventRateSlidingWindow

java.lang.Object

org.pipecraft.infra.monitoring.sliding.SlidingWindow<Void,AtomicInteger,Long>

org.pipecraft.infra.monitoring.sliding.EventRateSlidingWindow

public class EventRateSlidingWindow
extends SlidingWindow<Void,AtomicInteger,Long>

A simple sliding window used for calculating events rate in a given time frame

Author:

Eyal Schneider

Constructor Summary

Constructors

Constructor	Description
EventRateSlidingWindow(int slotsCount, int slotTime, TimeUnit slotTimeUnit, ScheduledExecutorService ex)	Constructor

Method Summary

Modifier and Type	Method	Description
protected void	clearRecord(AtomicInteger record)	clears a given record by resetting its data.
protected void	newEvent(Void event, AtomicInteger rec)	Reports a new event to be appended into a given time slot record
protected AtomicInteger	newRecord()
protected AtomicInteger[]	newRecordArray(int size)
protected Long	query(AtomicInteger[] records)
float	query(TimeUnit timeUnit)

Methods inherited from class org.pipecraft.infra.monitoring.sliding.SlidingWindow

getRecord, getSlotsCount, getSlotTime, getSlotTimeUnit, getWindowTimeSpanMs, newEvent, query, query, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

EventRateSlidingWindow

public EventRateSlidingWindow(int slotsCount,
                              int slotTime,
                              TimeUnit slotTimeUnit,
                              ScheduledExecutorService ex)

Constructor

Method Detail

newEvent

protected void newEvent(Void event,
                        AtomicInteger rec)

Description copied from class: SlidingWindow

Reports a new event to be appended into a given time slot record

Specified by:

newEvent in class SlidingWindow<Void,AtomicInteger,Long>

Parameters:

event - The event

rec - The record to be updated

newRecord

protected AtomicInteger newRecord()

Specified by:

newRecord in class SlidingWindow<Void,AtomicInteger,Long>

Returns:

A new, empty record. Called only during the construction of the sliding window.

newRecordArray

protected AtomicInteger[] newRecordArray(int size)

Specified by:

newRecordArray in class SlidingWindow<Void,AtomicInteger,Long>

Parameters:

size - The required size

Returns:

A new, empty record array of the given size.

clearRecord

protected void clearRecord(AtomicInteger record)

Description copied from class: SlidingWindow

clears a given record by resetting its data. It is up to the implementation to decide how to deal with data consistency in case of a concurrent query that inspects that record. It is highly unlikely that an event is registered in the record during this operation.

Specified by:

clearRecord in class SlidingWindow<Void,AtomicInteger,Long>

query

protected Long query(AtomicInteger[] records)

Specified by:

query in class SlidingWindow<Void,AtomicInteger,Long>

Parameters:

records - the array of records to inspect. Ordered from oldest to newest.

Returns:

The query result, relevant for the time period covered by the given lookback.

query

public float query(TimeUnit timeUnit)

Parameters:

timeUnit - a time unit

Returns:

The rate measured by this sliding window, in events per single time unit