Integrated Modules

List of integrated modules

The following modules are integrated in the application itself:

• CPU
• Memory

Module specific protocols

CPU

The CPU module provides the following targets:

CPU.CpuInfo

Semantics of reply:

[
    {
        "id": <ID of the CPU thread>,
        "core_id": <ID of the CPU core the thread is on>,
        "socket_id": <ID of the socket the CPU core is on, relevant for multi-CPU systems only>,
        "model_name": "<Model name of the CPU>",
        "clock_speed": <Clock speed of the CPU in MHz>,
        "cache_size": <Size of the CPU Cache in KB>,
        "flags": "<Exposed CPU flags>"
    }, ...
]

Additional information:

The information for this endpoint is gathered from /proc/cpuinfo. Especially in virtualized environments, this can lead to incorrect or incomplete information. This depends heavily on the configuration of the hypervisor. Sadly, there is no other way to get this information in a virtual machine. However, the containerized environments we tested, provide correct information.

For more information on the CPU flags, consider reading cpufeatures.h from the linux kernel source code.

CPU.Usage

Semantics of reply:

{
    "cpu": {
        "usage": <usage of the whole CPU package in percent>
    },
    "cpu0": {
        "usage": <usage of the thread cpu0 in percent>
    }, ...
}

Example:

{
  "cpu": {
    "usage": 9.81863664790494
  },
  "cpu0": {
    "usage": 3.0303030303030303
  },
  "cpu1": {
    "usage": 18
  },
  "cpu10": {
    "usage": 12
  },
  "cpu11": {
    "usage": 1.0204081632653061
  },
  "cpu12": {
    "usage": 19
  },
  "cpu13": {
    "usage": 3
  },
  "cpu14": {
    "usage": 7.920792079207921
  },
  "cpu15": {
    "usage": 0
  },
  "cpu2": {
    "usage": 4.040404040404041
  },
  "cpu3": {
    "usage": 2.9411764705882355
  },
  "cpu4": {
    "usage": 31.31313131313131
  },
  "cpu5": {
    "usage": 4
  },
  "cpu6": {
    "usage": 7.920792079207921
  },
  "cpu7": {
    "usage": 20
  },
  "cpu8": {
    "usage": 14.141414141414142
  },
  "cpu9": {
    "usage": 6
  }
}

Memory

Memory.MemInfo

Semantics of reply:

{
    "mem_total": <Total memory in KB>,
    "mem_free": <Free memory in kB>,
    "mem_available": <Available memory in kB>
}

Memory.SwapInfo

Semantics of reply:

{
    "swap_total": <Total swap in KB>,
    "swap_free": <Free swap in KB>
}