sys.monitoring

sys.monitoring #

The sys.monitoring package provides methods for making it easier to monitor application performance and resource usage.

getMetrics() #

This method retrieve system metrics, including memory (native and heap) and CPU usage.

Returns #

object - A key-value JSON structure with the information of memory, heap memory and CPU metrics. This is the returned structure:

{
  "memory": {
    "totalMemory": 16000000000,
    "usedMemory": 9000000000,
    "freeMemory": 7000000000
  },
  "heapMemory": {
    "totalHeapMemory": 4000000000,
    "usedHeapMemory": 2500000000,
    "freeHeapMemory": 1500000000
  },
  "cpu": {
    "processCpuLoad": 25.0,
    "systemCpuLoad": 65.0,
    "systemCpuUsage": 1.5
  }
}

Attributes description

• memory: represents the overall memory usage of the app.
  • totalMemory: total physical memory available in bytes
  • usedMemory: memory currently in use by the app in bytes
  • freeMemory: memory available for use in bytes
• heapMemory: represents memory used by the Java Virtual Machine for dynamic memory allocation.
  • totalHeapMemory: total heap memory allocated for the JVM in bytes
  • usedHeapMemory: heap memory currently in use by the JVM in bytes
  • freeHeapMemory: heap memory available for allocation in bytes
• cpu: represents CPU-related metrics for the app and the JVM process.
  • processCpuLoad: CPU load percentage used by the JVM process
  • systemCpuLoad: overall CPU load percentage of the system
  • systemCpuUsage: average CPU usage over the last 1 second

Sample #

Logging CPU and memory usage metrics information

let appMetrics = sys.monitoring.getMetrics();
log('App Metrics: ' + JSON.stringify(appMetrics));
// access CPU and memory metrics
let cpuLoad = appMetrics.cpu.processCpuLoad;
log('CPU load: ' + cpuLoad);
let totalMemory = appMetrics.memory.totalMemory;
log('Total memory: ' + totalMemory);
let usedMemory = appMetrics.memory.usedMemory;
log('Used memory: ' + usedMemory);
let usedMemoryPercentage = (usedMemory / totalMemory) * 100;
log('Used memory %: ' + usedMemoryPercentage);