class ClusterMetricsExtension extends Extension

Cluster metrics extension.

Cluster metrics is primarily for load-balancing of nodes. It controls metrics sampling at a regular frequency, prepares highly variable data for further analysis by other entities, and publishes the latest cluster metrics data around the node ring and local eventStream to assist in determining the need to redirect traffic to the least-loaded nodes.

Metrics sampling is delegated to the MetricsCollector.

Smoothing of the data for each monitored process is delegated to the EWMA for exponential weighted moving average.

Source
ClusterMetricsExtension.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterMetricsExtension
  2. Extension
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ClusterMetricsExtension(system: ExtendedActorSystem)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ClusterMetricsExtension toany2stringadd[ClusterMetricsExtension] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ClusterMetricsExtension, B)
    Implicit
    This member is added by an implicit conversion from ClusterMetricsExtension toArrowAssoc[ClusterMetricsExtension] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (ClusterMetricsExtension) => Boolean, msg: => Any): ClusterMetricsExtension
    Implicit
    This member is added by an implicit conversion from ClusterMetricsExtension toEnsuring[ClusterMetricsExtension] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ClusterMetricsExtension) => Boolean): ClusterMetricsExtension
    Implicit
    This member is added by an implicit conversion from ClusterMetricsExtension toEnsuring[ClusterMetricsExtension] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ClusterMetricsExtension
    Implicit
    This member is added by an implicit conversion from ClusterMetricsExtension toEnsuring[ClusterMetricsExtension] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ClusterMetricsExtension
    Implicit
    This member is added by an implicit conversion from ClusterMetricsExtension toEnsuring[ClusterMetricsExtension] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ClusterMetricsExtension toStringFormat[ClusterMetricsExtension] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. val settings: ClusterMetricsSettings

    Metrics extension configuration.

  22. def subscribe(metricsListener: ActorRef): Unit

    Subscribe user metrics listener actor unto ClusterMetricsEvent events published by extension on the system event bus.

  23. val supervisor: ActorRef

    Supervisor actor.

    Supervisor actor. Accepts subtypes of CollectionControlMessages to manage metrics collection at runtime.

  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. def unsubscribe(metricsListenter: ActorRef): Unit

    Unsubscribe user metrics listener actor from ClusterMetricsEvent events published by extension on the system event bus.

  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (ClusterMetricsExtension, B)
    Implicit
    This member is added by an implicit conversion from ClusterMetricsExtension toArrowAssoc[ClusterMetricsExtension] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromClusterMetricsExtension to any2stringadd[ClusterMetricsExtension]

Inherited by implicit conversion StringFormat fromClusterMetricsExtension to StringFormat[ClusterMetricsExtension]

Inherited by implicit conversion Ensuring fromClusterMetricsExtension to Ensuring[ClusterMetricsExtension]

Inherited by implicit conversion ArrowAssoc fromClusterMetricsExtension to ArrowAssoc[ClusterMetricsExtension]

Ungrouped