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. 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()
- Source
- Metric.scala
- Alphabetic
- By Inheritance
- HeapMemory
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new HeapMemory(address: Address, timestamp: Long, used: Long, committed: Long, max: Option[Long])
- 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.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from HeapMemory toany2stringadd[HeapMemory] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (HeapMemory, B)
- Implicit
- This member is added by an implicit conversion from HeapMemory toArrowAssoc[HeapMemory] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val address: Address
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- val committed: Long
- def ensuring(cond: (HeapMemory) => Boolean, msg: => Any): HeapMemory
- Implicit
- This member is added by an implicit conversion from HeapMemory toEnsuring[HeapMemory] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (HeapMemory) => Boolean): HeapMemory
- Implicit
- This member is added by an implicit conversion from HeapMemory toEnsuring[HeapMemory] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): HeapMemory
- Implicit
- This member is added by an implicit conversion from HeapMemory toEnsuring[HeapMemory] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): HeapMemory
- Implicit
- This member is added by an implicit conversion from HeapMemory toEnsuring[HeapMemory] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val max: Option[Long]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timestamp: Long
- val used: Long
- 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])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from HeapMemory toStringFormat[HeapMemory] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (HeapMemory, B)
- Implicit
- This member is added by an implicit conversion from HeapMemory toArrowAssoc[HeapMemory] 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.