org.avaje.metric

Interface CounterMetric

All Superinterfaces:

Metric

public interface CounterMetric
extends Metric

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

Can be used to count discrete events like 'user login'. 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");
  ...
  
  public void performUserLogin() {
  
    // increment the counter
    userLoginCounter.markEvent();
    ...
  }
  
 
 

Method Summary

Methods

Modifier and Type	Method and Description
CounterStatistics	getCollectedStatistics() Return the collected statistics.
CounterStatistics	getStatistics(boolean reset) Return the current statistics.
void	markEvent() Mark that 1 event has occurred.
void	markEvents(long numberOfEventsOccurred) Mark that numberOfEventsOccurred events have occurred.

Methods inherited from interface org.avaje.metric.Metric

clearStatistics, collectStatistics, getName, visit

Method Detail

getStatistics

CounterStatistics getStatistics(boolean reset)

Return the current statistics.

getCollectedStatistics

CounterStatistics getCollectedStatistics()

Return the collected statistics. This is used by reporting objects.

markEvent

void markEvent()

Mark that 1 event has occurred.

markEvents

void markEvents(long numberOfEventsOccurred)

Mark that numberOfEventsOccurred events have occurred.