A router group that performs load balancing of messages to cluster nodes based on cluster metric data.
A router group that performs load balancing of messages to cluster nodes based on cluster metric data.
It uses random selection of routees based on probabilities derived from the remaining capacity of corresponding node.
The configuration parameter trumps the constructor arguments. This means that
if you provide paths
during instantiation they will be ignored if
the router is defined in the configuration file for the actor being used.
decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths
dispatcher to use for the router head actor, which handles router management messages
A router pool that performs load balancing of messages to cluster nodes based on cluster metric data.
A router pool that performs load balancing of messages to cluster nodes based on cluster metric data.
It uses random selection of routees based on probabilities derived from the remaining capacity of corresponding node.
The configuration parameter trumps the constructor arguments. This means that
if you provide nrOfInstances
during instantiation they will be ignored if
the router is defined in the configuration file for the actor being used.
Any routees that are created by a router will be created as the router's children. The router is therefore also the children's supervisor.
The supervision strategy of the router actor can be configured with #withSupervisorStrategy. If no strategy is provided, routers default to a strategy of “always escalate”. This means that errors are passed up to the router's supervisor for handling.
The router's supervisor will treat the error as an error with the router itself. Therefore a directive to stop or restart will cause the router itself to stop or restart. The router, in turn, will cause its children to stop and restart.
decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
initial number of routees in the pool
strategy for supervising the routees, see 'Supervision Setup'
dispatcher to use for the router head actor, which handles supervision, death watch and router management messages
Load balancing of messages to cluster nodes based on cluster metric data.
Load balancing of messages to cluster nodes based on cluster metric data.
It uses random selection of routees based on probabilities derived from the remaining capacity of corresponding node.
the actor system hosting this router
decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
A MetricsSelector producing weights from remaining capacity.
A MetricsSelector producing weights from remaining capacity. The weights are typically proportional to the remaining capacity.
akka.routing.RouterConfig implementation for deployment on cluster nodes.
akka.routing.RouterConfig implementation for deployment on cluster nodes. Delegates other duties to the local akka.routing.RouterConfig, which makes it possible to mix this with the built-in routers such as akka.routing.RoundRobinRouter or custom routers.
totalInstances
of cluster router must be > 0
totalInstances
of cluster router must be > 0
akka.routing.RouterConfig implementation for deployment on cluster nodes.
akka.routing.RouterConfig implementation for deployment on cluster nodes. Delegates other duties to the local akka.routing.RouterConfig, which makes it possible to mix this with the built-in routers such as akka.routing.RoundRobinRouter or custom routers.
totalInstances
of cluster router must be > 0
maxInstancesPerNode
of cluster router must be > 0
maxInstancesPerNode
of cluster router must be 1 when routeesPath is defined
totalInstances
of cluster router must be > 0
maxInstancesPerNode
of cluster router must be > 0
maxInstancesPerNode
of cluster router must be 1 when routeesPath is defined
A MetricsSelector is responsible for producing weights from the node metrics.
A MetricsSelector is responsible for producing weights from the node metrics.
MetricsSelector that combines other selectors and aggregates their capacity values.
MetricsSelector that combines other selectors and aggregates their capacity values. By default it uses [akka.cluster.routing.HeapMetricsSelector], [akka.cluster.routing.CpuMetricsSelector], and [akka.cluster.routing.SystemLoadAverageMetricsSelector]
Base class for MetricsSelector that combines other selectors and aggregates their capacity.
Base class for MetricsSelector that combines other selectors and aggregates their capacity.
A Router that performs load balancing of messages to cluster nodes based on cluster metric data.
A Router that performs load balancing of messages to cluster nodes based on cluster metric data.
It uses random selection of routees based on probabilities derived from the remaining capacity of corresponding node.
Please note that providing both 'nrOfInstances' and 'routees' does not make logical
sense as this means that the router should both create new actors and use the 'routees'
actor(s). In this case the 'nrOfInstances' will be ignored and the 'routees' will be used.
The configuration parameter trumps the constructor arguments. This means that
if you provide either 'nrOfInstances' or 'routees' during instantiation they will
be ignored if the router is defined in the configuration file for the actor being used.
Any routees that are created by a router will be created as the router's children. The router is therefore also the children's supervisor.
The supervision strategy of the router actor can be configured with #withSupervisorStrategy. If no strategy is provided, routers default to a strategy of “always escalate”. This means that errors are passed up to the router's supervisor for handling.
The router's supervisor will treat the error as an error with the router itself. Therefore a directive to stop or restart will cause the router itself to stop or restart. The router, in turn, will cause its children to stop and restart.
decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
string representation of the actor paths of the routees that will be looked up
using actorFor
in akka.actor.ActorRefProvider
(Since version 2.3) Use AdaptiveLoadBalancingPool or AdaptiveLoadBalancingGroup
(Since version 2.3) Use ClusterRouterPool or ClusterRouterGroup
totalInstances
of cluster router must be > 0
maxInstancesPerNode
of cluster router must be > 0
maxInstancesPerNode
of cluster router must be 1 when routeesPath is defined
totalInstances
of cluster router must be > 0
maxInstancesPerNode
of cluster router must be > 0
maxInstancesPerNode
of cluster router must be 1 when routeesPath is defined
(Since version 2.3) Use ClusterRouterPoolSettings or ClusterRouterGroupSettings
MetricsSelector that uses the combined CPU metrics.
MetricsSelector that uses the combined CPU metrics. Combined CPU is sum of User + Sys + Nice + Wait, in percentage. Low cpu capacity => small weight.
MetricsSelector that uses the heap metrics.
MetricsSelector that uses the heap metrics. Low heap capacity => small weight.
Singleton instance of the default MixMetricsSelector, which uses [akka.cluster.routing.HeapMetricsSelector], [akka.cluster.routing.CpuMetricsSelector], and [akka.cluster.routing.SystemLoadAverageMetricsSelector]
Singleton instance of the default MixMetricsSelector, which uses [akka.cluster.routing.HeapMetricsSelector], [akka.cluster.routing.CpuMetricsSelector], and [akka.cluster.routing.SystemLoadAverageMetricsSelector]
MetricsSelector that uses the system load average metrics.
MetricsSelector that uses the system load average metrics. System load average is OS-specific average load on the CPUs in the system, for the past 1 minute. The system is possibly nearing a bottleneck if the system load average is nearing number of cpus/cores. Low load average capacity => small weight.
(Since version 2.3) Use ClusterRouterPoolSettings or ClusterRouterGroupSettings