com.tibco.tea.agent.metrics

Interface Timer

All Superinterfaces:

Metric

public interface Timer
extends Metric

Metric for aggregating timing durations. Timing duration can be measured in following two ways:

• Agent extender will measure the time duration and invoke update(long, TimeUnit) to add the duration to the Timer metric.
• Agent extender will invoke time(Callable) and Timer implementation will measure the time duration taken by Callable.call().

Examples of where a Timer can be used:

• Time taken in processing requests.
• Time taken for executing JDBC queries.

This class does not require external locking for thread safety.

Method Summary

Methods

Modifier and Type	Method and Description
TimeUnit	getDurationUnit() Returns the time unit at which event duration will be measured.
double	getMax() Returns the longest recorded duration.
double	getMean() Returns the arithmetic mean of all recorded durations.
double	getMin() Returns the shortest recorded duration.
TimeUnit	getRateUnit() Returns the time unit at which rate, event occurence will be measured.
double	getStdDev() Returns the standard deviation of all recorded durations.
<T> T	time(Callable<T> event) Times and records the duration of event.
void	update(long duration, TimeUnit unit) Adds a recorded duration.

Method Detail

getRateUnit

TimeUnit getRateUnit()

Returns the time unit at which rate, event occurence will be measured.

Returns:

the timer's rate unit

update

void update(long duration,
          TimeUnit unit)

Adds a recorded duration.

Parameters:

duration - the length of the duration

unit - the scale unit of duration

getDurationUnit

TimeUnit getDurationUnit()

Returns the time unit at which event duration will be measured.

Returns:

the timer's duration unit

time

<T> T time(Callable<T> event)
       throws Exception

Times and records the duration of event.

Type Parameters:

T - the type of the value returned by event

Parameters:

event - a Callable whose Callable.call() method implements a process whose duration should be timed

Returns:

the value returned by event

Throws:

Exception - if event throws an Exception

getMax

double getMax()

Returns the longest recorded duration.

Returns:

the longest recorded duration

getMin

double getMin()

Returns the shortest recorded duration.

Returns:

the shortest recorded duration

getMean

double getMean()

Returns the arithmetic mean of all recorded durations.

Returns:

the arithmetic mean of all recorded durations

getStdDev

double getStdDev()

Returns the standard deviation of all recorded durations.

Returns:

the standard deviation of all recorded durations