akka.akka-cluster-sharding_2.12.0-M1.2.4-M2.source-code.reference.conf Maven / Gradle / Ivy

Go to download
###############################################
# Akka Cluster Sharding Reference Config File #
###############################################

# This is the reference config file that contains all the default settings.
# Make your edits/overrides in your application.conf.


# //#sharding-ext-config
# Settings for the ClusterShardingExtension
akka.cluster.sharding {

  # The extension creates a top level actor with this name in top level user scope,
  # e.g. '/user/sharding'
  guardian-name = sharding
  
  # Specifies that entities runs on cluster nodes with a specific role.
  # If the role is not specified (or empty) all nodes in the cluster are used.
  role = ""
  
  # When this is set to 'on' the active entity actors will automatically be restarted
  # upon Shard restart. i.e. if the Shard is started on a different ShardRegion
  # due to rebalance or crash.
  remember-entities = off
  
  # If the coordinator can't store state changes it will be stopped
  # and started again after this duration, with an exponential back-off
  # of up to 5 times this duration.
  coordinator-failure-backoff = 5 s
  
  # The ShardRegion retries registration and shard location requests to the
  # ShardCoordinator with this interval if it does not reply.
  retry-interval = 2 s
  
  # Maximum number of messages that are buffered by a ShardRegion actor.
  buffer-size = 100000
  
  # Timeout of the shard rebalancing process.
  handoff-timeout = 60 s
  
  # Time given to a region to acknowledge it's hosting a shard.
  shard-start-timeout = 10 s
  
  # If the shard is remembering entities and can't store state changes
  # will be stopped and then started again after this duration. Any messages
  # sent to an affected entity may be lost in this process.
  shard-failure-backoff = 10 s
  
  # If the shard is remembering entities and an entity stops itself without
  # using passivate. The entity will be restarted after this duration or when
  # the next message for it is received, which ever occurs first.
  entity-restart-backoff = 10 s
  
  # Rebalance check is performed periodically with this interval.
  rebalance-interval = 10 s
  
  # Absolute path to the journal plugin configuration entity that is to be
  # used for the internal persistence of ClusterSharding. If not defined
  # the default journal plugin is used. Note that this is not related to 
  # persistence used by the entity actors.
  journal-plugin-id = ""
  
  # Absolute path to the snapshot plugin configuration entity that is to be
  # used for the internal persistence of ClusterSharding. If not defined
  # the default snapshot plugin is used. Note that this is not related to 
  # persistence used by the entity actors.
  snapshot-plugin-id = ""
  
  # The coordinator saves persistent snapshots after this number of persistent
  # events. Snapshots are used to reduce recovery times. 
  snapshot-after = 1000
  
  # Setting for the default shard allocation strategy
  least-shard-allocation-strategy {
    # Threshold of how large the difference between most and least number of
    # allocated shards must be to begin the rebalancing.
    rebalance-threshold = 10
    
    # The number of ongoing rebalancing processes is limited to this number.
    max-simultaneous-rebalance = 3
  }
  
  # Settings for the coordinator singleton. Same layout as akka.cluster.singleton.  
  coordinator-singleton = ${akka.cluster.singleton}
}
# //#sharding-ext-config