Package org.apache.pekko.cluster.metrics

Class AdaptiveLoadBalancingGroup

java.lang.Object
org.apache.pekko.cluster.metrics.AdaptiveLoadBalancingGroup
All Implemented Interfaces:
Serializable, Group, RouterConfig, scala.Equals, scala.Product
public final class AdaptiveLoadBalancingGroup extends Object implements Group, scala.Product, Serializable
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.

param: metricsSelector decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics

param: paths string representation of the actor paths of the routees, messages are sent with pekko.actor.ActorSelection to these paths

param: routerDispatcher dispatcher to use for the router head actor, which handles router management messages

See Also:

  • Constructor Details

    • AdaptiveLoadBalancingGroup

      public AdaptiveLoadBalancingGroup(MetricsSelector metricsSelector, scala.collection.immutable.Iterable<String> paths, String routerDispatcher)

    • AdaptiveLoadBalancingGroup

      public AdaptiveLoadBalancingGroup(com.typesafe.config.Config config, DynamicAccess dynamicAccess)

    • AdaptiveLoadBalancingGroup

      public AdaptiveLoadBalancingGroup(MetricsSelector metricsSelector, Iterable<String> routeesPaths)
      Java API
      Parameters:
      metricsSelector - decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
      routeesPaths - string representation of the actor paths of the routees, messages are sent with pekko.actor.ActorSelection to these paths

  • Method Details

    • $lessinit$greater$default$1

      public static MetricsSelector $lessinit$greater$default$1()

    • $lessinit$greater$default$2

      public static scala.collection.immutable.Iterable<String> $lessinit$greater$default$2()

    • $lessinit$greater$default$3

      public static String $lessinit$greater$default$3()

    • apply

      public static AdaptiveLoadBalancingGroup apply(MetricsSelector metricsSelector, scala.collection.immutable.Iterable<String> paths, String routerDispatcher)

    • apply$default$1

      public static MetricsSelector apply$default$1()

    • apply$default$2

      public static scala.collection.immutable.Iterable<String> apply$default$2()

    • apply$default$3

      public static String apply$default$3()

    • unapply

      public static scala.Option<scala.Tuple3<MetricsSelector,scala.collection.immutable.Iterable<String>,String>> unapply(AdaptiveLoadBalancingGroup x$0)

    • metricsSelector

      public MetricsSelector metricsSelector()

    • paths

      public scala.collection.immutable.Iterable<String> paths()

    • routerDispatcher

      public String routerDispatcher()
      Description copied from interface: RouterConfig
      Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages
      Specified by:
      routerDispatcher in interface RouterConfig

    • paths

      public scala.collection.immutable.Iterable<String> paths(ActorSystem system)
      Specified by:
      paths in interface Group

    • createRouter

      public Router createRouter(ActorSystem system)
      Description copied from interface: RouterConfig
      Create the actual router, responsible for routing messages to routees.

      Specified by:
      createRouter in interface RouterConfig
      Parameters:
      system - the ActorSystem this router belongs to

    • routingLogicController

      public scala.Option<Props> routingLogicController(RoutingLogic routingLogic)
      Description copied from interface: RouterConfig
      Possibility to define an actor for controlling the routing logic from external stimuli (e.g. monitoring metrics). This actor will be a child of the router "head" actor. Management messages not handled by the "head" actor are delegated to this controller actor.
      Specified by:
      routingLogicController in interface RouterConfig

    • withDispatcher

      public AdaptiveLoadBalancingGroup withDispatcher(String dispatcherId)
      Setting the dispatcher to be used for the router head actor, which handles router management messages

    • copy

      public AdaptiveLoadBalancingGroup copy(MetricsSelector metricsSelector, scala.collection.immutable.Iterable<String> paths, String routerDispatcher)

    • copy$default$1

      public MetricsSelector copy$default$1()

    • copy$default$2

      public scala.collection.immutable.Iterable<String> copy$default$2()

    • copy$default$3

      public String copy$default$3()

    • productPrefix

      public String productPrefix()
      Specified by:
      productPrefix in interface scala.Product

    • productArity

      public int productArity()
      Specified by:
      productArity in interface scala.Product

    • productElement

      public Object productElement(int x$1)
      Specified by:
      productElement in interface scala.Product

    • productIterator

      public scala.collection.Iterator<Object> productIterator()
      Specified by:
      productIterator in interface scala.Product

    • canEqual

      public boolean canEqual(Object x$1)
      Specified by:
      canEqual in interface scala.Equals

    • productElementName

      public String productElementName(int x$1)
      Specified by:
      productElementName in interface scala.Product

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object x$1)
      Specified by:
      equals in interface scala.Equals
      Overrides:
      equals in class Object