class LeastShardAllocationStrategy extends AbstractLeastShardAllocationStrategy with Serializable
Use akka.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 the ShardRegion 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 the rebalanceThreshold 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 and rebalanceThreshold=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()
- Source
- ShardCoordinator.scala
- Alphabetic
- By Inheritance
- LeastShardAllocationStrategy
- Serializable
- AbstractLeastShardAllocationStrategy
- ClusterShardAllocationMixin
- ActorSystemDependentAllocationStrategy
- ShardAllocationStrategy
- NoSerializationVerificationNeeded
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from LeastShardAllocationStrategy toany2stringadd[LeastShardAllocationStrategy] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (LeastShardAllocationStrategy, B)
- Implicit
- This member is added by an implicit conversion from LeastShardAllocationStrategy toArrowAssoc[LeastShardAllocationStrategy] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def allocateShard(requester: ActorRef, shardId: ShardId, currentShardAllocations: Map[ActorRef, IndexedSeq[ShardId]]): Future[ActorRef]
Invoked when the location of a new shard is to be decided.
Invoked when the location of a new shard is to be decided.
- requester
actor reference to the ShardRegion that requested the location of the shard, can be returned if preference should be given to the node where the shard was first accessed
- shardId
the id of the shard to allocate
- currentShardAllocations
all actor refs to
ShardRegionand their current allocated shards, in the order they were allocated- returns
a
Futureof the actor ref of the ShardRegion that is to be responsible for the shard, must be one of the references included in thecurrentShardAllocationsparameter
- Definition Classes
- AbstractLeastShardAllocationStrategy → ShardAllocationStrategy
- 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()
- def clusterState: CurrentClusterState
- Attributes
- protected
- Definition Classes
- AbstractLeastShardAllocationStrategy → ClusterShardAllocationMixin
- def ensuring(cond: (LeastShardAllocationStrategy) => Boolean, msg: => Any): LeastShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from LeastShardAllocationStrategy toEnsuring[LeastShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (LeastShardAllocationStrategy) => Boolean): LeastShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from LeastShardAllocationStrategy toEnsuring[LeastShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): LeastShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from LeastShardAllocationStrategy toEnsuring[LeastShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): LeastShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from LeastShardAllocationStrategy toEnsuring[LeastShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- 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 isAGoodTimeToRebalance(regionEntries: Iterable[RegionEntry]): Boolean
- Attributes
- protected
- Definition Classes
- ClusterShardAllocationMixin
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def mostSuitableRegion(regionEntries: Iterable[RegionEntry]): (ActorRef, IndexedSeq[ShardId])
- Attributes
- protected
- Definition Classes
- AbstractLeastShardAllocationStrategy
- 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()
- def rebalance(currentShardAllocations: Map[ActorRef, IndexedSeq[ShardId]], rebalanceInProgress: Set[ShardId]): Future[Set[ShardId]]
Invoked periodically to decide which shards to rebalance to another location.
Invoked periodically to decide which shards to rebalance to another location.
- currentShardAllocations
all actor refs to
ShardRegionand their current allocated shards, in the order they were allocated- rebalanceInProgress
set of shards that are currently being rebalanced, i.e. you should not include these in the returned set
- returns
a
Futureof the shards to be migrated, may be empty to skip rebalance in this round
- Definition Classes
- LeastShardAllocationStrategy → ShardAllocationStrategy
- final def regionEntriesFor(currentShardAllocations: AllocationMap): Iterable[RegionEntry]
- Attributes
- protected
- Definition Classes
- ClusterShardAllocationMixin
- def selfMember: Member
- Attributes
- protected
- Definition Classes
- AbstractLeastShardAllocationStrategy → ClusterShardAllocationMixin
- def start(system: ActorSystem): Unit
Called before any calls to allocate/rebalance.
Called before any calls to allocate/rebalance. Do not block. If asynchronous actions are required they can be started here and delay the Futures returned by allocate/rebalance.
- Definition Classes
- AbstractLeastShardAllocationStrategy → ActorSystemDependentAllocationStrategy
- 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])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from LeastShardAllocationStrategy toStringFormat[LeastShardAllocationStrategy] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (LeastShardAllocationStrategy, B)
- Implicit
- This member is added by an implicit conversion from LeastShardAllocationStrategy toArrowAssoc[LeastShardAllocationStrategy] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.