com.bizo.asperatus.rates

Class ThreadSafeRateTracker

java.lang.Object

com.bizo.asperatus.rates.ThreadSafeRateTracker

All Implemented Interfaces:

RateTracker

public final class ThreadSafeRateTracker
extends java.lang.Object
implements RateTracker

This class is a basic thread-safe implementation of RateTracker. The recommended use pattern is to use a scheduled executor service to periodically call "getRateAndResetPeriod" and pass the result to a metric tracking service (ie, Asperatus/CloudWatch).

Constructor Summary

Constructors

Constructor and Description
ThreadSafeRateTracker() Constructor that uses the system time to track the duration of each reporting period.
ThreadSafeRateTracker(com.google.common.base.Stopwatch stopwatch) Constructor that allows passing a specific Stopwatch implementation.

Method Summary

Modifier and Type	Method and Description
double	getRateAndResetPeriod() Get the rate of events per second based on the data since the last call to this method (or object instantiation, for the first call).
void	track() Record that the tracked even occurred.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadSafeRateTracker

public ThreadSafeRateTracker()

Constructor that uses the system time to track the duration of each reporting period.

ThreadSafeRateTracker

public ThreadSafeRateTracker(com.google.common.base.Stopwatch stopwatch)

Constructor that allows passing a specific Stopwatch implementation. Intended for testing.

Method Detail

track

public void track()

Description copied from interface: RateTracker

Record that the tracked even occurred.

Specified by:

track in interface RateTracker

getRateAndResetPeriod

public double getRateAndResetPeriod()

Description copied from interface: RateTracker

Get the rate of events per second based on the data since the last call to this method (or object instantiation, for the first call).

Specified by:

getRateAndResetPeriod in interface RateTracker