Package com.codahale.metrics

Class InstrumentedExecutorService

java.lang.Object

com.codahale.metrics.InstrumentedExecutorService

All Implemented Interfaces:

Executor, ExecutorService

public class InstrumentedExecutorService
extends Object
implements ExecutorService

An ExecutorService that monitors the number of tasks submitted, running, completed and also keeps a Timer for the task duration.

It will register the metrics using the given (or auto-generated) name as classifier, e.g: "your-executor-service.submitted", "your-executor-service.running", etc.

Constructor Summary

Constructors

Constructor	Description
InstrumentedExecutorService(ExecutorService delegate, MetricRegistry registry)	Wraps an ExecutorService uses an auto-generated default name.
InstrumentedExecutorService(ExecutorService delegate, MetricRegistry registry, String name)	Wraps an ExecutorService with an explicit name.

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long l, TimeUnit timeUnit)
void	execute(Runnable runnable)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
List<Runnable>	shutdownNow()
Future<?>	submit(Runnable runnable)
<T> Future<T>	submit(Runnable runnable, T result)
<T> Future<T>	submit(Callable<T> task)

Methods inherited from class java.lang.Object

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

Constructor Details

InstrumentedExecutorService

public InstrumentedExecutorService(ExecutorService delegate,
 MetricRegistry registry)

Wraps an ExecutorService uses an auto-generated default name.

Parameters:

delegate - ExecutorService to wrap.

registry - MetricRegistry that will contain the metrics.

InstrumentedExecutorService

public InstrumentedExecutorService(ExecutorService delegate,
 MetricRegistry registry,
 String name)

Wraps an ExecutorService with an explicit name.

Parameters:

delegate - ExecutorService to wrap.

registry - MetricRegistry that will contain the metrics.

name - name for this executor service.

Method Details

execute

public void execute(Runnable runnable)

Specified by:

execute in interface Executor

submit

public Future<?> submit(Runnable runnable)

Specified by:

submit in interface ExecutorService

submit

public <T> Future<T> submit(Runnable runnable,
 T result)

Specified by:

submit in interface ExecutorService

submit

public <T> Future<T> submit(Callable<T> task)

Specified by:

submit in interface ExecutorService

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks)
                              throws InterruptedException

Specified by:

invokeAll in interface ExecutorService

Throws:

InterruptedException

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks,
 long timeout,
 TimeUnit unit)
                              throws InterruptedException

Specified by:

invokeAll in interface ExecutorService

Throws:

InterruptedException

invokeAny

public <T> T invokeAny(Collection<? extends Callable<T>> tasks)
                throws ExecutionException,
InterruptedException

Specified by:

invokeAny in interface ExecutorService

Throws:

ExecutionException

InterruptedException

invokeAny

public <T> T invokeAny(Collection<? extends Callable<T>> tasks,
 long timeout,
 TimeUnit unit)
                throws ExecutionException,
InterruptedException,
TimeoutException

Specified by:

invokeAny in interface ExecutorService

Throws:

ExecutionException

InterruptedException

TimeoutException

shutdown

public void shutdown()

Specified by:

shutdown in interface ExecutorService

shutdownNow

public List<Runnable> shutdownNow()

Specified by:

shutdownNow in interface ExecutorService

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface ExecutorService

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface ExecutorService

awaitTermination

public boolean awaitTermination(long l,
 TimeUnit timeUnit)
                         throws InterruptedException

Specified by:

awaitTermination in interface ExecutorService

Throws:

InterruptedException