Status pages and incidents

Publish component health, run an incident from open to resolved, and embed a live status badge in your own docs.

5 min read

A status page exists to answer one question before a customer has to ask it: is it you, or is it me? Every minute your status page stays silent during an outage is a support ticket you are choosing to receive.

Components

Define components that mean something to a customer — API, Dashboard, Email delivery — not to your architecture. Nobody outside your team knows whether worker-pool-2 matters to them.

StateMeaning
OperationalWorking normally.
DegradedWorking, but slow or partly impaired.
Partial outageSome users or some functions are down.
Major outageBroadly unavailable.
MaintenancePlanned work, announced in advance.

Running an incident

  1. 1

    Open the incident early.

    The first update can be "We are investigating reports of errors on the API." You do not need a cause to start communicating, and waiting for one is the most common mistake.

  2. 2

    Set the affected components.

    This is what drives the badge, the portal banner, and the subscriber email.

  3. 3

    Post an update on a rhythm.

    Every 30 minutes, even when the update is "still working on it". Silence reads as abandonment.

  4. 4

    Resolve, then write the retrospective.

    Resolving notifies subscribers. A short written cause afterwards is what turns an outage from a broken promise into evidence you are competent.

Operator notices

A notice is a banner without an incident — planned maintenance, a deprecation date, a migration window. It shows on the status page and in the portal without marking anything as broken.

The badge

![SignlOS status](https://api.signlos.com/api/public/YOUR-WORKSPACE/status/badge.svg)
Live status badge. Drop it in a README, a docs page, or an internal wiki.
NextThe public portal and custom domains

Common questions

Can I put a SignlOS status page on my own domain?
Yes. Point a CNAME at SignlOS and set the domain in the workspace settings; the page is then served from your domain over HTTPS.
Is there a status badge I can embed?
Yes. Every status page serves an SVG badge at /api/public/{workspace}/status/badge.svg, and per-component badges alongside it. It is an image, so it works anywhere an image works — a README, a docs page, a wiki.

Something unclear or wrong? Tell us — or post it on our board.