akka.cluster
Class StandardMetrics

java.lang.Object
  akka.cluster.StandardMetrics

public class StandardMetrics
extends java.lang.Object

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.

Nested Class Summary

static class	StandardMetrics.Cpu
static class	StandardMetrics.Cpu$
static class	StandardMetrics.HeapMemory The amount of used and committed memory will always be <= max if max is defined.
static class	StandardMetrics.HeapMemory$

Constructor Summary

StandardMetrics()

Method Summary

static java.lang.String	CpuCombined()
static StandardMetrics.Cpu	extractCpu(NodeMetrics nodeMetrics) Java API to extract Cpu data from nodeMetrics, if the nodeMetrics contains necessary cpu metrics, otherwise it returns null.
static StandardMetrics.HeapMemory	extractHeapMemory(NodeMetrics nodeMetrics) Java API to extract HeapMemory data from nodeMetrics, if the nodeMetrics contains necessary heap metrics, otherwise it returns null.
static java.lang.String	HeapMemoryCommitted()
static java.lang.String	HeapMemoryMax()
static java.lang.String	HeapMemoryUsed()
static java.lang.String	Processors()
static java.lang.String	SystemLoadAverage()

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardMetrics

public StandardMetrics()

Method Detail

HeapMemoryUsed

public static final java.lang.String HeapMemoryUsed()

HeapMemoryCommitted

public static final java.lang.String HeapMemoryCommitted()

HeapMemoryMax

public static final java.lang.String HeapMemoryMax()

SystemLoadAverage

public static final java.lang.String SystemLoadAverage()

Processors

public static final java.lang.String Processors()

CpuCombined

public static final java.lang.String CpuCombined()

extractHeapMemory

public static StandardMetrics.HeapMemory extractHeapMemory(NodeMetrics nodeMetrics)

Java API to extract HeapMemory data from nodeMetrics, if the nodeMetrics contains necessary heap metrics, otherwise it returns null.

extractCpu

public static StandardMetrics.Cpu extractCpu(NodeMetrics nodeMetrics)

Java API to extract Cpu data from nodeMetrics, if the nodeMetrics contains necessary cpu metrics, otherwise it returns null.