akka.cluster.StandardMetrics

HeapMemory

Related Docs: object HeapMemory | package StandardMetrics

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
ClusterMetricsCollector.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HeapMemory
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from HeapMemory to any2stringadd[HeapMemory] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HeapMemory, B)

    Implicit information
    This member is added by an implicit conversion from HeapMemory to ArrowAssoc[HeapMemory] 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

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

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val committed: Long

    the current sum of heap memory guaranteed to be available to the JVM from all heap memory pools (in bytes).

    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.

  10. def ensuring(cond: (HeapMemory) ⇒ Boolean, msg: ⇒ Any): HeapMemory

    Implicit information
    This member is added by an implicit conversion from HeapMemory to Ensuring[HeapMemory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (HeapMemory) ⇒ Boolean): HeapMemory

    Implicit information
    This member is added by an implicit conversion from HeapMemory to Ensuring[HeapMemory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): HeapMemory

    Implicit information
    This member is added by an implicit conversion from HeapMemory to Ensuring[HeapMemory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): HeapMemory

    Implicit information
    This member is added by an implicit conversion from HeapMemory to Ensuring[HeapMemory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from HeapMemory to StringFormat[HeapMemory] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  19. val max: Option[Long]

    the maximum amount of memory (in bytes) that can be used for JVM memory management.

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

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

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  24. val timestamp: Long

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

  25. val used: Long

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

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def [B](y: B): (HeapMemory, B)

    Implicit information
    This member is added by an implicit conversion from HeapMemory to ArrowAssoc[HeapMemory] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from HeapMemory to any2stringadd[HeapMemory]

Inherited by implicit conversion StringFormat from HeapMemory to StringFormat[HeapMemory]

Inherited by implicit conversion Ensuring from HeapMemory to Ensuring[HeapMemory]

Inherited by implicit conversion ArrowAssoc from HeapMemory to ArrowAssoc[HeapMemory]

Ungrouped