Object

akka.cluster.metrics

StandardMetrics

Related Doc: package metrics

Permalink

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. All

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

    Permalink

    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

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. object Cpu extends Serializable

    Permalink

  5. final val CpuCombined: String("cpu-combined")

    Permalink

    Sum of User + Sys + Nice + Wait.

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

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

    Permalink

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

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

    Permalink

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

  8. object HeapMemory extends Serializable

    Permalink

  9. final val HeapMemoryCommitted: String("heap-memory-committed")

    Permalink

  10. final val HeapMemoryMax: String("heap-memory-max")

    Permalink

  11. final val HeapMemoryUsed: String("heap-memory-used")

    Permalink

  12. final val Processors: String("processors")

    Permalink

  13. final val SystemLoadAverage: String("system-load-average")

    Permalink

  14. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  18. def extractCpu(nodeMetrics: NodeMetrics): Cpu

    Permalink

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

  19. def extractHeapMemory(nodeMetrics: NodeMetrics): HeapMemory

    Permalink

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

  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  21. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  22. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped