com.codahale.metrics

Class InstrumentedExecutorService

java.lang.Object

com.codahale.metrics.InstrumentedExecutorService

All Implemented Interfaces:

java.util.concurrent.Executor, java.util.concurrent.ExecutorService

public class InstrumentedExecutorService
extends java.lang.Object
implements java.util.concurrent.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 and Description
InstrumentedExecutorService(java.util.concurrent.ExecutorService delegate, MetricRegistry registry) Wraps an ExecutorService uses an auto-generated default name.
InstrumentedExecutorService(java.util.concurrent.ExecutorService delegate, MetricRegistry registry, java.lang.String name) Wraps an ExecutorService with an explicit name.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

InstrumentedExecutorService

public InstrumentedExecutorService(java.util.concurrent.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(java.util.concurrent.ExecutorService delegate,
                                   MetricRegistry registry,
                                   java.lang.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 Detail

execute

public void execute(java.lang.Runnable runnable)

Specified by:

execute in interface java.util.concurrent.Executor

submit

public java.util.concurrent.Future<?> submit(java.lang.Runnable runnable)

Specified by:

submit in interface java.util.concurrent.ExecutorService

submit

public <T> java.util.concurrent.Future<T> submit(java.lang.Runnable runnable,
                                                 T result)

Specified by:

submit in interface java.util.concurrent.ExecutorService

submit

public <T> java.util.concurrent.Future<T> submit(java.util.concurrent.Callable<T> task)

Specified by:

submit in interface java.util.concurrent.ExecutorService

invokeAll

public <T> java.util.List<java.util.concurrent.Future<T>> invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
                                                             throws java.lang.InterruptedException

Specified by:

invokeAll in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

invokeAll

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

Specified by:

invokeAll in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

invokeAny

public <T> T invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
                throws java.util.concurrent.ExecutionException,
                       java.lang.InterruptedException

Specified by:

invokeAny in interface java.util.concurrent.ExecutorService

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

invokeAny

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

Specified by:

invokeAny in interface java.util.concurrent.ExecutorService

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

java.util.concurrent.TimeoutException

shutdown

public void shutdown()

Specified by:

shutdown in interface java.util.concurrent.ExecutorService

shutdownNow

public java.util.List<java.lang.Runnable> shutdownNow()

Specified by:

shutdownNow in interface java.util.concurrent.ExecutorService

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface java.util.concurrent.ExecutorService

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface java.util.concurrent.ExecutorService

awaitTermination

public boolean awaitTermination(long l,
                                java.util.concurrent.TimeUnit timeUnit)
                         throws java.lang.InterruptedException

Specified by:

awaitTermination in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException