Packages

c

akka.cluster.sharding.ShardCoordinator

LeastShardAllocationStrategy

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
Linear Supertypes
Serializable, AbstractLeastShardAllocationStrategy, ActorSystemDependentAllocationStrategy, ShardAllocationStrategy, NoSerializationVerificationNeeded, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LeastShardAllocationStrategy
  2. Serializable
  3. AbstractLeastShardAllocationStrategy
  4. ActorSystemDependentAllocationStrategy
  5. ShardAllocationStrategy
  6. NoSerializationVerificationNeeded
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LeastShardAllocationStrategy(rebalanceThreshold: Int, maxSimultaneousRebalance: Int)

Value Members

  1. 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 the currentShardAllocations parameter

    Definition Classes
    AbstractLeastShardAllocationStrategy → ShardAllocationStrategy
  2. 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
  3. 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