• Home
• org.avaje.metric
• avaje-metric-api
• 5.1.1
• source code
• CounterMetric.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.CounterMetric Maven / Gradle / Ivy

package org.avaje.metric;

/**
 * Metric based on a counter (long value) typically used to count discrete events.
 * 

 * Can be used to count discrete events like 'user login'. {@link ValueMetric} would typically
 * be used when the event has a value (bytes sent, bytes received, lines read etc).
 * 
 * 
 *  // Declare the counter (typically as a static field)
 *  static final CounterMetric userLoginCounter = MetricManager.getCounterMetric(MyService.class, "userLogin");
 *  ...
 *  
 *  void performUserLogin() {
 *  
 *    // increment the counter
 *    userLoginCounter.markEvent();
 *    ...
 *  }
 *  
 * 
 * 
 */
public interface CounterMetric extends Metric {

  /**
   * Return the current statistics.
   */
  CounterStatistics getStatistics(boolean reset);

  /**
   * Return the collected statistics. This is used by reporting objects.
   */
  CounterStatistics getCollectedStatistics();

  /**
   * Mark that 1 event has occurred.
   */
  void markEvent();

  /**
   * Mark that numberOfEventsOccurred events have occurred.
   */
  void markEvents(long numberOfEventsOccurred);

}