StandardMetrics

java.lang.Object

org.apache.pekko.cluster.metrics.StandardMetrics

public class StandardMetrics extends 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

Nested Classes

Modifier and Type

Class

Description

static final class

StandardMetrics.Cpu

static class

StandardMetrics.Cpu$

static final class

StandardMetrics.HeapMemory

static class

StandardMetrics.HeapMemory$
Constructor Summary

Constructors

Constructor

Description

StandardMetrics()
Method Summary

Modifier and Type

Method

Description

static final String

CpuCombined()

Sum of User + Sys + Nice + Wait.

static final String

CpuIdle()

Amount of CPU time left after combined and stolen are removed.

static final String

CpuStolen()

The amount of CPU 'stolen' from this virtual machine by the hypervisor for other tasks (such as running another virtual machine).

static StandardMetrics.Cpu

extractCpu(NodeMetrics nodeMetrics)

static StandardMetrics.HeapMemory

extractHeapMemory(NodeMetrics nodeMetrics)

static final String

HeapMemoryCommitted()

static final String

HeapMemoryMax()

static final String

HeapMemoryUsed()

static final String

Processors()

static final String

SystemLoadAverage()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- StandardMetrics
  
  public StandardMetrics()
Method Details
- HeapMemoryUsed
  
  public static final String HeapMemoryUsed()
- HeapMemoryCommitted
  
  public static final String HeapMemoryCommitted()
- HeapMemoryMax
  
  public static final String HeapMemoryMax()
- SystemLoadAverage
  
  public static final String SystemLoadAverage()
- Processors
  
  public static final String Processors()
- CpuCombined
  
  public static final String CpuCombined()
  
  Sum of User + Sys + Nice + Wait. See `org.hyperic.sigar.CpuPerc`
- CpuStolen
  
  public static final String CpuStolen()
  
  The amount of CPU 'stolen' from this virtual machine by the hypervisor for other tasks (such as running another virtual machine).
- CpuIdle
  
  public static final String CpuIdle()
  
  Amount of CPU time left after combined and stolen are removed.
- extractHeapMemory
  
  public static StandardMetrics.HeapMemory extractHeapMemory(NodeMetrics nodeMetrics)
- extractCpu
  
  public static StandardMetrics.Cpu extractCpu(NodeMetrics nodeMetrics)