> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/itential-platform/2023-2/monitor/recommendations/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Monitoring recommendations

> How to monitor Itential Platform availability and performance using the health status API, application and adapter monitoring routes, and SNMP traps.

To maximize availability and ensure consistent performance, Itential recommends the following monitoring approaches.

## Basic monitoring

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:**

```
GET /health/status HTTP/1.1
Host: some-iap-host:3000
Accept: /
```

**Healthy response** (all services running):

```json
{
  "host": "automation-platform-20231-stable-0",
  "serverId": "582672c5a088e6f0ca182723e1471805179faf272e1b5750e12bc06f962b13ee",
  "serverName": null,
  "services": [
    { "service": "redis", "status": "running" },
    { "service": "mongo", "status": "running" },
    { "service": "vault", "status": "running" },
    { "service": "rabbitmq", "status": "running" }
  ],
  "timestamp": 1711633372837,
  "apps": "running",
  "adapters": "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):

```json
{
  "host": "automation-platform-20231-stable-0",
  "serverId": "582672c5a088e6f0ca182723e1471805179faf272e1b5750e12bc06f962b13ee",
  "serverName": null,
  "services": [
    { "service": "redis", "status": "running" },
    { "service": "mongo", "status": "running" },
    { "service": "vault", "status": "running" },
    { "service": "rabbitmq", "status": "running" }
  ],
  "timestamp": 1711633372837,
  "apps": "degraded",
  "adapters": "running"
}
```

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"`.

## Application and adapter monitoring

Itential also recommends monitoring individual applications and adapters. Both routes below require a valid session token.

### Application monitoring

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:**

```
GET /health/applications?token=some-iap-token HTTP/1.1
Host: some-iap-host:3000
Accept: /
```

**Response:**

```json
{
  "results": [
    {
      "id": "AdminEssentials",
      "package_id": "@itential/app-admin_essentials",
      "version": "3.5.64-2021.2.50.0",
      "type": "Application",
      "state": "RUNNING",
      "uptime": 320.914691654,
      "memoryUsage": {
        "rss": 52662272,
        "heapTotal": 29638656,
        "heapUsed": 27756488,
        "external": 38208460,
        "arrayBuffers": 36697945
      },
      "cpuUsage": { "user": 1284858, "system": 167948 },
      "pid": 15283
    }
  ]
}
```

### Adapter monitoring

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:**

```
GET /health/adapters?token=some-iap-token HTTP/1.1
Host: some-iap-host:3000
Accept: /
```

**Response:**

```json
{
  "results": [
    {
      "id": "local_aaa",
      "package_id": "@itential/adapter-local_aaa",
      "version": "4.3.1-2021.2.3.0",
      "type": "Adapter",
      "state": "RUNNING",
      "connection": { "state": "ONLINE" },
      "uptime": 804.227121682,
      "memoryUsage": {
        "rss": 62124032,
        "heapTotal": 36909056,
        "heapUsed": 34986384,
        "external": 56421712,
        "arrayBuffers": 54911197
      },
      "cpuUsage": { "user": 1989815, "system": 231054 },
      "pid": 15568
    }
  ]
}
```

## SNMP traps

Itential Platform produces SNMP Traps that can be used for alerting when certain events occur. See [SNMP Notification Types](/itential-platform/monitor/log/smnp-mib-notifications) for more information.

> How to monitor Itential Platform availability and performance using the health status API, application and adapter monitoring routes, and SNMP traps.