Package com.yammer.metrics.core

Class BurstRateTrackingCounter

java.lang.Object

com.yammer.metrics.core.Counter

com.yammer.metrics.core.BurstRateTrackingCounter

All Implemented Interfaces:

com.yammer.metrics.core.Metric

public class BurstRateTrackingCounter
extends com.yammer.metrics.core.Counter
implements com.yammer.metrics.core.Metric

A counter that accurately tracks burst rate, 1-minute rate and 5-minute rate, with customizable precision (defined by granularityMillis parameter, which controls sample collection interval).

Author:

vasily@wavefront.com

Constructor Summary

Constructors

Constructor	Description
BurstRateTrackingCounter(com.yammer.metrics.core.MetricName metricName, com.yammer.metrics.core.MetricsRegistry metricsRegistry, int granularityMillis)

Method Summary

Modifier and Type	Method	Description
void	clear()
long	count()
void	dec()
void	dec(long n)
com.yammer.metrics.core.Histogram	getBurstRateHistogram()	Get histogram of 1s burst rates.
long	getCurrentRate()	Get most recent 1-second rate.
long	getFiveMinuteCount()	Get delta value of the counter between now and 5 minutes ago.
String	getFiveMinutePrintableRate()	Get 4-minute rate in human-readable form.
Double	getMaxBurstRateAndClear()	Get highest burst rate and reset the histogram.
long	getOneMinuteCount()	Get delta value of the counter between now and 1 minute ago.
String	getOneMinutePrintableRate()	Get 1-minute rate in human-readable form.
static String	getPrintableRate(long count)	Convert a per minute count to human-readable per second rate.
long	getSampleCount()	Get the number of samples since the counter received its first non-zero sample.
void	inc()
void	inc(long n)
<T> void	processWith(com.yammer.metrics.core.MetricProcessor<T> processor, com.yammer.metrics.core.MetricName name, T context)

Methods inherited from class java.lang.Object

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

Constructor Detail

BurstRateTrackingCounter

public BurstRateTrackingCounter(com.yammer.metrics.core.MetricName metricName,
                                @Nullable
                                com.yammer.metrics.core.MetricsRegistry metricsRegistry,
                                int granularityMillis)

Parameters:

metricName - metric name for the counter.

metricsRegistry - metrics registry for the counter. if null, default registry is used.

granularityMillis - stats collection interval in milliseconds. lower granularity usually means better precision, but it always requires more memory (we need to track 5 minutes worth of data, so, for example, if granularity is set to 100ms, we have to keep 3000 long values).

Method Detail

getBurstRateHistogram

public com.yammer.metrics.core.Histogram getBurstRateHistogram()

Get histogram of 1s burst rates.

Returns:

burst rate histogram

getCurrentRate

public long getCurrentRate()

Get most recent 1-second rate.

Returns:

rate

getMaxBurstRateAndClear

public Double getMaxBurstRateAndClear()

Get highest burst rate and reset the histogram. .

Returns:

burst rate

getOneMinutePrintableRate

public String getOneMinutePrintableRate()

Get 1-minute rate in human-readable form.

Returns:

1-minute rate as string

getFiveMinutePrintableRate

public String getFiveMinutePrintableRate()

Get 4-minute rate in human-readable form.

Returns:

4-minute rate as string

getOneMinuteCount

public long getOneMinuteCount()

Get delta value of the counter between now and 1 minute ago.

Returns:

1-minute delta value

getFiveMinuteCount

public long getFiveMinuteCount()

Get delta value of the counter between now and 5 minutes ago.

Returns:

5-minute delta value

getSampleCount

public long getSampleCount()

Get the number of samples since the counter received its first non-zero sample.

Returns:

number of samples.

getPrintableRate

public static String getPrintableRate(long count)

Convert a per minute count to human-readable per second rate.

Parameters:

count - counter value.

Returns:

human readable string

inc

public void inc()

Overrides:

inc in class com.yammer.metrics.core.Counter

inc

public void inc(long n)

Overrides:

inc in class com.yammer.metrics.core.Counter

dec

public void dec()

Overrides:

dec in class com.yammer.metrics.core.Counter

dec

public void dec(long n)

Overrides:

dec in class com.yammer.metrics.core.Counter

count

public long count()

Overrides:

count in class com.yammer.metrics.core.Counter

clear

public void clear()

Overrides:

clear in class com.yammer.metrics.core.Counter

processWith

public <T> void processWith(com.yammer.metrics.core.MetricProcessor<T> processor,
                            com.yammer.metrics.core.MetricName name,
                            T context)
                     throws Exception

Specified by:

processWith in interface com.yammer.metrics.core.Metric

Overrides:

processWith in class com.yammer.metrics.core.Counter

Throws:

Exception