com.bizo.asperatus.rates

Class AsperatusRateTrackerScheduler

java.lang.Object

com.bizo.asperatus.rates.AsperatusRateTrackerScheduler

public final class AsperatusRateTrackerScheduler
extends java.lang.Object

Helper class that will schedule flushing the rate reported by a RateTracker to an Asperatus MetricTracker using a ScheduledExecutorService. By default, this class will push metrics once per minute; this can be adjusted via the frequency and frequencyUnit parameters provided that the scheduler is stopped. Note that this class is not thread safe. Additionally, the start/stop methods are not idempotent; they will throw IllegalStateExceptions if called out of order.

Constructor Summary

Constructors

Constructor and Description
AsperatusRateTrackerScheduler(MetricTracker metricTracker, java.lang.String metricName, java.util.List<Dimension> dimensions, RateTracker rateTracker, java.util.concurrent.ScheduledExecutorService executor) Creates a new AsperatusRateTrackerScheduler in the stopped state.

Method Summary

Modifier and Type	Method and Description
int	getFrequency()
java.util.concurrent.TimeUnit	getFrequencyUnit()
boolean	isStarted()
void	setFrequency(int frequency)
void	setFrequencyUnit(java.util.concurrent.TimeUnit frequencyUnit)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

AsperatusRateTrackerScheduler

public AsperatusRateTrackerScheduler(MetricTracker metricTracker,
                                     java.lang.String metricName,
                                     java.util.List<Dimension> dimensions,
                                     RateTracker rateTracker,
                                     java.util.concurrent.ScheduledExecutorService executor)

Creates a new AsperatusRateTrackerScheduler in the stopped state.

Method Detail

start

public void start()

stop

public void stop()

isStarted

public boolean isStarted()

getFrequency

public int getFrequency()

setFrequency

public void setFrequency(int frequency)

getFrequencyUnit

public java.util.concurrent.TimeUnit getFrequencyUnit()

setFrequencyUnit

public void setFrequencyUnit(java.util.concurrent.TimeUnit frequencyUnit)