Create a status page

A public page that shows chosen monitors under names you pick. Choose its address and settings, set what it shows, check it, then publish it.

A status page shows your customers how your services are doing. Each row is a component with a public name you pick: a monitor's own name and target are never shown. Component status follows your monitors, and you can post incidents to explain what is happening.

Pages are served from the edge, separately from the Monitor API. If Monitor can't reach them, they keep showing the last known state and say that live updates are delayed. That notice appears once Monitor has been silent for more than 10 minutes, or when the page is served from a stale copy because the store behind it failed.

The steps

Create the page. It starts unpublished, and its address answers 404.
Set its layout: what it shows.
Open a preview link to check it.
Publish it.

In the dashboard, open Monitor, then Status pages. From a terminal, use nrc monitor status-pages (needs CLI 0.23.0 or later):

nrc monitor status-pages create "Acme status" \
  --slug acme \
  --time-zone Europe/Prague \
  --uptime-days 90 \
  --history-days 90 \
  --show-uptime-bars \
  --show-uptime-percent \
  --show-response-time=false \
  --search-indexing

Through the API, POST https://monitor.api.norcube.com/app/v1/status-pages with the same settings:

{
  "slug": "acme",
  "name": "Acme status",
  "description": "",
  "settings": {
    "timeZone": "Europe/Prague",
    "uptimeDays": 90,
    "historyDays": 90,
    "showUptimeBars": true,
    "showUptimePercent": true,
    "showResponseTime": false,
    "searchIndexing": true
  }
}

Name and address

Field	Rules
`slug`	The page's address, `https://<slug>.norcubestatus.com`. 3 to 40 lowercase letters, digits or hyphens, starting and ending with a letter or digit.
`name`	Public. Required, up to 100 characters.
`description`	Public. Optional, up to 500 characters.

A slug is unique across all of Norcube, so one that is taken answers 409 with the reason SLUG_TAKEN. These are reserved, and using one answers 400 with VALIDATION_FAILED: admin, api, app, assets, blog, cdn, custom, dashboard, docs, edge, help, mail, monitor, norcube, origin, preview, staging, static, status, support, www. You can change the address later, or also serve the page from a domain of your own.

Settings

Every setting is required when you create a page. You can change each one later on its own.

Setting	What it does
`timeZone`	The IANA time zone the page shows times in, such as `Europe/Prague`. Uptime bars always count UTC days.
`uptimeDays`	How many days the uptime bars and the uptime percentage cover: 30, 60 or 90.
`showUptimeBars`	Show a bar per component, one segment per day.
`showUptimePercent`	Show each component's uptime percentage.
`showResponseTime`	Show each component's average response time.
`historyDays`	How long resolved incidents stay on the page: 7 to 365 days. The page carries at most the 100 newest of them.
`searchIndexing`	`false` asks search engines to leave the page out.

Uptime and response times appear only for a component that counts the availability aspect of an HTTP monitor. Certificate and domain components show their status alone.

When changes go public

Monitor pushes a changed page every 30 seconds, and the public page is cached for 30 seconds, so a change to a published page is public within a minute. That goes for your edits, your posts and your monitors' incidents alike.

Uptime and bars can lag by up to 5 minutes, because they are rebuilt at least every 5 minutes rather than on every check. A browser revisiting the page may briefly show an older copy.

What visitors' browsers load

The page is complete without JavaScript. Two small scripts add to it:

status-days.js loads when a component has bars, and shows each day's details in a tooltip.
status-search.js loads on a page with 12 or more components, and adds a box that finds a component by name.

Scripts, styles and fonts all come from the page's own address (the Content-Security-Policy allows script-src 'self'), and the page sets no cookies. The footer always links to Norcube Monitor with "Powered by Norcube Monitor".