object ShardCoordinator
- Alphabetic
- By Inheritance
- ShardCoordinator
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- abstract class AbstractShardAllocationStrategy extends ShardAllocationStrategy
Java API: Java implementations of custom shard allocation and rebalancing logic used by the ShardCoordinator should extend this abstract class and implement the two methods.
- class LeastShardAllocationStrategy extends AbstractLeastShardAllocationStrategy with Serializable
Use pekko.cluster.sharding.ShardCoordinator.ShardAllocationStrategy.leastShardAllocationStrategy instead.
Use pekko.cluster.sharding.ShardCoordinator.ShardAllocationStrategy.leastShardAllocationStrategy instead. The new rebalance algorithm was included in Akka 2.6.10. It can reach optimal balance in less rebalance rounds (typically 1 or 2 rounds). The amount of shards to rebalance in each round can still be limited to make it progress slower.
This implementation of ShardCoordinator.ShardAllocationStrategy allocates new shards to the
ShardRegion
with least number of previously allocated shards.When a node is removed from the cluster the shards on that node will be started on the remaining nodes, evenly spread on the remaining nodes (by picking regions with least shards).
When a node is added to the cluster the shards on the existing nodes will be rebalanced to the new node. It picks shards for rebalancing from the
ShardRegion
with most number of previously allocated shards. They will then be allocated to theShardRegion
with least number of previously allocated shards, i.e. new members in the cluster. There is a configurable threshold of how large the difference must be to begin the rebalancing. The difference between number of shards in the region with most shards and the region with least shards must be greater than therebalanceThreshold
for the rebalance to occur.A
rebalanceThreshold
of 1 gives the best distribution and therefore typically the best choice. A higher threshold means that more shards can be rebalanced at the same time instead of one-by-one. That has the advantage that the rebalance process can be quicker but has the drawback that the the number of shards (and therefore load) between different nodes may be significantly different. Given the recommendation of using 10x shards than number of nodes andrebalanceThreshold=10
can result in one node hosting ~2 times the number of shards of other nodes. Example: 1000 shards on 100 nodes means 10 shards per node. One node may have 19 shards and others 10 without a rebalance occurring.The number of ongoing rebalancing processes can be limited by
maxSimultaneousRebalance
.During a rolling upgrade (when nodes with multiple application versions are present) allocating to old nodes are avoided.
Not intended for user extension.
- Annotations
- @SerialVersionUID() @DoNotInherit()
- trait ShardAllocationStrategy extends NoSerializationVerificationNeeded
Interface of the pluggable shard allocation and rebalancing logic used by the ShardCoordinator.
Interface of the pluggable shard allocation and rebalancing logic used by the ShardCoordinator.
Java implementations should extend AbstractShardAllocationStrategy.
- trait StartableAllocationStrategy extends ShardAllocationStrategy
Shard allocation strategy where start is called by the shard coordinator before any calls to rebalance or allocate shard.
Shard allocation strategy where start is called by the shard coordinator before any calls to rebalance or allocate shard. This can be used if there is any expensive initialization to be done that you do not want to to in the constructor as it will happen on every node rather than just the node that hosts the ShardCoordinator
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def leastShardAllocationStrategy(absoluteLimit: Int, relativeLimit: Double): ShardAllocationStrategy
Java API:
ShardAllocationStrategy
that allocates new shards to theShardRegion
(node) with least number of previously allocated shards.Java API:
ShardAllocationStrategy
that allocates new shards to theShardRegion
(node) with least number of previously allocated shards.When a node is added to the cluster the shards on the existing nodes will be rebalanced to the new node. The
LeastShardAllocationStrategy
picks shards for rebalancing from theShardRegion
s with most number of previously allocated shards. They will then be allocated to theShardRegion
with least number of previously allocated shards, i.e. new members in the cluster. The amount of shards to rebalance in each round can be limited to make it progress slower since rebalancing too many shards at the same time could result in additional load on the system. For example, causing many Event Sourced entites to be started at the same time.It will not rebalance when there is already an ongoing rebalance in progress.
- absoluteLimit
the maximum number of shards that will be rebalanced in one rebalance round
- relativeLimit
fraction (< 1.0) of total number of (known) shards that will be rebalanced in one rebalance round
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- object ShardAllocationStrategy