Package org.apache.pekko.cluster.metrics

Class StandardMetrics.HeapMemory$

java.lang.Object

org.apache.pekko.cluster.metrics.StandardMetrics.HeapMemory$

All Implemented Interfaces:

Serializable

Enclosing class:

StandardMetrics

public static class StandardMetrics.HeapMemory$
extends Object
implements Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final StandardMetrics.HeapMemory$	MODULE$	Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor	Description
HeapMemory$()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

MODULE$

public static final StandardMetrics.HeapMemory$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Details

HeapMemory$

public HeapMemory$()

Method Details

unapply

public scala.Option<scala.Tuple5<Address,Object,Object,Object,scala.Option<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<Object> max)

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

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,Object,Object,Object,scala.Option<Object>>> unapply(StandardMetrics.HeapMemory x$0)