Package org.elasticsearch.cluster.service

Class MasterService

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.cluster.service.MasterService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable

public class MasterService
extends AbstractLifecycleComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	MasterService.TaskInputs	Represents a set of tasks to be processed together with their executor
protected class	MasterService.TaskOutputs	Output created by executing a set of tasks provided as TaskInputs

Field Summary

Fields

Modifier and Type	Field	Description
protected ClusterStatePublisher	clusterStatePublisher
static java.lang.String	MASTER_UPDATE_THREAD_NAME
protected ThreadPool	threadPool

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Constructor Summary

Constructors

Constructor	Description
MasterService(java.lang.String nodeName, Settings settings, ThreadPool threadPool)

Method Summary

Modifier and Type	Method	Description
static boolean	assertMasterUpdateThread()
static boolean	assertNotMasterUpdateThread(java.lang.String reason)
MasterService.TaskOutputs	calculateTaskOutputs(MasterService.TaskInputs taskInputs, ClusterState previousClusterState, long startTimeNS)
protected PrioritizedEsThreadPoolExecutor	createThreadPoolExecutor()
protected long	currentTimeInNanos()
protected void	doClose()
protected void	doStart()
protected void	doStop()
protected ClusterStateTaskExecutor.ClusterTasksResult<java.lang.Object>	executeTasks(MasterService.TaskInputs taskInputs, long startTimeNS, ClusterState previousClusterState)
TimeValue	getMaxTaskWaitTime()	Returns the maximum wait time for tasks in the queue
java.util.List<org.elasticsearch.cluster.service.MasterService.Batcher.UpdateTask>	getNonFailedTasks(MasterService.TaskInputs taskInputs, ClusterStateTaskExecutor.ClusterTasksResult<java.lang.Object> clusterTasksResult)
ClusterState.Builder	incrementVersion(ClusterState clusterState)
int	numberOfPendingTasks()	Returns the number of currently pending tasks.
protected void	onPublicationFailed(ClusterChangedEvent clusterChangedEvent, MasterService.TaskOutputs taskOutputs, long startTimeNS, java.lang.Exception exception)
protected void	onPublicationSuccess(ClusterChangedEvent clusterChangedEvent, MasterService.TaskOutputs taskOutputs, long startTimeNS)
java.util.List<PendingClusterTask>	pendingTasks()	Returns the tasks that are pending.
protected void	publish(ClusterChangedEvent clusterChangedEvent, MasterService.TaskOutputs taskOutputs, long startTimeNS)
protected void	runTasks(MasterService.TaskInputs taskInputs)
void	setClusterStatePublisher(ClusterStatePublisher publisher)
void	setClusterStateSupplier(java.util.function.Supplier<ClusterState> clusterStateSupplier)
void	setSlowTaskLoggingThreshold(TimeValue slowTaskLoggingThreshold)
<T extends ClusterStateTaskConfig & ClusterStateTaskExecutor<T> & ClusterStateTaskListener> void	submitStateUpdateTask(java.lang.String source, T updateTask)	Submits a cluster state update task; unlike submitStateUpdateTask(String, Object, ClusterStateTaskConfig, ClusterStateTaskExecutor, ClusterStateTaskListener), submitted updates will not be batched.
<T> void	submitStateUpdateTask(java.lang.String source, T task, ClusterStateTaskConfig config, ClusterStateTaskExecutor<T> executor, ClusterStateTaskListener listener)	Submits a cluster state update task; submitted updates will be batched across the same instance of executor.
<T> void	submitStateUpdateTasks(java.lang.String source, java.util.Map<T,ClusterStateTaskListener> tasks, ClusterStateTaskConfig config, ClusterStateTaskExecutor<T> executor)	Submits a batch of cluster state update tasks; submitted updates are guaranteed to be processed together, potentially with more tasks of the same executor.
protected void	warnAboutSlowTaskIfNeeded(TimeValue executionTime, java.lang.String source)

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

MASTER_UPDATE_THREAD_NAME

public static final java.lang.String MASTER_UPDATE_THREAD_NAME

See Also:

Constant Field Values

clusterStatePublisher

protected ClusterStatePublisher clusterStatePublisher

threadPool

protected final ThreadPool threadPool

Constructor Detail

MasterService

public MasterService(java.lang.String nodeName,
                     Settings settings,
                     ThreadPool threadPool)

Method Detail

setSlowTaskLoggingThreshold

public void setSlowTaskLoggingThreshold(TimeValue slowTaskLoggingThreshold)

setClusterStatePublisher

public void setClusterStatePublisher(ClusterStatePublisher publisher)

setClusterStateSupplier

public void setClusterStateSupplier(java.util.function.Supplier<ClusterState> clusterStateSupplier)

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent

createThreadPoolExecutor

protected PrioritizedEsThreadPoolExecutor createThreadPoolExecutor()

doStop

protected void doStop()

Specified by:

doStop in class AbstractLifecycleComponent

doClose

protected void doClose()

Specified by:

doClose in class AbstractLifecycleComponent

assertMasterUpdateThread

public static boolean assertMasterUpdateThread()

assertNotMasterUpdateThread

public static boolean assertNotMasterUpdateThread(java.lang.String reason)

runTasks

protected void runTasks(MasterService.TaskInputs taskInputs)

publish

protected void publish(ClusterChangedEvent clusterChangedEvent,
                       MasterService.TaskOutputs taskOutputs,
                       long startTimeNS)

onPublicationSuccess

protected void onPublicationSuccess(ClusterChangedEvent clusterChangedEvent,
                                    MasterService.TaskOutputs taskOutputs,
                                    long startTimeNS)

onPublicationFailed

protected void onPublicationFailed(ClusterChangedEvent clusterChangedEvent,
                                   MasterService.TaskOutputs taskOutputs,
                                   long startTimeNS,
                                   java.lang.Exception exception)

calculateTaskOutputs

public MasterService.TaskOutputs calculateTaskOutputs(MasterService.TaskInputs taskInputs,
                                                      ClusterState previousClusterState,
                                                      long startTimeNS)

incrementVersion

public ClusterState.Builder incrementVersion(ClusterState clusterState)

submitStateUpdateTask

public <T extends ClusterStateTaskConfig & ClusterStateTaskExecutor<T> & ClusterStateTaskListener> void submitStateUpdateTask(java.lang.String source,
                                                                                                                              T updateTask)

Submits a cluster state update task; unlike submitStateUpdateTask(String, Object, ClusterStateTaskConfig, ClusterStateTaskExecutor, ClusterStateTaskListener), submitted updates will not be batched.

Parameters:

source - the source of the cluster state update task

updateTask - the full context for the cluster state update task

submitStateUpdateTask

public <T> void submitStateUpdateTask(java.lang.String source,
                                      T task,
                                      ClusterStateTaskConfig config,
                                      ClusterStateTaskExecutor<T> executor,
                                      ClusterStateTaskListener listener)

Submits a cluster state update task; submitted updates will be batched across the same instance of executor. The exact batching semantics depend on the underlying implementation but a rough guideline is that if the update task is submitted while there are pending update tasks for the same executor, these update tasks will all be executed on the executor in a single batch

Type Parameters:

T - the type of the cluster state update task state

Parameters:

source - the source of the cluster state update task

task - the state needed for the cluster state update task

config - the cluster state update task configuration

executor - the cluster state update task executor; tasks that share the same executor will be executed batches on this executor

listener - callback after the cluster state update task completes

pendingTasks

public java.util.List<PendingClusterTask> pendingTasks()

Returns the tasks that are pending.

numberOfPendingTasks

public int numberOfPendingTasks()

Returns the number of currently pending tasks.

getMaxTaskWaitTime

public TimeValue getMaxTaskWaitTime()

Returns the maximum wait time for tasks in the queue

Returns:

A zero time value if the queue is empty, otherwise the time value oldest task waiting in the queue

warnAboutSlowTaskIfNeeded

protected void warnAboutSlowTaskIfNeeded(TimeValue executionTime,
                                         java.lang.String source)

executeTasks

protected ClusterStateTaskExecutor.ClusterTasksResult<java.lang.Object> executeTasks(MasterService.TaskInputs taskInputs,
                                                                                     long startTimeNS,
                                                                                     ClusterState previousClusterState)

getNonFailedTasks

public java.util.List<org.elasticsearch.cluster.service.MasterService.Batcher.UpdateTask> getNonFailedTasks(MasterService.TaskInputs taskInputs,
                                                                                                            ClusterStateTaskExecutor.ClusterTasksResult<java.lang.Object> clusterTasksResult)

submitStateUpdateTasks

public <T> void submitStateUpdateTasks(java.lang.String source,
                                       java.util.Map<T,ClusterStateTaskListener> tasks,
                                       ClusterStateTaskConfig config,
                                       ClusterStateTaskExecutor<T> executor)

Submits a batch of cluster state update tasks; submitted updates are guaranteed to be processed together, potentially with more tasks of the same executor.

Type Parameters:

T - the type of the cluster state update task state

Parameters:

source - the source of the cluster state update task

tasks - a map of update tasks and their corresponding listeners

config - the cluster state update task configuration

executor - the cluster state update task executor; tasks that share the same executor will be executed batches on this executor

currentTimeInNanos

protected long currentTimeInNanos()