Package org.apache.pekko.cluster.metrics

Class StandardMetrics.HeapMemory$

  • All Implemented Interfaces:
    java.io.Serializable
    Enclosing class:
    StandardMetrics
    public static class StandardMetrics.HeapMemory$
extends java.lang.Object
implements java.io.Serializable
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      HeapMemory$()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      StandardMetrics.HeapMemory apply​(Address address, long timestamp, long used, long committed, scala.Option<java.lang.Object> max)
      The amount of used and committed memory will always be &lt;= max if max is defined.
      scala.Option<scala.Tuple5<Address,​java.lang.Object,​java.lang.Object,​java.lang.Object,​scala.Option<java.lang.Object>>> unapply​(NodeMetrics nodeMetrics)
      Given a NodeMetrics it returns the HeapMemory data if the nodeMetrics contains necessary heap metrics.
      scala.Option<scala.Tuple5<Address,​java.lang.Object,​java.lang.Object,​java.lang.Object,​scala.Option<java.lang.Object>>> unapply​(StandardMetrics.HeapMemory x$0)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • HeapMemory$

        public HeapMemory$()

    • Method Detail

      • unapply

        public scala.Option<scala.Tuple5<Address,​java.lang.Object,​java.lang.Object,​java.lang.Object,​scala.Option<java.lang.Object>>> unapply​(NodeMetrics nodeMetrics)
        Given a NodeMetrics it returns the HeapMemory data if the nodeMetrics contains necessary heap metrics.
        Returns:
        if possible a tuple matching the HeapMemory constructor parameters

      • apply

        public StandardMetrics.HeapMemory apply​(Address address,
                                        long timestamp,
                                        long used,
                                        long committed,
                                        scala.Option<java.lang.Object> max)
        The amount of used and committed memory will always be &lt;= max if max is defined. A memory allocation may fail if it attempts to increase the used memory such that used &gt; committed even if used &lt;= max is true (e.g. when the system virtual memory is low).

        Parameters:
        address - pekko.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.

      • unapply

        public scala.Option<scala.Tuple5<Address,​java.lang.Object,​java.lang.Object,​java.lang.Object,​scala.Option<java.lang.Object>>> unapply​(StandardMetrics.HeapMemory x$0)