Sign in
Engine

Retrieve engine metrics

Returns the current metrics of the OIBus engine (CPU, memory, uptime), refreshed every second

get/api/engine/metrics

Response

The engine metrics

metricsStartstring required

Represents an instant in time as an ISO 8601 string.

processCpuUsageInstantnumber double required

The instantaneous CPU usage of the process.

processCpuUsageAveragenumber double required

The average CPU usage of the process.

processUptimenumber double required

The uptime of the process in seconds.

freeMemorynumber double required

The amount of free memory in bytes.

totalMemorynumber double required

The total amount of memory in bytes.

minRssnumber double required

The minimum resident set size in bytes.

currentRssnumber double required

The current resident set size in bytes.

maxRssnumber double required

The maximum resident set size in bytes.

minHeapTotalnumber double required

The minimum heap total size in bytes.

currentHeapTotalnumber double required

The current heap total size in bytes.

maxHeapTotalnumber double required

The maximum heap total size in bytes.

minHeapUsednumber double required

The minimum heap used size in bytes.

currentHeapUsednumber double required

The current heap used size in bytes.

maxHeapUsednumber double required

The maximum heap used size in bytes.

minExternalnumber double required

The minimum external memory size in bytes.

currentExternalnumber double required

The current external memory size in bytes.

maxExternalnumber double required

The maximum external memory size in bytes.

minArrayBuffersnumber double required

The minimum ArrayBuffers size in bytes.

currentArrayBuffersnumber double required

The current ArrayBuffers size in bytes.

maxArrayBuffersnumber double required

The maximum ArrayBuffers size in bytes.

Example response

{
  "metricsStart": "2023-10-31T12:34:56.789Z",
  "processCpuUsageInstant": 0.5,
  "processCpuUsageAverage": 0.3,
  "processUptime": 3600,
  "freeMemory": 1073741824,
  "totalMemory": 2147483648,
  "minRss": 104857600,
  "currentRss": 157286400,
  "maxRss": 209715200,
  "minHeapTotal": 52428800,
  "currentHeapTotal": 73400320,
  "maxHeapTotal": 94371840,
  "minHeapUsed": 31457280,
  "currentHeapUsed": 47185920,
  "maxHeapUsed": 62914560,
  "minExternal": 1048576,
  "currentExternal": 2097152,
  "maxExternal": 3145728,
  "minArrayBuffers": 1048576,
  "currentArrayBuffers": 2097152,
  "maxArrayBuffers": 3145728
}

Changes

Changed in 51 of the 320 revisions of this API.2526