• Home
• org.avaje.metric
• avaje-metric-api
• 5.1.1
• source code
• ValueMetric.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.avaje.metric.ValueMetric Maven / Gradle / Ivy

package org.avaje.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);
 *    ...
 *  }
 *  
 * 
 * 
 
 */
public interface ValueMetric extends Metric {

  /**
   * Return the statistics collected.
   */
  ValueStatistics getCollectedStatistics();

  /**
   * Add a value (bytes, time, rows etc).
   */
  void addEvent(long value);

}