Class StandardMetrics.Memory

Allocated memory metric

Inheritance
Object
StandardMetrics.Memory
Inherited Members
Namespace: Akka.Cluster.Metrics
Assembly: Akka.Cluster.Metrics.dll
Syntax
public sealed class Memory

Constructors

| Improve this Doc View Source

Memory(Address, Int64, Double, Double, Option<Double>)

Creates instance of StandardMetrics.Memory

Declaration
public Memory(Address address, long timestamp, double used, double available, Option<double> max)
Parameters
Type Name Description
Address address

Address index of the node the metrics are gathered at
Int64 timestamp

The time of sampling, in milliseconds since midnight, January 1, 1970 UTC
Double used

Total memory allocated to the currently running process (in bytes)
Double available

Memory available for current process (in bytes)
Option<Double> max

Max memory recommended for process (in bytes)

Properties

| Improve this Doc View Source

Address

Address of the node the metrics are gathered at

Declaration
public Address Address { get; }
Property Value
Type Description
Address
| Improve this Doc View Source

Available

Memory available for current process (in bytes) (VirtualMemorySize64)

Declaration
public double Available { get; }
Property Value
Type Description
Double
| Improve this Doc View Source

MaxRecommended

Max memory recommended for process (in bytes) (MaxWorkingSet)

Declaration
public Option<double> MaxRecommended { get; }
Property Value
Type Description
Option<Double>
| Improve this Doc View Source

Timestamp

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

Declaration
public long Timestamp { get; }
Property Value
Type Description
Int64
| Improve this Doc View Source

Used

The current process allocated memory (in bytes) (WorkingSet64)

Declaration
public double Used { get; }
Property Value
Type Description
Double

Methods

| Improve this Doc View Source

Decompose(NodeMetrics)

Given a NodeMetrics it returns the HeapMemory data if the nodeMetrics contains necessary heap metrics.

Declaration
public static Option<(Address Address, long Timestamp, double UsedSmoothValue, double AvailableSmoothValue, Option<double> MaxRecommendedSmoothValue)> Decompose(NodeMetrics nodeMetrics)
Parameters
Type Name Description
NodeMetrics nodeMetrics
Returns
Type Description
Option<System.ValueTuple<Address, Int64, Double, Double, Option<Double>>>

If possible a tuple matching the HeapMemory constructor parameters

Extension Methods