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
- Alphabetic
- By Inheritance
- StandardMetrics
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- 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()
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final val CpuCombined: String("cpu-combined")
Sum of User + Sys + Nice + Wait.
Sum of User + Sys + Nice + Wait. See
org.hyperic.sigar.CpuPerc - final val CpuIdle: String("cpu-idle")
Amount of CPU time left after combined and stolen are removed.
- 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).
- final val HeapMemoryCommitted: String("heap-memory-committed")
- final val HeapMemoryMax: String("heap-memory-max")
- final val HeapMemoryUsed: String("heap-memory-used")
- final val Processors: String("processors")
- final val SystemLoadAverage: String("system-load-average")
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def extractCpu(nodeMetrics: NodeMetrics): Cpu
Java API to extract Cpu data from nodeMetrics, if the nodeMetrics contains necessary cpu metrics, otherwise it returns null.
- def extractHeapMemory(nodeMetrics: NodeMetrics): HeapMemory
Java API to extract HeapMemory data from nodeMetrics, if the nodeMetrics contains necessary heap metrics, otherwise it returns null.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- object Cpu extends Serializable
- object HeapMemory extends Serializable