Module org.elasticsearch.server
Class BalancedShardsAllocator
java.lang.Object
org.elasticsearch.cluster.routing.allocation.allocator.BalancedShardsAllocator
- All Implemented Interfaces:
ShardsAllocator
The
BalancedShardsAllocator allocates and balances shards on the cluster nodes using BalancedShardsAllocator.WeightFunction.
The balancing attempts to:
- even shard count across nodes (weighted by cluster.routing.allocation.balance.shard)
- spread shards of the same index across different nodes (weighted by cluster.routing.allocation.balance.index)
- even write load of the data streams write indices across nodes (weighted by cluster.routing.allocation.balance.write_load)
- even disk usage across nodes (weighted by cluster.routing.allocation.balance.disk_usage)
AllocationDeciders when allocating and balancing shards.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class -
Field Summary
FieldsModifier and TypeFieldDescription -
Constructor Summary
ConstructorsConstructorDescriptionBalancedShardsAllocator(ClusterSettings clusterSettings) BalancedShardsAllocator(ClusterSettings clusterSettings, WriteLoadForecaster writeLoadForecaster) BalancedShardsAllocator(Settings settings) -
Method Summary
Modifier and TypeMethodDescriptionvoidallocate(RoutingAllocation allocation) Allocates shards to nodes in the cluster.decideShardAllocation(ShardRouting shard, RoutingAllocation allocation) Returns the decision for where a shard should reside in the cluster.floatReturns the index related weight factor.floatReturns the shard related weight factor.floatReturns the currently configured delta thresholdMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.cluster.routing.allocation.allocator.ShardsAllocator
allocate, execute
-
Field Details
-
SHARD_BALANCE_FACTOR_SETTING
-
INDEX_BALANCE_FACTOR_SETTING
-
WRITE_LOAD_BALANCE_FACTOR_SETTING
-
DISK_USAGE_BALANCE_FACTOR_SETTING
-
THRESHOLD_SETTING
-
-
Constructor Details
-
BalancedShardsAllocator
public BalancedShardsAllocator() -
BalancedShardsAllocator
-
BalancedShardsAllocator
-
BalancedShardsAllocator
@Inject public BalancedShardsAllocator(ClusterSettings clusterSettings, WriteLoadForecaster writeLoadForecaster)
-
-
Method Details
-
allocate
Description copied from interface:ShardsAllocatorAllocates shards to nodes in the cluster. An implementation of this method should: - assign unassigned shards - relocate shards that cannot stay on a node anymore - relocate shards to find a good shard balance in the cluster- Specified by:
allocatein interfaceShardsAllocator- Parameters:
allocation- current node allocation
-
decideShardAllocation
public ShardAllocationDecision decideShardAllocation(ShardRouting shard, RoutingAllocation allocation) Description copied from interface:ShardsAllocatorReturns the decision for where a shard should reside in the cluster. If the shard is unassigned, then theAllocateUnassignedDecisionwill be non-null. If the shard is not in the unassigned state, then theMoveDecisionwill be non-null. This method is primarily used by the cluster allocation explain API to provide detailed explanations for the allocation of a single shard. Implementations of theShardsAllocator.allocate(RoutingAllocation)method may use the results of this method implementation to decide on allocating shards in the routing table to the cluster. If an implementation of this interface does not support explaining decisions for a single shard through the cluster explain API, then this method should throw aUnsupportedOperationException.- Specified by:
decideShardAllocationin interfaceShardsAllocator
-
getThreshold
public float getThreshold()Returns the currently configured delta threshold -
getIndexBalance
public float getIndexBalance()Returns the index related weight factor. -
getShardBalance
public float getShardBalance()Returns the shard related weight factor.
-