Package org.elasticsearch.cluster

Class InternalClusterInfoService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.cluster.InternalClusterInfoService

All Implemented Interfaces:

ClusterInfoService, ClusterStateListener, LocalNodeMasterListener

public class InternalClusterInfoService
extends AbstractComponent
implements ClusterInfoService, LocalNodeMasterListener, ClusterStateListener

InternalClusterInfoService provides the ClusterInfoService interface, routinely updated on a timer. The timer can be dynamically changed by setting the cluster.info.update.interval setting (defaulting to 30 seconds). The InternalClusterInfoService only runs on the master node. Listens for changes in the number of data nodes and immediately submits a ClusterInfoUpdateJob if a node has been added. Every time the timer runs, gathers information about the disk usage and shard sizes across the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	InternalClusterInfoService.SubmitReschedulingClusterInfoUpdatedJob	Class used to submit maybeRefresh() on the InternalClusterInfoService threadpool, these jobs will reschedule themselves by placing a new instance of this class onto the scheduled threadpool.

Field Summary

Fields

Modifier and Type	Field	Description
static Setting<TimeValue>	INTERNAL_CLUSTER_INFO_TIMEOUT_SETTING
static Setting<TimeValue>	INTERNAL_CLUSTER_INFO_UPDATE_INTERVAL_SETTING

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor	Description
InternalClusterInfoService(Settings settings, ClusterService clusterService, ThreadPool threadPool, NodeClient client, java.util.function.Consumer<ClusterInfo> listener)

Method Summary

Modifier and Type	Method	Description
void	clusterChanged(ClusterChangedEvent event)	Called when cluster state changes.
java.lang.String	executorName()	The name of the executor that the implementation of the callbacks of this lister should be executed on.
ClusterInfo	getClusterInfo()	The latest cluster information
void	offMaster()	Called when the local node used to be the master, a new master was elected and it's no longer the local node.
void	onMaster()	Called when local node is elected to be the master
ClusterInfo	refresh()	Refreshes the ClusterInfo in a blocking fashion
protected java.util.concurrent.CountDownLatch	updateIndicesStats(ActionListener<IndicesStatsResponse> listener)	Retrieve the latest indices stats, calling the listener when complete
protected java.util.concurrent.CountDownLatch	updateNodeStats(ActionListener<NodesStatsResponse> listener)	Retrieve the latest nodes stats, calling the listener when complete

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

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

INTERNAL_CLUSTER_INFO_UPDATE_INTERVAL_SETTING

public static final Setting<TimeValue> INTERNAL_CLUSTER_INFO_UPDATE_INTERVAL_SETTING

INTERNAL_CLUSTER_INFO_TIMEOUT_SETTING

public static final Setting<TimeValue> INTERNAL_CLUSTER_INFO_TIMEOUT_SETTING

Constructor Detail

InternalClusterInfoService

public InternalClusterInfoService(Settings settings,
                                  ClusterService clusterService,
                                  ThreadPool threadPool,
                                  NodeClient client,
                                  java.util.function.Consumer<ClusterInfo> listener)

Method Detail

onMaster

public void onMaster()

Description copied from interface: LocalNodeMasterListener

Called when local node is elected to be the master

Specified by:

onMaster in interface LocalNodeMasterListener

offMaster

public void offMaster()

Description copied from interface: LocalNodeMasterListener

Called when the local node used to be the master, a new master was elected and it's no longer the local node.

Specified by:

offMaster in interface LocalNodeMasterListener

executorName

public java.lang.String executorName()

Description copied from interface: LocalNodeMasterListener

The name of the executor that the implementation of the callbacks of this lister should be executed on. The thread that is responsible for managing instances of this lister is the same thread handling the cluster state events. If the work done is the callbacks above is inexpensive, this value may be SAME (indicating that the callbacks will run on the same thread as the cluster state events are fired with). On the other hand, if the logic in the callbacks are heavier and take longer to process (or perhaps involve blocking due to IO operations), prefer to execute them on a separate more appropriate executor (eg. GENERIC or MANAGEMENT).

Specified by:

executorName in interface LocalNodeMasterListener

Returns:

The name of the executor that will run the callbacks of this listener.

clusterChanged

public void clusterChanged(ClusterChangedEvent event)

Description copied from interface: ClusterStateListener

Called when cluster state changes.

Specified by:

clusterChanged in interface ClusterStateListener

getClusterInfo

public ClusterInfo getClusterInfo()

Description copied from interface: ClusterInfoService

The latest cluster information

Specified by:

getClusterInfo in interface ClusterInfoService

updateNodeStats

protected java.util.concurrent.CountDownLatch updateNodeStats(ActionListener<NodesStatsResponse> listener)

Retrieve the latest nodes stats, calling the listener when complete

Returns:

a latch that can be used to wait for the nodes stats to complete if desired

updateIndicesStats

protected java.util.concurrent.CountDownLatch updateIndicesStats(ActionListener<IndicesStatsResponse> listener)

Retrieve the latest indices stats, calling the listener when complete

Returns:

a latch that can be used to wait for the indices stats to complete if desired

refresh

public final ClusterInfo refresh()

Refreshes the ClusterInfo in a blocking fashion