org.avaje.metric

Interface Metric

All Known Subinterfaces:

CounterMetric, GaugeDoubleMetric, GaugeLongMetric, TimedMetric, ValueMetric

public interface Metric

A Metric that collects statistics on events.

• TimedMetric and BucketTimedMetric are used for monitoring execution time
• CounterMetric is for counting discrete events like 'user logged in'
• ValueMetric is used when events have a value like bytes sent, lines read
• Gauges measure the current value of a resource like 'used memory' or 'active threads'.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the statistics resetting any internal counters etc.
void	collect(MetricStatisticsVisitor collector) Typically this is only called by the MetricManager and tells the metric to collect its underlying statistics for reporting purposes and in addition resetting and internal counters it has.
MetricName	getName() Return the name of the metric.

Method Detail

getName

MetricName getName()

Return the name of the metric.

collect

void collect(MetricStatisticsVisitor collector)

Typically this is only called by the MetricManager and tells the metric to collect its underlying statistics for reporting purposes and in addition resetting and internal counters it has.

clear

void clear()

Clear the statistics resetting any internal counters etc.

Typically the MetricManager takes care of resetting the statistic/counters for the metrics when it periodically collects and reports all the metrics and you are not expected to use this method.