com.j256.simplemetrics.metric

Class ControlledMetricTimer

java.lang.Object

com.j256.simplemetrics.metric.BaseControlledMetric<Double,ControlledMetricValue.ValueCount>

com.j256.simplemetrics.metric.ControlledMetricValue

com.j256.simplemetrics.metric.ControlledMetricTimer

All Implemented Interfaces:

com.j256.simplejmx.common.JmxSelfNaming, ControlledMetric<Double,ControlledMetricValue.ValueCount>, Comparable<BaseControlledMetric<Double,ControlledMetricValue.ValueCount>>

public class ControlledMetricTimer
extends ControlledMetricValue

Convenience to allow tracking of the elapsed time of events as a metric. Basically you do a:

 ControlledMetricTimer timer = new ControlledMetricTimer(...);
 ...
 long millis = timer.start();
 dao.createEntry(...);
 timer.end(millis);
 

The rest is done by the class and the metric system.

Author:

graywatson

Nested Class Summary

Nested classes/interfaces inherited from class com.j256.simplemetrics.metric.ControlledMetricValue

ControlledMetricValue.ValueCount

Nested classes/interfaces inherited from interface com.j256.simplemetrics.metric.ControlledMetric

ControlledMetric.AggregationType

Constructor Summary

Constructors

Constructor and Description
ControlledMetricTimer(String component, String module, String name, String description)

Method Summary

Modifier and Type	Method and Description
long	start() Start the timer on a particular event.
long	stop(long startMillis) End the timer on a particular event.

Methods inherited from class com.j256.simplemetrics.metric.ControlledMetricValue

createInitialValue, getAggregationType, makeValueFromLong, makeValueFromNumber

Methods inherited from class com.j256.simplemetrics.metric.BaseControlledMetric

adjustValue, adjustValue, compareTo, equals, getAggregationTypeName, getComponent, getDescription, getJmxBeanName, getJmxDomainName, getJmxFolderNames, getMetricValue, getModule, getName, getUnit, getValue, getValueDetails, getValueDetailsToPersist, getValueToPersist, hashCode, storeValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ControlledMetricTimer

public ControlledMetricTimer(String component,
                             String module,
                             String name,
                             String description)

Parameters:

component - Component short name such as "my".

module - Module name to identify the part of the component such as "pageview".

name - String label description the metric.

description - Description for more information which may not be persisted.

Method Detail

start

public long start()

Start the timer on a particular event. You should wrap the start and the end around the event you want to track.

Returns:

Millis which should be passed to stop(long) as the argument.

stop

public long stop(long startMillis)

End the timer on a particular event. This will calculate the time difference and add this to the counter.

Parameters:

startMillis - Value returned from a previous call to start().

Returns:

the calculated time difference added to the counter