Class StandardMetrics

Definitions of the built-in standard metrics.

The following extractors and data structures makes it easy to consume the NodeMetrics in for example load balancers.

Inheritance

Object

StandardMetrics

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Akka.Cluster.Metrics

Assembly: Akka.Cluster.Metrics.dll

Syntax

public static class StandardMetrics

Fields

| Improve this Doc View Source

CpuProcessUsage

Contains CPU usage by current process

Declaration

public const string CpuProcessUsage = "CpuProcessUsage"

Field Value

Type	Description
String

| Improve this Doc View Source

CpuTotalUsage

Contains CPU usage by all processes

Declaration

public const string CpuTotalUsage = "CpuTotalUsage"

Field Value

Type	Description
String

| Improve this Doc View Source

MaxMemoryRecommended

Memory limit recommended for current process (MaxWorkingSet)

Declaration

public const string MaxMemoryRecommended = "MaxMemoryRecommended"

Field Value

Type	Description
String

| Improve this Doc View Source

MemoryAvailable

Memory, available for the process (VirtualMemorySize64)

Declaration

public const string MemoryAvailable = "MemoryAvailable"

Field Value

Type	Description
String

| Improve this Doc View Source

MemoryUsed

Total memory allocated to the currently running process (WorkingSet64)

Declaration

public const string MemoryUsed = "MemoryUsed"

Field Value

Type	Description
String

| Improve this Doc View Source

Processors

Number of available processors

Declaration

public const string Processors = "Processors"

Field Value

Type	Description
String

Methods

| Improve this Doc View Source

ExtractCpu(NodeMetrics)

Extract StandardMetrics.Cpu data from nodeMetrics, if the nodeMetrics contains necessary CPU metrics, otherwise it returns None.

Declaration

public static Option<StandardMetrics.Cpu> ExtractCpu(NodeMetrics nodeMetrics)

Parameters

Type	Name	Description
NodeMetrics	nodeMetrics

Returns

Type	Description
Option<StandardMetrics.Cpu>

| Improve this Doc View Source

ExtractMemory(NodeMetrics)

Extract StandardMetrics.Memory data from nodeMetrics, if the nodeMetrics contains necessary memory metrics, otherwise it returns None.

Declaration

public static Option<StandardMetrics.Memory> ExtractMemory(NodeMetrics nodeMetrics)

Parameters

Type	Name	Description
NodeMetrics	nodeMetrics

Returns

Type	Description
Option<StandardMetrics.Memory>