Package org.opensearch.cluster.routing.allocation.decider

Class ThrottlingAllocationDecider

java.lang.Object

org.opensearch.cluster.routing.allocation.decider.AllocationDecider

org.opensearch.cluster.routing.allocation.decider.ThrottlingAllocationDecider

public class ThrottlingAllocationDecider
extends AllocationDecider

ThrottlingAllocationDecider controls the recovery process per node in the cluster. It exposes two settings via the cluster update API that allow changes in real-time:

• cluster.routing.allocation.node_initial_primaries_recoveries - restricts the number of initial primary shard recovery operations on a single node. The default is 4
• cluster.routing.allocation.node_concurrent_recoveries - restricts the number of total concurrent shards initializing on a single node. The default is 2. Please note that this limit excludes the initial primaries recovery operations per node.

If one of the above thresholds is exceeded per node this allocation decider will return Decision.THROTTLE as a hit to upstream logic to throttle the allocation process to prevent overloading nodes due to too many concurrent recovery processes.

Field Summary

Fields

Modifier and Type	Field	Description
static Setting<java.lang.Integer>	CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_INCOMING_RECOVERIES_SETTING
static Setting<java.lang.Integer>	CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_OUTGOING_RECOVERIES_SETTING
static Setting<java.lang.Integer>	CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_RECOVERIES_SETTING
static Setting<java.lang.Integer>	CLUSTER_ROUTING_ALLOCATION_NODE_INITIAL_PRIMARIES_RECOVERIES_SETTING
static Setting<java.lang.Integer>	CLUSTER_ROUTING_ALLOCATION_NODE_INITIAL_REPLICAS_RECOVERIES_SETTING
static int	DEFAULT_CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_RECOVERIES
static int	DEFAULT_CLUSTER_ROUTING_ALLOCATION_NODE_INITIAL_RECOVERIES
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor	Description
ThrottlingAllocationDecider(Settings settings, ClusterSettings clusterSettings)

Method Summary

Modifier and Type	Method	Description
Decision	canAllocate(ShardRouting shardRouting, RoutingNode node, RoutingAllocation allocation)	Returns a Decision whether the given shard routing can be allocated on the given node.
Decision	canAllocateAnyShardToNode(RoutingNode node, RoutingAllocation allocation)	Returns a Decision whether any shard on the given RoutingNode} can be allocated The default is Decision.ALWAYS.
Decision	canMoveAway(ShardRouting shardRouting, RoutingAllocation allocation)	Returns a Decision whether the given shard can be moved away from the current node RoutingAllocation.

Methods inherited from class org.opensearch.cluster.routing.allocation.decider.AllocationDecider

canAllocate, canAllocate, canForceAllocatePrimary, canMoveAnyShard, canRebalance, canRebalance, canRemain, shouldAutoExpandToNode

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_RECOVERIES

public static final int DEFAULT_CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_RECOVERIES

See Also:

Constant Field Values

DEFAULT_CLUSTER_ROUTING_ALLOCATION_NODE_INITIAL_RECOVERIES

public static final int DEFAULT_CLUSTER_ROUTING_ALLOCATION_NODE_INITIAL_RECOVERIES

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_RECOVERIES_SETTING

public static final Setting<java.lang.Integer> CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_RECOVERIES_SETTING

CLUSTER_ROUTING_ALLOCATION_NODE_INITIAL_PRIMARIES_RECOVERIES_SETTING

public static final Setting<java.lang.Integer> CLUSTER_ROUTING_ALLOCATION_NODE_INITIAL_PRIMARIES_RECOVERIES_SETTING

CLUSTER_ROUTING_ALLOCATION_NODE_INITIAL_REPLICAS_RECOVERIES_SETTING

public static final Setting<java.lang.Integer> CLUSTER_ROUTING_ALLOCATION_NODE_INITIAL_REPLICAS_RECOVERIES_SETTING

CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_INCOMING_RECOVERIES_SETTING

public static final Setting<java.lang.Integer> CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_INCOMING_RECOVERIES_SETTING

CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_OUTGOING_RECOVERIES_SETTING

public static final Setting<java.lang.Integer> CLUSTER_ROUTING_ALLOCATION_NODE_CONCURRENT_OUTGOING_RECOVERIES_SETTING

Constructor Details

ThrottlingAllocationDecider

public ThrottlingAllocationDecider(Settings settings, ClusterSettings clusterSettings)

Method Details

canAllocate

public Decision canAllocate(ShardRouting shardRouting, RoutingNode node, RoutingAllocation allocation)

Description copied from class: AllocationDecider

Returns a Decision whether the given shard routing can be allocated on the given node. The default is Decision.ALWAYS.

Overrides:

canAllocate in class AllocationDecider

canMoveAway

public Decision canMoveAway(ShardRouting shardRouting, RoutingAllocation allocation)

Description copied from class: AllocationDecider

Returns a Decision whether the given shard can be moved away from the current node RoutingAllocation. The default is Decision.ALWAYS.

Overrides:

canMoveAway in class AllocationDecider

canAllocateAnyShardToNode

public Decision canAllocateAnyShardToNode(RoutingNode node, RoutingAllocation allocation)

Description copied from class: AllocationDecider

Returns a Decision whether any shard on the given RoutingNode} can be allocated The default is Decision.ALWAYS. All implementations that override this behaviour must take a Decision} whether or not to skip iterating over the remaining deciders for this node.

Overrides:

canAllocateAnyShardToNode in class AllocationDecider