Package com.codahale.metrics

Class ExponentialMovingAverages

java.lang.Object

com.codahale.metrics.ExponentialMovingAverages

All Implemented Interfaces:

MovingAverages

public class ExponentialMovingAverages
extends Object
implements MovingAverages

A triple (one, five and fifteen minutes) of exponentially-weighted moving average rates as needed by Meter.

The rates have the same exponential decay factor as the fifteen-minute load average in the top Unix command.

Constructor Summary

Constructors

Constructor	Description
ExponentialMovingAverages()	Creates a new ExponentialMovingAverages.
ExponentialMovingAverages(Clock clock)	Creates a new ExponentialMovingAverages.

Method Summary

Modifier and Type	Method	Description
double	getM15Rate()	Returns the fifteen-minute moving average rate
double	getM1Rate()	Returns the one-minute moving average rate
double	getM5Rate()	Returns the five-minute moving average rate
void	tickIfNecessary()	Tick the internal clock of the MovingAverages implementation if needed (according to the internal ticking interval)
void	update(long n)	Update all three moving averages with n events having occurred since the last update.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExponentialMovingAverages

public ExponentialMovingAverages()

Creates a new ExponentialMovingAverages.

ExponentialMovingAverages

public ExponentialMovingAverages(Clock clock)

Creates a new ExponentialMovingAverages.

Method Detail

update

public void update(long n)

Description copied from interface: MovingAverages

Update all three moving averages with n events having occurred since the last update.

Specified by:

update in interface MovingAverages

tickIfNecessary

public void tickIfNecessary()

Description copied from interface: MovingAverages

Tick the internal clock of the MovingAverages implementation if needed (according to the internal ticking interval)

Specified by:

tickIfNecessary in interface MovingAverages

getM1Rate

public double getM1Rate()

Description copied from interface: MovingAverages

Returns the one-minute moving average rate

Specified by:

getM1Rate in interface MovingAverages

Returns:

the one-minute moving average rate

getM5Rate

public double getM5Rate()

Description copied from interface: MovingAverages

Returns the five-minute moving average rate

Specified by:

getM5Rate in interface MovingAverages

Returns:

the five-minute moving average rate

getM15Rate

public double getM15Rate()

Description copied from interface: MovingAverages

Returns the fifteen-minute moving average rate

Specified by:

getM15Rate in interface MovingAverages

Returns:

the fifteen-minute moving average rate