Package org.elasticsearch.common.util.concurrent

Class EsExecutors

java.lang.Object

org.elasticsearch.common.util.concurrent.EsExecutors

public class EsExecutors
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static ExecutorService	DIRECT_EXECUTOR_SERVICE	ExecutorService that executes submitted tasks on the current thread.
static Setting<Integer>	NODE_PROCESSORS_SETTING	Setting to manually control the number of allocated processors.
static Setting<Integer>	PROCESSORS_SETTING	Setting to manually set the number of available processors.

Method Summary

Modifier and Type	Method	Description
static int	allocatedProcessors(Settings settings)	Returns the number of allocated processors.
static ThreadFactory	daemonThreadFactory(String namePrefix)
static ThreadFactory	daemonThreadFactory(String nodeName, String namePrefix)
static ThreadFactory	daemonThreadFactory(Settings settings, String namePrefix)
static EsThreadPoolExecutor	newAutoQueueFixed(String name, int size, int initialQueueCapacity, int minQueueSize, int maxQueueSize, int frameSize, org.elasticsearch.core.TimeValue targetedResponseTime, ThreadFactory threadFactory, ThreadContext contextHolder)	Return a new executor that will automatically adjust the queue size based on queue throughput.
static EsThreadPoolExecutor	newFixed(String name, int size, int queueCapacity, ThreadFactory threadFactory, ThreadContext contextHolder)
static EsThreadPoolExecutor	newScaling(String name, int min, int max, long keepAliveTime, TimeUnit unit, ThreadFactory threadFactory, ThreadContext contextHolder)
static PrioritizedEsThreadPoolExecutor	newSinglePrioritizing(String name, ThreadFactory threadFactory, ThreadContext contextHolder, ScheduledExecutorService timer, PrioritizedEsThreadPoolExecutor.StarvationWatcher starvationWatcher)
static Throwable	rethrowErrors(Runnable runnable)	Checks if the runnable arose from asynchronous submission of a task to an executor.
static String	threadName(String nodeName, String namePrefix)
static String	threadName(Settings settings, String namePrefix)

Methods inherited from class java.lang.Object

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

Field Details

PROCESSORS_SETTING

public static final Setting<Integer> PROCESSORS_SETTING

Setting to manually set the number of available processors. This setting is used to adjust thread pool sizes per node.

NODE_PROCESSORS_SETTING

public static final Setting<Integer> NODE_PROCESSORS_SETTING

Setting to manually control the number of allocated processors. This setting is used to adjust thread pool sizes per node. The default value is Runtime.availableProcessors() but should be manually controlled if not all processors on the machine are available to Elasticsearch (e.g., because of CPU limits).

DIRECT_EXECUTOR_SERVICE

public static final ExecutorService DIRECT_EXECUTOR_SERVICE

ExecutorService that executes submitted tasks on the current thread. This executor service does not support being shutdown.

Method Details

allocatedProcessors

public static int allocatedProcessors(Settings settings)

Returns the number of allocated processors. Defaults to Runtime.availableProcessors() but can be overridden by passing a Settings instance with the key node.processors set to the desired value.

Parameters:

settings - a Settings instance from which to derive the allocated processors

Returns:

the number of allocated processors

newSinglePrioritizing

public static PrioritizedEsThreadPoolExecutor newSinglePrioritizing(String name,
 ThreadFactory threadFactory,
 ThreadContext contextHolder,
 ScheduledExecutorService timer,
 PrioritizedEsThreadPoolExecutor.StarvationWatcher starvationWatcher)

newScaling

public static EsThreadPoolExecutor newScaling(String name,
 int min,
 int max,
 long keepAliveTime,
 TimeUnit unit,
 ThreadFactory threadFactory,
 ThreadContext contextHolder)

newFixed

public static EsThreadPoolExecutor newFixed(String name,
 int size,
 int queueCapacity,
 ThreadFactory threadFactory,
 ThreadContext contextHolder)

newAutoQueueFixed

public static EsThreadPoolExecutor newAutoQueueFixed(String name,
 int size,
 int initialQueueCapacity,
 int minQueueSize,
 int maxQueueSize,
 int frameSize,
 org.elasticsearch.core.TimeValue targetedResponseTime,
 ThreadFactory threadFactory,
 ThreadContext contextHolder)

Return a new executor that will automatically adjust the queue size based on queue throughput.

Parameters:

size - number of fixed threads to use for executing tasks

initialQueueCapacity - initial size of the executor queue

minQueueSize - minimum queue size that the queue can be adjusted to

maxQueueSize - maximum queue size that the queue can be adjusted to

frameSize - number of tasks during which stats are collected before adjusting queue size

rethrowErrors

public static Throwable rethrowErrors(Runnable runnable)

Checks if the runnable arose from asynchronous submission of a task to an executor. If an uncaught exception was thrown during the execution of this task, we need to inspect this runnable and see if it is an error that should be propagated to the uncaught exception handler.

Parameters:

runnable - the runnable to inspect, should be a RunnableFuture

Returns:

non fatal exception or null if no exception.

threadName

public static String threadName(Settings settings,
 String namePrefix)

threadName

public static String threadName(String nodeName,
 String namePrefix)

daemonThreadFactory

public static ThreadFactory daemonThreadFactory(Settings settings,
 String namePrefix)

daemonThreadFactory

public static ThreadFactory daemonThreadFactory(String nodeName,
 String namePrefix)

daemonThreadFactory

public static ThreadFactory daemonThreadFactory(String namePrefix)