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

Methods

Modifier and Type	Method and Description
void	addEvent(long value) Add a value (bytes, time, rows etc).
ValueStatistics	getCollectedStatistics() Return the statistics collected.

Methods inherited from interface org.avaje.metric.Metric

clearStatistics, collectStatistics, getName, visit

Method Detail

getCollectedStatistics

ValueStatistics getCollectedStatistics()

Return the statistics collected.

addEvent

void addEvent(long value)

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