net.obvj.performetrics.monitors

Class MonitoredRunnable

java.lang.Object

net.obvj.performetrics.monitors.MonitoredRunnable

All Implemented Interfaces:

Runnable

public class MonitoredRunnable
extends Object
implements Runnable

A Runnable wrapper that maintains one or more counters for monitoring the time spent by the Runnable's run() method.

Specify a target Runnable via constructor, then execute the run() method available in this wrapper. The target Runnable's run() method will be executed and monitored. After the operation, call printStatistics(System.out) to print the statistics to the system console or getCounter(Counter.Type), then elapsedTime() to retrieve the elapsed time for a particular counter. E.g.:

 Counter cpuTime = monitoredRunnable.getCounter(Counter.Type.CPU_TIME);
 double elapsedTimeMillis = cpuTime.elapsedTime(TimeUnit.MILLISECONDS);
 

By default, all available counter types will be measured, if no specific counter types are passed to the constructor. If required, an additional constructor may be used to set up one or more specific counters to be maintained. E.g.:

 new MonitoredRunnable(runnable); // maintains all available counter types
 new MonitoredRunnable(runnable, Counter.Type.WALL_CLOCK_TIME); // wall-clock time only
 

For a list of available counters, refer to Counter.Type.

Note: This class is not thread-safe. In a multi-thread context, different instances must be created for each thread.

Author:

oswaldo.bapvic.jr

See Also:

Counter, Counter.Type

Constructor Summary

Constructors

Constructor and Description
MonitoredRunnable(Runnable targetRunnable) Builds this monitored operation with a given Runnable.
MonitoredRunnable(Runnable targetRunnable, Counter.Type... types) Builds this monitored operation with a given Runnable and one or more specific counter types to be maintained.

Method Summary

Modifier and Type	Method and Description
Counter	getCounter(Counter.Type type) Returns the counter instance associated with a given type in this monitored operation.
Collection<Counter>	getCounters() Returns the counters maintained by this monitored operation.
void	printStatistics(PrintStream printStream) Prints operation statistics in the specified print stream.
void	printStatistics(PrintStream printStream, TimeUnit timeUnit) Prints operation statistics in the specified print stream, with a custom time unit.
void	run() See Runnable.run().

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MonitoredRunnable

public MonitoredRunnable(Runnable targetRunnable)

Builds this monitored operation with a given Runnable. All available counter types will be maintained.

Parameters:

targetRunnable - the Runnable to be executed and profiled

MonitoredRunnable

public MonitoredRunnable(Runnable targetRunnable,
                         Counter.Type... types)

Builds this monitored operation with a given Runnable and one or more specific counter types to be maintained.

Parameters:

targetRunnable - the Runnable to be executed and profiled

types - the counter types to be maintained with the operation

Method Detail

run

public void run()

See Runnable.run().

Specified by:

run in interface Runnable

getCounters

public Collection<Counter> getCounters()

Returns the counters maintained by this monitored operation.

Returns:

all counters maintained by this monitored operation.

getCounter

public Counter getCounter(Counter.Type type)

Returns the counter instance associated with a given type in this monitored operation.

Parameters:

type - the counter type to be fetched

Returns:

the counter instance associated with the given type in this monitored operation

printStatistics

public void printStatistics(PrintStream printStream)

Prints operation statistics in the specified print stream.

Parameters:

printStream - the print stream to which statistics will be sent

printStatistics

public void printStatistics(PrintStream printStream,
                            TimeUnit timeUnit)

Prints operation statistics in the specified print stream, with a custom time unit.

Parameters:

printStream - the print stream to which statistics will be sent

timeUnit - the time unit for the elapsed times to be displayed