Package org.opensearch.common.util.concurrent

Class OpenSearchThreadPoolExecutor

java.lang.Object

java.util.concurrent.AbstractExecutorService

java.util.concurrent.ThreadPoolExecutor

org.opensearch.common.util.concurrent.OpenSearchThreadPoolExecutor

All Implemented Interfaces:

Executor, ExecutorService

Direct Known Subclasses:

PrioritizedOpenSearchThreadPoolExecutor, QueueResizingOpenSearchThreadPoolExecutor

public class OpenSearchThreadPoolExecutor
extends ThreadPoolExecutor

An extension to thread pool executor, allowing (in the future) to add specific additional stats to it.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpenSearchThreadPoolExecutor.ShutdownListener	Listener on shut down

Nested classes/interfaces inherited from class java.util.concurrent.ThreadPoolExecutor

ThreadPoolExecutor.AbortPolicy, ThreadPoolExecutor.CallerRunsPolicy, ThreadPoolExecutor.DiscardOldestPolicy, ThreadPoolExecutor.DiscardPolicy

Method Summary

Modifier and Type	Method	Description
protected void	afterExecute(Runnable r, Throwable t)
protected void	appendThreadPoolExecutorDetails(StringBuilder sb)	Append details about this thread pool to the specified StringBuilder.
void	execute(Runnable command)
long	getPoolWaitTimeNanos()	Returns the cumulative wait time of the ThreadPool.
Stream<Runnable>	getTasks()	Returns a stream of all pending tasks.
protected void	terminated()
final String	toString()
protected Runnable	unwrap(Runnable runnable)
protected Runnable	wrapRunnable(Runnable command)

Methods inherited from class java.util.concurrent.ThreadPoolExecutor

allowCoreThreadTimeOut, allowsCoreThreadTimeOut, awaitTermination, beforeExecute, finalize, getActiveCount, getCompletedTaskCount, getCorePoolSize, getKeepAliveTime, getLargestPoolSize, getMaximumPoolSize, getPoolSize, getQueue, getRejectedExecutionHandler, getTaskCount, getThreadFactory, isShutdown, isTerminated, isTerminating, prestartAllCoreThreads, prestartCoreThread, purge, remove, setCorePoolSize, setKeepAliveTime, setMaximumPoolSize, setRejectedExecutionHandler, setThreadFactory, shutdown, shutdownNow

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny, newTaskFor, newTaskFor, submit, submit, submit

Methods inherited from class java.lang.Object

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

Method Details

terminated

protected void terminated()

Overrides:

terminated in class ThreadPoolExecutor

execute

public void execute(Runnable command)

Specified by:

execute in interface Executor

Overrides:

execute in class ThreadPoolExecutor

afterExecute

protected void afterExecute(Runnable r,
 Throwable t)

Overrides:

afterExecute in class ThreadPoolExecutor

getTasks

public Stream<Runnable> getTasks()

Returns a stream of all pending tasks. This is similar to ThreadPoolExecutor.getQueue() but will expose the originally submitted Runnable instances rather than potentially wrapped ones.

toString

public final String toString()

Overrides:

toString in class ThreadPoolExecutor

appendThreadPoolExecutorDetails

protected void appendThreadPoolExecutorDetails(StringBuilder sb)

Append details about this thread pool to the specified StringBuilder. All details should be appended as key/value pairs in the form "%s = %s, "

Parameters:

sb - the StringBuilder to append to

wrapRunnable

protected Runnable wrapRunnable(Runnable command)

unwrap

protected Runnable unwrap(Runnable runnable)

getPoolWaitTimeNanos

public long getPoolWaitTimeNanos()

Returns the cumulative wait time of the ThreadPool. If the ThreadPool does not support tracking the cumulative pool wait time then this should return -1 which will prevent the value from showing up in ThreadPoolStats. ThreadPools that do support this metric should override this method. For example, QueueResizingOpenSearchThreadPoolExecutor does so using the TimedRunnable to get the difference between Runnable creation and execution.