Status page

A status page lets the people who use your app check whether it’s working, without asking you. It shows each part of your service, its uptime over the last 90 days, and any incidents you’ve written. Nothing private is on it.

Turn it on

Open Status page in the sidebar.

Setting	Meaning	Limits
Publish the status page	On: the page is served publicly, and sampling begins
Title	The headline, such as How Acme is doing right now	up to 120 characters
Description	One line under it	up to 500
Support link	Where visitors can get help	up to 500
Components	The parts of your service to show	up to 30

Components

Each component has a name, a short description, and a source that says how its state is known:

Source	Checked by	Shown as
gateway	Requests reaching your API	e.g. API
api	The API service itself
auth	Sign-in and sessions	e.g. Sign-in
realtime	Live channels	e.g. Realtime
workers	Background workers that run jobs, schedules and flows	e.g. Background jobs
manual	Nobody: only changed by an incident you write	e.g. Payments partner

A new page starts with four components: API, Sign-in, Realtime and Background jobs. Rename them in your users’ words, remove what they don’t care about, and add manual components for things outside Pawabase that your service depends on. Probed components are checked every five minutes. A component is:

State	When
Operational	The recent checks passed
Degraded	Some recent checks failed, or an open incident says so
Outage	The latest checks failed, or an open incident says so

Each day’s checks roll up into a daily uptime bar, so visitors see 90 days of history per component.

Incidents

When something is wrong, open an incident, even before you know the cause.

Field	Meaning
Title	What people notice: Sign-in is slow
Status	`investigating`, `identified`, `monitoring` or `resolved`
Impact	`none`, `minor` (shows components as degraded), `major` or `critical` (show them as an outage)
Components affected	Which components it marks
Message	What’s happening, up to 2,000 characters

While an incident is open, the components it names show at least as bad as its impact says, whatever the probes say. Post updates as you learn more; each update has a status and a message, and can change the impact. Set the status to resolved to close it. A good update says what people experience, what you’re doing, and when you’ll update next:

Identified · Sign-ins are failing for some people using Google. We’ve found the cause, a change at our provider, and are rolling out a fix. Next update in 30 minutes.

Delete an incident only if it was opened by mistake; otherwise resolve it, so the history stays honest.

The public address

The page is served by your project’s API, with no key needed:

Address	Shows
`https://<your-api>/status`	The default environment’s page
`https://<your-api>/status/<environment>`	A named environment’s page
`https://<your-api>/status/<environment>.json`	The same data as JSON, for your own app or a widget

If the page isn’t published, these answer 404. Use the JSON to show a banner in your own app when something is degraded:

const res = await fetch(`${PAWABASE_URL}/status/production.json`);
if (res.ok) {
  const status = await res.json();
  // show a notice when the overall state isn't operational
}

From code

const m = manage(pawabase);
await m.statusPage.configure({
  enabled: true,
  title: "How Acme is doing",
  components: [
    { name: "API", source: "gateway" },
    { name: "Sign-in", source: "auth" },
    { name: "Payments", source: "manual", description: "Card payments through our provider" },
  ],
});
const incident = await m.statusPage.openIncident("Card payments failing", {
  impact: "major",
  components: ["Payments"],
  message: "Our payment provider is having problems. Orders are saved and will be charged when it recovers.",
});
await m.statusPage.updateIncident(incident.id, "Payments are working again.", { status: "resolved" });

curl -X POST "$PAWABASE_URL/platform/v1/envs/production/incidents/$INCIDENT/updates" \
  -H "apikey: $PAWABASE_SECRET_KEY" -H "content-type: application/json" \
  -d '{"status": "resolved", "message": "Payments are working again."}'

Good practice

Open early, update often, resolve honestly. A quiet status page during an outage costs more trust than the outage.
Name components in your users’ words: Checkout, not gateway.
Link to it from your app’s footer, help centre and error screens.
Pair it with alarms, so you find out before your users.

Environments

Activity

Secrets and backups

Pawabase Cloud

Turn it on

Components

Incidents

The public address

From code

Good practice

​Turn it on

​Components

​Incidents

​The public address

​From code

​Good practice

Turn it on

Components

Incidents

The public address

From code

Good practice