Health API
GET /v1/healthThe authority answers GET /v1/health without authentication. It’s meant for
load-balancer checks, dashboards and --status. A request with a body is
rejected with 400 and {"error":"health_body_forbidden"}.
The Health Document
Section titled “The Health Document”The authority publishes a cached health document about every 250 ms, and immediately on readiness or fencing. Its core fields:
| Field | Meaning |
|---|---|
mode | durable_single_voter or durable_fixed_voters |
ready | Whether the node reports ready |
role | The node’s consensus role, as a number |
term, committed, applied | Consensus term, commit index and applied index |
revision | The applied authority revision |
knobs | Knobs in the applied state |
fenced | Whether the node is fenced; after a runtime failure the cached document holds only mode and fenced: true |
snapshot_age_ms | Age of the cached document when served |
Alongside these, it reports bounded operational telemetry:
- Storage I/O. Native versus fallback operation counts, and histograms
such as
io_submitted_to_reaped_nsandio_job_settlement_ns. - Scheduling.
owner_turn_nsfor each authority scheduling pass, andwake_lateness_nsfor timer lateness. - Replication.
peer_decoded_to_admitted_nsand append round-trip timing per authenticated connection. - Publishers.
publisher_admitted_to_ready_nsandreply_ready_to_retired_ns.
Histograms expose a count, a saturating sum, a maximum, and buckets bounded by
duration_bucket_upper_bounds_ns. Fields are sampled independently, so one
response is approximate rather than a single atomic snapshot.