Module org.elasticsearch.server
Package org.elasticsearch.cluster.routing.allocation

Class RoutingAllocation

java.lang.Object
org.elasticsearch.cluster.routing.allocation.RoutingAllocation
public abstract sealed class RoutingAllocation extends Object
The RoutingAllocation keep the state of the current allocation of shards and holds the AllocationDeciders which are responsible for the current routing state.

  • Field Details

  • 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

      @Deprecated public RoutingTable routingTable()
      Deprecated.
      Get routing table of current nodes
      Returns:
      current routing table

    • globalRoutingTable

      public GlobalRoutingTable globalRoutingTable()

    • routingTable

      public RoutingTable routingTable(ProjectId projectId)

    • 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

    • getClusterState

      public ClusterState getClusterState()

    • clusterInfo

      public ClusterInfo clusterInfo()

    • snapshotShardSizeInfo

      public SnapshotShardSizeInfo snapshotShardSizeInfo()

    • desiredNodes

      @Nullable public DesiredNodes desiredNodes()

    • replacementTargetShutdowns

      public Map<String,SingleNodeShutdownMetadata> replacementTargetShutdowns()
      Returns a map of target node name to replacement shutdown

    • ignoreDisable

      public abstract void ignoreDisable(boolean ignoreDisable)

    • ignoreDisable

      public abstract 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, String nodeId)

    • shouldIgnoreShardForNode

      public boolean shouldIgnoreShardForNode(ShardId shardId, 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 Set<String> getIgnoreNodes(ShardId shardId)

    • removeAllocationId

      public abstract void removeAllocationId(ShardRouting shardRouting)
      Remove the allocation id of the provided shard from the set of in-sync shard copies

    • changes

      public abstract RoutingChangesObserver changes()
      Returns observer to use for changes made to the routing nodes

    • updateMetadataWithRoutingChanges

      public abstract Metadata updateMetadataWithRoutingChanges(GlobalRoutingTable newRoutingTable)
      Returns updated Metadata based on the changes that were made to the routing nodes

    • updateRestoreInfoWithRoutingChanges

      public abstract RestoreInProgress updateRestoreInfoWithRoutingChanges(RestoreInProgress restoreInProgress)
      Returns updated RestoreInProgress based on the changes that were made to the routing nodes

    • routingNodesChanged

      public abstract boolean routingNodesChanged()
      Returns true iff changes were made to the routing nodes

    • decision

      public Decision decision(Decision decision, String deciderLabel, String reason, Object... params)
      Create a routing decision, including the reason if the debug flag is turned on. This is useful to avoid constructing a new Decision instance directly in the common case on the hot path where the explanation isn't needed and thus it's best to avoid allocating a new object.
      Parameters:
      decision - decision whether to allow/deny allocation, typically a global constant such as Decision.YES, Decision.NO etc. to avoid unnecessary allocations.
      deciderLabel - a human-readable label for the AllocationDecider
      reason - a format string explanation of the decision
      params - format string parameters. Note that these parameters are all evaluated before this method checks debugDecision and therefore they must be cheap to compute and ideally involve no extra allocations. To construct an explanation message with an expensive-to-compute parameter, check debugDecision() yourself first to ensure the computation is needed.

    • 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.

    • unaccountedSearchableSnapshotSize

      public long unaccountedSearchableSnapshotSize(RoutingNode routingNode)
      Returns an approximation of the size (in bytes) of the unaccounted searchable snapshots before the allocation

    • isSimulating

      public abstract boolean isSimulating()
      Returns:
      true if this allocation computation is trying to simulate the final allocation and therefore "transient" allocation blockers should be ignored.

    • isReconciling

      public abstract boolean isReconciling()
      Returns:
      true if this allocation computation is trying to reconcile towards a previously-computed allocation and therefore path-dependent allocation blockers should be ignored.

    • withReconcilingFlag

      public abstract Releasable withReconcilingFlag()
      Set the isReconciling() flag, and return a Releasable which clears it again.

    • setSimulatedClusterInfo

      public abstract void setSimulatedClusterInfo(ClusterInfo clusterInfo)

    • immutableClone

      public RoutingAllocation immutableClone()

    • mutableCloneForSimulation

      public RoutingAllocation mutableCloneForSimulation()

    • immutable

      @Deprecated public static RoutingAllocation immutable(AllocationDeciders deciders, ClusterState clusterState, ClusterInfo clusterInfo, SnapshotShardSizeInfo shardSizeInfo, long currentNanoTime)
      Deprecated.
      Create an immutable routing allocation

      Use of this is only to support legacy applications