akka.cluster.StandardMetrics

HeapMemory

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( 1L )
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Implicit information
    This member is added by an implicit conversion from HeapMemory to ArrowAssoc[HeapMemory] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. val address: Address

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

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. 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.

  12. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (HeapMemory) ⇒ Boolean): HeapMemory

    Implicit information
    This member is added by an implicit conversion from HeapMemory to Ensuring[HeapMemory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): HeapMemory

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

    Definition Classes
    AnyRef
  17. def finalize(): Unit

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

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

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

    Definition Classes
    Any
  21. 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.

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

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

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

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

    Definition Classes
    AnyRef
  26. val timestamp: Long

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

  27. val used: Long

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

  28. final def wait(): Unit

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

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

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

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from HeapMemory to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (heapMemory: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from HeapMemory to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (heapMemory: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: HeapMemory

    Implicit information
    This member is added by an implicit conversion from HeapMemory to ArrowAssoc[HeapMemory] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (heapMemory: ArrowAssoc[HeapMemory]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: HeapMemory

    Implicit information
    This member is added by an implicit conversion from HeapMemory to Ensuring[HeapMemory] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (heapMemory: Ensuring[HeapMemory]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

Inherited by implicit conversion any2stringfmt from HeapMemory to StringFormat

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

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

Ungrouped