org.avaje.metric

Interface ValueMetric

All Superinterfaces:

Metric

public interface ValueMetric
extends Metric

Metric that collects long values (e.g. total bytes sent).

Used when events have a value such as bytes sent, bytes received, lines read etc.

 // Declare the metric (typically as a static field)
 static final ValueMetric totalBytesSentMetric = MetricManager.getValueMetric(MyService.class, "totalBytesSent");
 ...

 public void performSomeIO() {

   long bytesSent = ...

   totalBytesSentMetric.addEvent(bytesSent);
   ...
 }

Method Summary

Modifier and Type	Method and Description
void	addEvent(long value) Add a value (bytes, time, rows etc).
long	getCount() Return the count of values collected (since the last reset/collection).
long	getMax() Return the Max value collected (since the last reset/collection).
long	getMean() Return the mean value rounded up for the values collected since the last reset/collection.
long	getTotal() Return the total of all the values (since the last reset/collection).

Methods inherited from interface org.avaje.metric.Metric

clear, collect, getName

Method Detail

addEvent

void addEvent(long value)

Add a value (bytes, time, rows etc).

getCount

long getCount()

Return the count of values collected (since the last reset/collection).

getTotal

long getTotal()

Return the total of all the values (since the last reset/collection).

getMax

long getMax()

Return the Max value collected (since the last reset/collection).

getMean

long getMean()

Return the mean value rounded up for the values collected since the last reset/collection.