Public status page
/status. Public, no login. Needs module.statusPage.
Shows the services and monitors you have marked public, with their current health. It lets you tell students and staff “yes, the Wi-Fi is down, we are on it” without fielding forty individual reports of the same outage.
Setting it up
Section titled “Setting it up”- Enable
module.statusPage. - Create monitors for the services your community cares about.
- Tick Show on the status page on the services people use, or mark monitors public on the Monitors page.
- Tell people the address.
Only public services and monitors appear. Everything else stays internal.
Services on the page
Section titled “Services on the page”A school with public services lists them first, under Services, each with its status in the same words as the desk: Working, Having problems, Down, Planned work or Not checked. A message a person set on the service shows under its name while it lasts, and a bar of the last 90 days shows when a monitor counts towards the service. The headline names what is wrong, such as Email and Wi-Fi are having problems, with Everything else is working. under it. When nothing is down or having problems, planned work is the headline, such as Planned work is under way on Wi-Fi, and it is never called an outage.
A service reads Planned work while a change that names it is under way inside its window, and Down while a major incident names it.
A public monitor that a public service depends on is shown as the service. Public monitors that belong to no public service follow, and a school with no public services sees the page as a list of its public monitors.
The page shows a service’s name, status, message and uptime, never what it depends on, its owner, its suppliers or a monitor’s target or error. Services for IT only, such as RADIUS, are never on it.
What to publish
Section titled “What to publish”Publish the things people ask about:
- Wi-Fi
- The intranet or learning platform
- Printing
- Email, if you run anything local
- The library system
Do not publish internal infrastructure. A monitor called DC01 or
10.0.4.19:8080 means nothing to a student and something useful to anybody
scanning your network.
Name public monitors in the words your community uses. “Wi-Fi”, not “Wireless controller HA pair”.
Telling people about it
Section titled “Telling people about it”A status page cuts no calls until people know it exists.
- Link it from the help centre.
- Put it on the ICT page of your intranet.
- Put the address in the automatic reply on your ICT mailbox during an outage.
- Mention it in the start-of-year ICT letter.
During a real outage
Section titled “During a real outage”The page reflects what your monitors see, which is not always the whole story. A monitor that is up while the service is unusable has a weak check; see the keyword assertion advice.
When you know more than the monitors do, Set status on the service says so, with a message of what people should do, for up to 24 hours. See setting it by hand. Naming the service on a major incident shows it Down here until the major incident ends.
For work you planned, name the service on the change. It reads Planned work while the change is in progress inside its window, and goes back to its monitors afterwards.
If the outage is Plugboard itself, so is the status page, so keep an external
uptime check on /api/health/ready as well. See keeping an eye on
it.
Branding
Section titled “Branding”Carries your branding.