Sign in
Engine

Retrieve home page metrics

Returns the metrics displayed on the home page: the engine metrics and the metrics of every north and south connector

get/api/engine/home-metrics

Response

The engine, north and south connector metrics

northsRecordStringNorthConnectorMetrics required

Construct a type with a set of properties K of type T

southsRecordStringSouthConnectorMetrics required

Construct a type with a set of properties K of type T

Example response

{
  "engine": {
    "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