System status and component health

GET 
/health/status

Returns per-component health status with system metrics. Requires authentication.

Responses

200

All components healthy.

application/json

Schema

Schema

status stringrequired

Overall health status.

components

object

required

Per-component health status.

property name*

ComponentHealth

status stringrequired

Component health status.

error string

Error message when component is unhealthy.

version stringrequired

Application version.

uptime stringrequired

Time since server started.

nats

object

url stringrequired

Connected NATS server URL.

version stringrequired

NATS server version.

streams

object[]

JetStream stream statistics.

Array [

name stringrequired

Stream name.

messages integerrequired

Number of messages in the stream.

bytes integerrequired

Total bytes in the stream.

consumers integerrequired

Number of consumers on the stream.

]

kv_buckets

object[]

KV bucket statistics.

Array [

name stringrequired

KV bucket name.

keys integerrequired

Number of keys in the bucket.

bytes integerrequired

Total bytes in the bucket.

]

jobs

object

total integerrequired

Total number of jobs.

unprocessed integerrequired

Number of unprocessed jobs.

processing integerrequired

Number of jobs currently processing.

completed integerrequired

Number of completed jobs.

failed integerrequired

Number of failed jobs.

dlq integerrequired

Number of jobs in the dead letter queue.

Example (from schema)

{
  "status": "ok",
  "components": {},
  "version": "0.1.0",
  "uptime": "2h30m",
  "nats": {
    "url": "nats://localhost:4222",
    "version": "2.10.0"
  },
  "streams": [
    {
      "name": "JOBS",
      "messages": 42,
      "bytes": 1024,
      "consumers": 1
    }
  ],
  "kv_buckets": [
    {
      "name": "job-queue",
      "keys": 10,
      "bytes": 2048
    }
  ],
  "jobs": {
    "total": 100,
    "unprocessed": 5,
    "processing": 2,
    "completed": 90,
    "failed": 3,
    "dlq": 0
  }
}

401

Unauthorized - API key required.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

503

One or more components unhealthy.

application/json

Schema

Schema

status stringrequired

Overall health status.

components

object

required

Per-component health status.

property name*

ComponentHealth

status stringrequired

Component health status.

error string

Error message when component is unhealthy.

version stringrequired

Application version.

uptime stringrequired

Time since server started.

nats

object

url stringrequired

Connected NATS server URL.

version stringrequired

NATS server version.

streams

object[]

JetStream stream statistics.

Array [

name stringrequired

Stream name.

messages integerrequired

Number of messages in the stream.

bytes integerrequired

Total bytes in the stream.

consumers integerrequired

Number of consumers on the stream.

]

kv_buckets

object[]

KV bucket statistics.

Array [

name stringrequired

KV bucket name.

keys integerrequired

Number of keys in the bucket.

bytes integerrequired

Total bytes in the bucket.

]

jobs

object

total integerrequired

Total number of jobs.

unprocessed integerrequired

Number of unprocessed jobs.

processing integerrequired

Number of jobs currently processing.

completed integerrequired

Number of completed jobs.

failed integerrequired

Number of failed jobs.

dlq integerrequired

Number of jobs in the dead letter queue.

Example (from schema)

{
  "status": "ok",
  "components": {},
  "version": "0.1.0",
  "uptime": "2h30m",
  "nats": {
    "url": "nats://localhost:4222",
    "version": "2.10.0"
  },
  "streams": [
    {
      "name": "JOBS",
      "messages": 42,
      "bytes": 1024,
      "consumers": 1
    }
  ],
  "kv_buckets": [
    {
      "name": "job-queue",
      "keys": 10,
      "bytes": 2048
    }
  ],
  "jobs": {
    "total": 100,
    "unprocessed": 5,
    "processing": 2,
    "completed": 90,
    "failed": 3,
    "dlq": 0
  }
}

Loading...