o

akka.cluster.metrics

StandardMetrics

object StandardMetrics

Definitions of the built-in standard metrics.

The following extractors and data structures makes it easy to consume the NodeMetrics in for example load balancers.

Source
Metric.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StandardMetrics
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Cpu(address: Address, timestamp: Long, systemLoadAverage: Option[Double], cpuCombined: Option[Double], cpuStolen: Option[Double], processors: Int) extends Product with Serializable

    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

    systemLoadAverage

    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.

    cpuCombined

    combined CPU sum of User + Sys + Nice + Wait, in percentage ([0.0 - 1.0]. This metric can describe the amount of time the CPU spent executing code during n-interval and how much more it could theoretically.

    cpuStolen

    stolen CPU time, in percentage ([0.0 - 1.0].

    processors

    the number of available processors

    Annotations
    @SerialVersionUID()
  2. final case class HeapMemory(address: Address, timestamp: Long, used: Long, committed: Long, max: Option[Long]) extends Product with Serializable

    The amount of used and committed memory will always be <= max if max is defined.

    The amount of used and committed memory will always be <= max if max is defined. A memory allocation may fail if it attempts to increase the used memory such that used > committed even if used <= max is true (e.g. when the system virtual memory is low).

    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

    used

    the current sum of heap memory used from all heap memory pools (in bytes)

    committed

    the current sum of heap memory guaranteed to be available to the JVM from all heap memory pools (in bytes). Committed will always be greater than or equal to used.

    max

    the maximum amount of memory (in bytes) that can be used for JVM memory management. Can be undefined on some OS.

    Annotations
    @SerialVersionUID()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final val CpuCombined: String("cpu-combined")

    Sum of User + Sys + Nice + Wait.

    Sum of User + Sys + Nice + Wait. See org.hyperic.sigar.CpuPerc

  5. final val CpuIdle: String("cpu-idle")

    Amount of CPU time left after combined and stolen are removed.

  6. final val CpuStolen: String("cpu-stolen")

    The amount of CPU 'stolen' from this virtual machine by the hypervisor for other tasks (such as running another virtual machine).

  7. final val HeapMemoryCommitted: String("heap-memory-committed")
  8. final val HeapMemoryMax: String("heap-memory-max")
  9. final val HeapMemoryUsed: String("heap-memory-used")
  10. final val Processors: String("processors")
  11. final val SystemLoadAverage: String("system-load-average")
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def extractCpu(nodeMetrics: NodeMetrics): Cpu

    Java API to extract Cpu data from nodeMetrics, if the nodeMetrics contains necessary cpu metrics, otherwise it returns null.

  17. def extractHeapMemory(nodeMetrics: NodeMetrics): HeapMemory

    Java API to extract HeapMemory data from nodeMetrics, if the nodeMetrics contains necessary heap metrics, otherwise it returns null.

  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. object Cpu extends Serializable
  30. object HeapMemory extends Serializable

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped