Observability

Query metrics, heartbeats, and logs from deployment nodes via the Supervisor API.

API Variables

ld-api-key

{tenant_id}

Set variables to auto-fill all examples and run requests in-browser.

Observability data is collected by the Warden agent on each node and stored with configurable retention (7-365 days depending on plan). All endpoints use the Supervisor API ({supervisor_url}).

Required permissions: deployment:telemetry:read to read, deployment:telemetry:manage to configure retention.

Metrics

Get Deployment Metrics (Latest)

GET

{supervisor_url}/deployments/{deployment_id}/metrics

Retrieve the latest aggregate metrics snapshot for the deployment.

bash

curl {supervisor_url}/deployments/{deployment_id}/metrics \
-H "ld-api-key: YOUR_API_KEY"

Get Node Metrics (Historical)

GET

{supervisor_url}/deployments/{deployment_id}/nodes/{node_id}/metrics/iggy

Retrieve paginated historical metrics for a specific node, with time range filtering.

bash

curl "{supervisor_url}/deployments/{deployment_id}/nodes/{node_id}/metrics/iggy?page=1&results=10&from=2026-01-01T00:00:00Z&to=2026-02-01T00:00:00Z" \
-H "ld-api-key: YOUR_API_KEY"

Query Parameter	Description
`page`	Page number (default `1`)
`results`	Items per page (default `10`, max `100`)
`from`	Start time (ISO 8601, inclusive)
`to`	End time (ISO 8601, inclusive)

Heartbeats

Heartbeats are periodic liveness signals from each node. Use them to track uptime and detect restarts.

Get Deployment Heartbeats (Latest)

GET

{supervisor_url}/deployments/{deployment_id}/heartbeats

Retrieve the latest heartbeat snapshot for all nodes in the deployment.

bash

curl {supervisor_url}/deployments/{deployment_id}/heartbeats \
-H "ld-api-key: YOUR_API_KEY"

Get Node Heartbeats (Historical)

GET

{supervisor_url}/deployments/{deployment_id}/nodes/{node_id}/heartbeats/iggy

Retrieve paginated historical heartbeat records for a specific node.

bash

curl "{supervisor_url}/deployments/{deployment_id}/nodes/{node_id}/heartbeats/iggy?page=1&results=10&from=2026-01-01T00:00:00Z&to=2026-02-01T00:00:00Z" \
-H "ld-api-key: YOUR_API_KEY"

Logs

Get Deployment Logs

GET

{supervisor_url}/deployments/{deployment_id}/logs/iggy

Stream or page through deployment logs with level, message, and time range filters.

bash

curl "{supervisor_url}/deployments/{deployment_id}/logs/iggy?page=1&results=10&level=any&message=*&from=2026-01-01T00:00:00Z&to=2026-02-01T00:00:00Z" \
-H "ld-api-key: YOUR_API_KEY"

Query Parameter	Description
`page`	Page number
`results`	Items per page (max `100`)
`level`	Log level: `any`, `info`, `warn`, `error`
`message`	Glob filter on message text (e.g. `connection`)
`from`	Start time (ISO 8601)
`to`	End time (ISO 8601)

You can also redirect logs to your own OpenTelemetry-compatible endpoint. See the Observability Guide for configuration details.

Observability Guide

Retention, OTel forwarding, and console

Activities

Runtime actions like restart and reload

Observability

Observability Guide

Activities

On this page