Status pages

Publishing a status page covering the components an operator chooses.

What a status page is

A status page is a publication an operator builds deliberately: a public title, an optional summary, and an ordered set of component groups, each holding components an operator has named and described. A component may be backed by one or more monitors of the same tenant, but its public name and description are the operator's own words, independent of the monitor behind it — renaming or repointing the monitor changes nothing a reader sees.

There is no field on a page or a component for a monitor target, a node, a region, an internal error, or a tenant identifier. What can be published is allowlisted at the type level, not filtered at render time, so a field added to the internal model later stays private until someone deliberately publishes it.

Publication is an act

A page has three states — draft, published, and disabled — and only three transitions exist: the first publication, taking a published page down, and putting a disabled page back up. Publication is exactly-once and irreversible in one direction: a page cannot return to draft once it has been public, because "draft" means it has never been public and a page whose communications are already out cannot truthfully claim that again.

The public address

A page's slug is its public address, in a namespace shared across every tenant on the deployment — not per-tenant. An operator's chosen name is reduced to one canonical, lower-case, single-hyphen form before uniqueness is checked, and a small set of reserved names (matching this application's own routes and well-known addresses) can never be claimed.

What a reader sees

The public document is built from the same allowlisted projection an operator's own preview renders, so what an operator sees in preview is exactly what a reader gets — including for a draft page, which no public request can reach at all. A component's presentation state is derived from the consensus state of the monitors backing it, using the same states vocabulary documented in States; a component backed by no monitor, or by monitors nothing has evaluated yet, presents as unknown rather than as an invented "fine."

Maintenance on a status page

A component covered by an active maintenance window presents that fact alongside its ordinary state, rather than in place of it — see Maintenance.

This article is part of this repository and is served by the same binary, so what you read here is the documentation for the version you are running.