Operating system (OS)

The operating system connector provides static functions to retrieve live performance metrics and hardware information from the host operating system. Use it to monitor CPU utilization, memory allocation, disk storage, network throughput, and running Docker containers.

Since all functions in this class are static, they do not manage state. You do not need to create an instance to use them.

System metrics

cpuUsage

Retrieves the current overall CPU utilization as a percentage.

Parameters

Input	Description	Type
interval	The measurement window in milliseconds used to calculate utilization. Default 1000.	integer

Output

Returns a number representing the total CPU usage percentage.

Example

# interval
2000

cpuCount

Retrieves the total number of logical CPU cores available on the system.

Parameters

None.

Output

Returns an integer representing the core count.

loadAverage

Retrieves system load averages for the past 1, 5, and 15 minutes, normalized by the total number of available logical CPU cores.

Platform limitation

Load averages are a Unix-specific metric. On Windows, this function always returns [0, 0, 0].

Parameters

None.

Output

Returns an array of three numbers representing the normalized system load averages.

driveInfo

Retrieves capacity and utilization metrics for the primary disk drive.

Parameters

None.

Output

Returns an object containing disk storage statistics:

{
  "totalGb": "930.85",
  "usedGb": "450.20",
  "freeGb": "480.65",
  "usedPercentage": 48.37,
  "freePercentage": 51.63
}

memInfo

Retrieves resource allocation and utilization metrics for the physical memory.

Parameters

None.

Output

Returns an object containing physical RAM capacity and allocation statistics:

{
  "totalMemMb": 16384,
  "usedMemMb": 8192,
  "freeMemMb": 8192,
  "freeMemPercentage": 50
}

netInfo

Retrieves network input and output throughput statistics aggregated across active network interfaces.

Parameters

Input	Description	Type
interval	The measurement window in milliseconds used to calculate network throughput. Default 1000.	integer

Output

Returns an object detailing input and output metrics in megabytes for each network interface alongside a combined total:

{
  "total": {
    "inputMb": "0.15",
    "outputMb": "0.05"
  },
  "eth0": {
    "inputMb": "0.15",
    "outputMb": "0.05"
  }
}

Example

# interval
1000

uptime

Retrieves the total operational uptime of the operating system.

Parameters

None.

Output

Returns an object breaking down system uptime into chronological increments alongside the absolute duration in seconds:

{
  "y": 0,
  "d": 14,
  "h": 6,
  "m": 32,
  "s": 15,
  "totalSeconds": 1233135
}

os

Retrieves the platform name of the underlying operating system.

Parameters

None.

Output

Returns a string containing the operating system identifier (such as Linux, macOS, or Windows_NT).

hostname

Retrieves the network hostname of the local system.

Parameters

None.

Output

Returns a string containing the system hostname.

Container management

containerStats

Retrieves live resource utilization and status metrics for all running Docker containers.

Parameters

Input	Description	Type
socketPath	The file system path to the Docker daemon socket. Default '/var/run/docker.sock'.	string

Output

Returns an array of objects detailing container execution statistics, processing allocations, and memory usage with inactive file cache overhead removed:

[
  {
    "id": "a1b2c3d4e5f6",
    "name": "my-app-container",
    "state": "running",
    "status": "Up 2 weeks",
    "created": 1678886400,
    "usedMemory": "150.25 MiB",
    "availableMemory": "7.79 GiB",
    "memoryUsage": "1.89 %",
    "cpuUsage": "5.12 %",
    "numberCpus": 8
  }
]

containerInfo

Retrieves configuration and state metadata profiles for all running Docker containers.

Parameters

Input	Description	Type
socketPath	The file system path to the Docker daemon socket. Default '/var/run/docker.sock'.	string

Output

Returns an array of detailed inspection objects containing container configuration profiles, layer settings, storage volume bindings, and network maps.