Skip to main content
GET
/
admin
/
api
/
v1
/
traces
/
_health
Trace Pipeline Health
curl --request GET \
  --url https://api.example.com/admin/api/v1/traces/_health
{
  "queueDepth": 123,
  "maxQueueSize": 123,
  "overflowCount": 123,
  "writerRunning": true,
  "databaseDialect": "unknown",
  "instrumentorStatus": "ok",
  "instrumentorMessage": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.idun-group.com/llms.txt

Use this file to discover all available pages before exploring further.

Response

200 - application/json

Successful Response

Body of GET /admin/api/v1/traces/_health.

Reflects the running StandaloneSpanExporter's queue. When the trace pipeline is not attached (engine booted without traces) the router returns zeroes + writer_running=False instead of 404 so the UI panel can render a stable "pipeline idle" state.

database_dialect lets the UI conditionally render the SQLite operational banner without a second round-trip; it mirrors the SQLAlchemy bind dialect name ("sqlite" or "postgresql") and falls back to "unknown" when no bind is reachable.

queueDepth
integer
required
maxQueueSize
integer
required
overflowCount
integer
required
writerRunning
boolean
required
databaseDialect
string
default:unknown
instrumentorStatus
string
default:ok
instrumentorMessage
string | null
Last modified on May 22, 2026