com.codahale.metrics

Interface MovingAverages

All Known Implementing Classes:

ExponentialMovingAverages, SlidingTimeWindowMovingAverages

public interface MovingAverages

A triple of moving averages (one-, five-, and fifteen-minute moving average) as needed by Meter.

Included implementations are:

• ExponentialMovingAverages exponential decaying average similar to the top Unix command.
• SlidingTimeWindowMovingAverages simple (unweighted) moving average

Method Summary

Modifier and Type	Method and 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.

Method Detail

tickIfNecessary

void tickIfNecessary()

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

update

void update(long n)

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

Parameters:

n -

getM1Rate

double getM1Rate()

Returns the one-minute moving average rate

Returns:

the one-minute moving average rate

getM5Rate

double getM5Rate()

Returns the five-minute moving average rate

Returns:

the five-minute moving average rate

getM15Rate

double getM15Rate()

Returns the fifteen-minute moving average rate

Returns:

the fifteen-minute moving average rate