com.netflix.spectator.api.patterns

Class ThreadPoolMonitor

java.lang.Object

com.netflix.spectator.api.patterns.ThreadPoolMonitor

public final class ThreadPoolMonitor
extends java.lang.Object

Monitors and reports a common set of metrics for thread pools.

The following is the list of metrics reported followed by which ThreadPoolExecutor method populates it.

  +-----------------------------------------------------------------------------+
  | Metric Name                  | Data Source                                  |
  +------------------------------+----------------------------------------------+
  |threadpool.taskCount          | ThreadPoolExecutor.getTaskCount()            |
  +------------------------------+----------------------------------------------+
  |threadpool.completedTaskCount | ThreadPoolExecutor.getCompletedTaskCount()   |
  +------------------------------+----------------------------------------------+
  |threadpool.currentThreadsBusy | ThreadPoolExecutor.getActiveCount()          |
  +------------------------------+----------------------------------------------+
  |threadpool.maxThreads         | ThreadPoolExecutor.getMaximumPoolSize()      |
  +------------------------------+----------------------------------------------+
  |threadpool.poolSize           | ThreadPoolExecutor.getPoolSize()             |
  +------------------------------+----------------------------------------------+
  |threadpool.corePoolSize       | ThreadPoolExecutor.getCorePoolSize()         |
  +------------------------------+----------------------------------------------+
  |threadpool.queueSize          | ThreadPoolExecutor.getQueue().size()         |
  +-----------------------------------------------------------------------------+
 

Method Summary

Modifier and Type	Method and Description
static void	attach(Registry registry, java.util.concurrent.ThreadPoolExecutor threadPool, java.lang.String threadPoolName) Register the provided thread pool, optionally tagged with a name.

Methods inherited from class java.lang.Object

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

Method Detail

attach

public static void attach(Registry registry,
                          java.util.concurrent.ThreadPoolExecutor threadPool,
                          java.lang.String threadPoolName)

Register the provided thread pool, optionally tagged with a name. If a custom RejectedExecutionHandler is going to be used, then it should be set on the pool prior to attaching. Otherwise it will overwrite the wrapped rejection handler used to track the number of rejected tasks from this pool.

Parameters:

registry - The registry to use.

threadPool - The thread pool to monitor.

threadPoolName - A name with which to tag the metrics (default name used if null or empty).