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");
 ...

 void performUserLogin() {

   // increment the counter
   userLoginCounter.markEvent();
   ...
 }

Method Summary

Modifier and Type	Method and Description
long	getCount() Return the current count.
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

clear, collect, getName

Method Detail

markEvent

void markEvent()

Mark that 1 event has occurred.

markEvents

void markEvents(long numberOfEventsOccurred)

Mark that numberOfEventsOccurred events have occurred.

getCount

long getCount()

Return the current count.