Observability
Read node metrics, readiness, heartbeats, and logs
Set variables to auto-fill all examples and run requests in-browser.
Warden collects telemetry on each node. The platform retains it for the period included in the deployment tier. Use {supervisor_url} for these Supervisor API requests.
Reading requires deployment:telemetry:read. Changing retention requires deployment:telemetry:manage.
Runtime and Response Shapes
Runtime paths accept iggy, warden, connectors, plane, and available connector:{id} instances. Latest deployment metrics use a nodes map keyed by node ID. Each node maps runtime names to arrays of samples. A host array can contain virtual-machine metrics. Historical requests return paginated samples.
Runtime fields appear directly in each sample. Iggy can report leadership, view, voters, quorum, replication gaps, and repair state. Plane metrics include projector lag, decoding counters, replay readiness, ownership, fencing, and backend synchronization. See Monitoring.
Metrics
Get Deployment Metrics (Latest)
GET{supervisor_url}/deployments/{deployment_id}/metricsRetrieve the latest aggregate metrics snapshot for the deployment.
curl {supervisor_url}/deployments/{deployment_id}/metrics \
-H "ld-api-key: YOUR_API_KEY"Get Node Metrics (Latest)
GET{supervisor_url}/deployments/{deployment_id}/nodes/{node_id}/metricsRetrieve the latest node samples grouped by runtime, with host resources when available.
Get Node Metrics (Historical)
GET{supervisor_url}/deployments/{deployment_id}/nodes/{node_id}/metrics/iggyRetrieve paginated historical metrics for a specific node, with time range filtering.
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) |
Readiness
GET{supervisor_url}/deployments/{deployment_id}/nodes/{node_id}/readinessRetrieve the latest serving readiness for a deployment node.
Readiness reports observed_at, agent_ready, iggy_ready, plane_ready, last_probe_at, and serving. Iggy and plane readiness can be unknown. A running process or recent heartbeat alone does not prove readiness to serve.
Heartbeats
Heartbeats report recent liveness. Use them to track uptime and detect restarts.
Get Deployment Heartbeats (Latest)
GET{supervisor_url}/deployments/{deployment_id}/heartbeatsRetrieve the latest heartbeat snapshot for all nodes in the deployment.
curl {supervisor_url}/deployments/{deployment_id}/heartbeats \
-H "ld-api-key: YOUR_API_KEY"Get Node Heartbeats (Latest)
GET{supervisor_url}/deployments/{deployment_id}/nodes/{node_id}/heartbeatsRetrieve the latest heartbeat status for all runtimes on a node.
Get Node Heartbeats (Historical)
GET{supervisor_url}/deployments/{deployment_id}/nodes/{node_id}/heartbeats/iggyRetrieve paginated historical heartbeat records for a specific node.
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/iggyStream or page through deployment logs with level, message, and time range filters.
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 send logs to an OpenTelemetry-compatible endpoint. See Monitoring for configuration.