class LeastShardAllocationStrategy extends ShardAllocationStrategy with Serializable
The default implementation of ShardCoordinator.LeastShardAllocationStrategy
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
.
- Annotations
- @SerialVersionUID()
- Source
- ShardCoordinator.scala
- Alphabetic
- By Inheritance
- LeastShardAllocationStrategy
- Serializable
- Serializable
- ShardAllocationStrategy
- NoSerializationVerificationNeeded
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
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 to any2stringadd[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 to ArrowAssoc[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
ShardRegion
and their current allocated shards, in the order they were allocated- returns
a
Future
of the actor ref of the ShardRegion that is to be responsible for the shard, must be one of the references included in thecurrentShardAllocations
parameter
- Definition Classes
- LeastShardAllocationStrategy → ShardAllocationStrategy
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
ensuring(cond: (LeastShardAllocationStrategy) ⇒ Boolean, msg: ⇒ Any): LeastShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from LeastShardAllocationStrategy to Ensuring[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 to Ensuring[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 to Ensuring[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 to Ensuring[LeastShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from LeastShardAllocationStrategy to StringFormat[LeastShardAllocationStrategy] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
ShardRegion
and 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
Future
of the shards to be migrated, may be empty to skip rebalance in this round
- Definition Classes
- LeastShardAllocationStrategy → ShardAllocationStrategy
-
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( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (LeastShardAllocationStrategy, B)
- Implicit
- This member is added by an implicit conversion from LeastShardAllocationStrategy to ArrowAssoc[LeastShardAllocationStrategy] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc