c

akka.cluster.metrics

NodeMetrics

final case class NodeMetrics(address: Address, timestamp: Long, metrics: Set[Metric] = Set.empty[Metric]) extends Product with Serializable

The snapshot of current sampled health metrics for any monitored process. Collected and gossipped at regular intervals for dynamic cluster management strategies.

Equality of NodeMetrics is based on its address.

address

akka.actor.Address of the node the metrics are gathered at

timestamp

the time of sampling, in milliseconds since midnight, January 1, 1970 UTC

metrics

the set of sampled akka.cluster.metrics.Metric

Annotations
@SerialVersionUID()
Source
Metric.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NodeMetrics
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. 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 NodeMetrics(address: Address, timestamp: Long, metrics: Set[Metric] = Set.empty[Metric])

    address

    akka.actor.Address of the node the metrics are gathered at

    timestamp

    the time of sampling, in milliseconds since midnight, January 1, 1970 UTC

    metrics

    the set of sampled akka.cluster.metrics.Metric

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 NodeMetrics toany2stringadd[NodeMetrics] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (NodeMetrics, B)
    Implicit
    This member is added by an implicit conversion from NodeMetrics toArrowAssoc[NodeMetrics] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val address: Address
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def ensuring(cond: (NodeMetrics) => Boolean, msg: => Any): NodeMetrics
    Implicit
    This member is added by an implicit conversion from NodeMetrics toEnsuring[NodeMetrics] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (NodeMetrics) => Boolean): NodeMetrics
    Implicit
    This member is added by an implicit conversion from NodeMetrics toEnsuring[NodeMetrics] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): NodeMetrics
    Implicit
    This member is added by an implicit conversion from NodeMetrics toEnsuring[NodeMetrics] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): NodeMetrics
    Implicit
    This member is added by an implicit conversion from NodeMetrics toEnsuring[NodeMetrics] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(obj: Any): Boolean
    Definition Classes
    NodeMetrics → Equals → AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def getMetrics: Iterable[Metric]

    Java API

    Java API

    Annotations
    @nowarn()
  17. def hashCode(): Int
    Definition Classes
    NodeMetrics → AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def merge(that: NodeMetrics): NodeMetrics

    Returns the most recent data.

  20. def metric(key: String): Option[Metric]
  21. val metrics: Set[Metric]
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. def sameAs(that: NodeMetrics): Boolean

    Returns true if that address is the same as this

  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. val timestamp: Long
  29. def update(that: NodeMetrics): NodeMetrics

    Returns the most recent data with EWMA averaging.

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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from NodeMetrics toStringFormat[NodeMetrics] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (NodeMetrics, B)
    Implicit
    This member is added by an implicit conversion from NodeMetrics toArrowAssoc[NodeMetrics] 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromNodeMetrics to any2stringadd[NodeMetrics]

Inherited by implicit conversion StringFormat fromNodeMetrics to StringFormat[NodeMetrics]

Inherited by implicit conversion Ensuring fromNodeMetrics to Ensuring[NodeMetrics]

Inherited by implicit conversion ArrowAssoc fromNodeMetrics to ArrowAssoc[NodeMetrics]

Ungrouped