Documentation
Reference and guidance for Observer, the metrics-driven status page platform.
This section covers product setup, day-two operations, and concepts. The two adjacent tabs are scoped narrower: the Observer Agent tab covers the on-premise data plane, and the API tab is the generated REST reference.
Quickstart
Pick the metric path that matches your environment, then proceed to SLO and status page. The two metric quickstarts are alternatives, not sequential; complete one of them.
First metric (Prometheus)
Install the agent, evaluate a PromQL query, and report status to the cloud.
First metric (HTTP probe)
Probe an endpoint directly when no Prometheus server is in place.
Define your first SLO
Wrap a metric in a service level objective and read the error budget.
Publish your first status page
Compose services, metrics, and SLOs into a customer-facing URL.
Guides, reference, and concepts
The remaining sections in the sidebar are organised by purpose:
- Guides cover task-shaped configuration: customer-scoped pages, password protection, custom domains, outbound webhooks, theme customization, and migration from other status page tools.
- Reference covers webhook payload shapes, audit log event names, threshold semantics, and the incident lifecycle.
- Concepts covers the operating model: metric-based status, service level objectives, customer scopes, threshold semantics.