org.apache.storm.metric.internal

Class LatencyStatAndMetric

java.lang.Object

org.apache.storm.metric.internal.LatencyStatAndMetric

All Implemented Interfaces:

IMetric

public class LatencyStatAndMetric
extends Object
implements IMetric

Acts as a Latency Metric, but also keeps track of approximate latency for the last 10 mins, 3 hours, 1 day, and all time.

Constructor Summary

Constructors

Constructor and Description
LatencyStatAndMetric(int numBuckets) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
Map<String,Double>	getTimeLatAvg() Get time latency average.
Object	getValueAndReset() Get value and reset.
void	record(long latency) Record a specific latency.

Methods inherited from class java.lang.Object

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

Constructor Detail

LatencyStatAndMetric

public LatencyStatAndMetric(int numBuckets)

Constructor.

Parameters:

numBuckets - the number of buckets to divide the time periods into.

Method Detail

record

public void record(long latency)

Record a specific latency.

Parameters:

latency - what we are recording

getValueAndReset

public Object getValueAndReset()

Description copied from interface: IMetric

Get value and reset.

Specified by:

getValueAndReset in interface IMetric

Returns:

an object that will be sent sent to IMetricsConsumer#handleDataPoints(org.apache.storm.metric.api.IMetricsConsumer .TaskInfo, java.util.Collection). If null is returned nothing will be sent. If this value can be reset, like with a counter, a side effect of calling this should be that the value is reset.

getTimeLatAvg

public Map<String,Double> getTimeLatAvg()

Get time latency average.

Returns:

a map of time window to average latency. Keys are “600” for last 10 mins “10800” for the last 3 hours “86400” for the last day “:all-time” for all time

close

public void close()