Browse documentation
View Markdown

Nines documentation

Nines manages service level objectives and critical user journeys as code.

Try the complete flow

  • The local playground runs Nines, PostgreSQL, Prometheus and a synthetic checkout service. It automatically deploys the sample SLO's recording and alert rules, and includes a verifier that introduces failures and checks recovery.
sh
python3 scripts/setup-local.py --playground
docker compose -p nines-playground -f compose.playground.yaml up --build -d
  • Open http://127.0.0.1:18080 and sign in with admin / admin.
    • The setup command generates a private database password on a fresh checkout; it does not overwrite an existing .env.
    • These public web credentials belong only to the loopback playground.

Choose your next step

Understand the measurements

  • An SLO specifies a target and evaluation window for a measured population.

    • The SLI is the observed fraction of successful events.
    • A critical user journey describes the user outcome, its steps and the SLOs on which those steps depend.
    • Linking SLOs to a journey does not establish that every end-to-end journey succeeded.
  • Nines keeps definition storage, measurement collection, rule deployment, backend evaluation and observed attainment separate. A saved definition or accepted rule upload cannot manufacture useful telemetry. Missing or insufficient evidence remains unknown.

  • Review a screenshot against a journey outcome: Visual journey evidence

Choose an operating model

  • Use the server for the portal, tenant users, PostgreSQL-backed history and interactive review.

  • Use the CLI offline for YAML validation and recording-rule generation in CI or deterministic skills. Connected commands additionally use a fixed server and tenant.

  • Use the Kubernetes operator when Kubernetes and GitOps own the definitions. Portal-owned SLOs can also publish through the configured operator bridge.

  • Use MCP for scoped agent tools. Models are optional; mutation permissions and human approval remain explicit.

  • See architecture, installation and current limits. Model-assisted workflows, replay and other experimental features retain their documented acceptance boundaries.

  • Read the session replay guide to capture the current tab, inspect masked playback and export a portable HTML recording. Replay remains experimental; browser acceptance is recorded separately.

  • Owners can configure immutable audit archival and inspect delivery/retention receipts in Audit log or with nines audit status. Amazon S3 and explicitly configured S3-compatible gateways are supported by the adapter; Ceph RGW is the documented open-source target, with disposable container acceptance available through make test-ceph. Archival is disabled by default.

  • Optional System One advice uses Jev to suggest template categories and assess definition clarity, with separate consent and audit receipts.

  • The platform admin console separates global account administration from tenant ownership, with user/session controls, Jev request policies and platform audit records.

  • Headless workflows: operate from CLI, API and MCP with durable review gates and no required dashboard.

  • Remote MCP with OAuth: opt-in authenticated HTTP transport, fixed-tenant bindings and client conformance limits.