To maximize availability and ensure consistent performance, Itential recommends the following monitoring approaches.
The /health/status route requires no login and can be used for basic monitoring. It is appropriate for use by a load balancer to determine if an individual node is healthy. Itential Platform returns 200 when healthy — any other response or lack of response should be interpreted as unhealthy. Set the timeout for this request to 1 second.
Effective with Itential Platform 2023.1, the GET /status API is deprecated. The replacement API, /health/status, reports the health of all apps and adapters.
Request:
Healthy response (all services running):
The serverId and serverName values are customizable — modify them for your environment. A healthy response from Itential Platform 2023.2.x will not include "service":"rabbitmq".
Unhealthy response (degraded apps):
Failed applications can be viewed from the Admin Essentials > Alerts dashboard.
An unhealthy response from Itential Platform 2023.2.x will not include "service":"rabbitmq".
Itential also recommends monitoring individual applications and adapters. Both routes below require a valid session token.
For each application in the results array, pay attention to the state field — if it does not say RUNNING, the application should be considered unhealthy. Track uptime, memoryUsage, and cpuUsage over time.
Request:
Response:
For each adapter, pay attention to the state field and the additional connection.state field — anything other than ONLINE for connection.state should be considered unhealthy.
Request:
Response:
Itential Platform produces SNMP Traps that can be used for alerting when certain events occur. See SNMP Notification Types for more information.