Package org.elasticsearch.cluster.routing.allocation

Class RoutingAllocation

java.lang.Object

org.elasticsearch.cluster.routing.allocation.RoutingAllocation

public class RoutingAllocation
extends java.lang.Object

The RoutingAllocation keep the state of the current allocation of shards and holds the AllocationDeciders which are responsible for the current routing state.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RoutingAllocation.DebugMode

Constructor Summary

Constructors

Constructor	Description
RoutingAllocation(AllocationDeciders deciders, RoutingNodes routingNodes, ClusterState clusterState, ClusterInfo clusterInfo, SnapshotShardSizeInfo shardSizeInfo, long currentNanoTime)	Creates a new RoutingAllocation

Method Summary

Modifier and Type	Method	Description
void	addIgnoreShardForNode(ShardId shardId, java.lang.String nodeId)
RoutingChangesObserver	changes()	Returns observer to use for changes made to the routing nodes
ClusterInfo	clusterInfo()
<T extends ClusterState.Custom> T	custom(java.lang.String key)
boolean	debugDecision()
void	debugDecision(boolean debug)
AllocationDeciders	deciders()	Get AllocationDeciders used for allocation
Decision	decision(Decision decision, java.lang.String deciderLabel, java.lang.String reason, java.lang.Object... params)	Create a routing decision, including the reason if the debug flag is turned on
long	getCurrentNanoTime()	returns the nano time captured at the beginning of the allocation.
ImmutableOpenMap<java.lang.String,ClusterState.Custom>	getCustoms()
RoutingAllocation.DebugMode	getDebugMode()
java.util.Set<java.lang.String>	getIgnoreNodes(ShardId shardId)
boolean	hasPendingAsyncFetch()	Returns true iff the current allocation run has not processed all of the in-flight or available shard or store fetches.
boolean	ignoreDisable()
void	ignoreDisable(boolean ignoreDisable)
Metadata	metadata()	Get metadata of routing nodes
DiscoveryNodes	nodes()	Get discovery nodes in current routing
void	removeAllocationId(ShardRouting shardRouting)	Remove the allocation id of the provided shard from the set of in-sync shard copies
RoutingNodes	routingNodes()	Get current routing nodes
boolean	routingNodesChanged()	Returns true iff changes were made to the routing nodes
RoutingTable	routingTable()	Get routing table of current nodes
void	setDebugMode(RoutingAllocation.DebugMode debug)
void	setHasPendingAsyncFetch()	Sets a flag that signals that current allocation run has not processed all of the in-flight or available shard or store fetches.
boolean	shouldIgnoreShardForNode(ShardId shardId, java.lang.String nodeId)	Returns whether the given node id should be ignored from consideration when AllocationDeciders is deciding whether to allocate the specified shard id to that node.
SnapshotShardSizeInfo	snapshotShardSizeInfo()
Metadata	updateMetadataWithRoutingChanges(RoutingTable newRoutingTable)	Returns updated Metadata based on the changes that were made to the routing nodes
RestoreInProgress	updateRestoreInfoWithRoutingChanges(RestoreInProgress restoreInProgress)	Returns updated RestoreInProgress based on the changes that were made to the routing nodes

Methods inherited from class java.lang.Object

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

Constructor Details

RoutingAllocation

public RoutingAllocation(AllocationDeciders deciders, RoutingNodes routingNodes, ClusterState clusterState, ClusterInfo clusterInfo, SnapshotShardSizeInfo shardSizeInfo, long currentNanoTime)

Creates a new RoutingAllocation

Parameters:

deciders - AllocationDeciders to used to make decisions for routing allocations

routingNodes - Routing nodes in the current cluster

clusterState - cluster state before rerouting

currentNanoTime - the nano time to use for all delay allocation calculation (typically System.nanoTime())

Method Details

getCurrentNanoTime

public long getCurrentNanoTime()

returns the nano time captured at the beginning of the allocation. used to make sure all time based decisions are aligned

deciders

public AllocationDeciders deciders()

Get AllocationDeciders used for allocation

Returns:

AllocationDeciders used for allocation

routingTable

public RoutingTable routingTable()

Get routing table of current nodes

Returns:

current routing table

routingNodes

public RoutingNodes routingNodes()

Get current routing nodes

Returns:

routing nodes

metadata

public Metadata metadata()

Get metadata of routing nodes

Returns:

Metadata of routing nodes

nodes

public DiscoveryNodes nodes()

Get discovery nodes in current routing

Returns:

discovery nodes

clusterInfo

public ClusterInfo clusterInfo()

snapshotShardSizeInfo

public SnapshotShardSizeInfo snapshotShardSizeInfo()

custom

public <T extends ClusterState.Custom> T custom(java.lang.String key)

getCustoms

public ImmutableOpenMap<java.lang.String,ClusterState.Custom> getCustoms()

ignoreDisable

public void ignoreDisable(boolean ignoreDisable)

ignoreDisable

public boolean ignoreDisable()

setDebugMode

public void setDebugMode(RoutingAllocation.DebugMode debug)

debugDecision

public void debugDecision(boolean debug)

debugDecision

public boolean debugDecision()

getDebugMode

public RoutingAllocation.DebugMode getDebugMode()

addIgnoreShardForNode

public void addIgnoreShardForNode(ShardId shardId, java.lang.String nodeId)

shouldIgnoreShardForNode

public boolean shouldIgnoreShardForNode(ShardId shardId, java.lang.String nodeId)

Returns whether the given node id should be ignored from consideration when AllocationDeciders is deciding whether to allocate the specified shard id to that node. The node will be ignored if the specified shard failed on that node, triggering the current round of allocation. Since the shard just failed on that node, we don't want to try to reassign it there, if the node is still a part of the cluster.

Parameters:

shardId - the shard id to be allocated

nodeId - the node id to check against

Returns:

true if the node id should be ignored in allocation decisions, false otherwise

getIgnoreNodes

public java.util.Set<java.lang.String> getIgnoreNodes(ShardId shardId)

removeAllocationId

public void removeAllocationId(ShardRouting shardRouting)

Remove the allocation id of the provided shard from the set of in-sync shard copies

changes

public RoutingChangesObserver changes()

Returns observer to use for changes made to the routing nodes

updateMetadataWithRoutingChanges

public Metadata updateMetadataWithRoutingChanges(RoutingTable newRoutingTable)

Returns updated Metadata based on the changes that were made to the routing nodes

updateRestoreInfoWithRoutingChanges

public RestoreInProgress updateRestoreInfoWithRoutingChanges(RestoreInProgress restoreInProgress)

Returns updated RestoreInProgress based on the changes that were made to the routing nodes

routingNodesChanged

public boolean routingNodesChanged()

Returns true iff changes were made to the routing nodes

decision

public Decision decision(Decision decision, java.lang.String deciderLabel, java.lang.String reason, java.lang.Object... params)

Create a routing decision, including the reason if the debug flag is turned on

Parameters:

decision - decision whether to allow/deny allocation

deciderLabel - a human readable label for the AllocationDecider

reason - a format string explanation of the decision

params - format string parameters

hasPendingAsyncFetch

public boolean hasPendingAsyncFetch()

Returns true iff the current allocation run has not processed all of the in-flight or available shard or store fetches. Otherwise true

setHasPendingAsyncFetch

public void setHasPendingAsyncFetch()

Sets a flag that signals that current allocation run has not processed all of the in-flight or available shard or store fetches. This state is anti-viral and can be reset in on allocation run.