Monitors
/monitors. Needs module.monitors.
Uptime monitoring of the services your school depends on: the intranet, the print server, the Wi-Fi controller, the library system.
Monitor kinds
Section titled “Monitor kinds”| Kind | Checks |
|---|---|
| HTTP | A GET or HEAD against a URL, optionally asserting a status code or a keyword in the body |
| TCP | Opens a socket to a host and port |
| TLS | Completes a handshake and checks certificate expiry |
| PING | Best-effort reachability |
| AGENT | Heartbeat freshness of a connector agent |
The agent kind is inverted from the others. Nothing can reach an agent inside a customer network, so the check is “did it report recently” rather than an outbound probe.
Creating one
Section titled “Creating one”Give it a name, a kind, a target, an interval and a timeout.
Intranet is a better name than http://10.0.4.19:8080, because the name is
what appears in an alert and on the public status page.
The keyword assertion
Section titled “The keyword assertion”A web server returning 200 with an error page is a service that is down and a check that passes.
Assert on a keyword that appears only when the service works: a student’s name on a dashboard, or a term that renders after a successful database query.
Alerts
Section titled “Alerts”Monitors raise severity-based alerts when something goes down or degrades. The
alert appears in the desk for staff who can view monitors. When the severity’s
channels include email and an email connector is configured, the monitor.down
email goes to every active staff account whose
role grants monitor.view.
There is no separate recipient address. If a shared, monitored mailbox should
receive alerts while people are on leave, give it a staff account with
monitor.view.
When changes touch a monitor that goes down, people who can see changes get a second line with the alert: Library system is down. Changed in the last 72 hours: and the first three changes.
An alert about one monitor opens that monitor’s detail on Monitors, and so does every other link to one monitor: from a service’s Depends on, Home’s Service health, a change’s connected records, a flow’s subject and the evidence behind an outage Plugboard spots.
What changed before it
Section titled “What changed before it”While a monitor is down, its detail lists Changed in the last 72 hours: the
changes in progress, or implemented
with a window in the 72 hours before it went down, that link this monitor or
the network device it watches, or that are at its campus or the whole school’s.
A monitor’s campus is its place on the school map, or its network device’s
campus. Each change says why it is listed. It needs change.view, and says
nothing when no change is near.
Link a monitor to the changes that touch it, under Connected records on the change, so the list finds them by the monitor and not by campus alone.
Used by
Section titled “Used by”A monitor’s detail lists Used by: the services that depend on it, with each one’s status and whether this monitor counts towards it. The monitors that count decide a service’s status together: it is Down when every one is down, and Having problems when some are.
Make a service from this monitor, for people with service.manage, makes a
service named after the monitor, with its other names, depending on it and
counting it towards its status. See start from a
monitor.
History
Section titled “History”Each monitor keeps its check history, which tells a service that fails one check in twenty apart from one that has been down since Tuesday.
Publishing
Section titled “Publishing”Mark a monitor public and it appears on the public status
page at /status, which needs module.statusPage. A
public monitor that a public service depends on is shown as
that service, in the service’s name and status.
Publish the things your community asks about: the Wi-Fi, the intranet, the printing. Do not publish internal infrastructure whose name would mean nothing to a student and everything to somebody scanning your network.
Do not monitor Plugboard with Plugboard
Section titled “Do not monitor Plugboard with Plugboard”A monitor that lives inside the thing it is watching cannot tell you the thing is down.
Point an external uptime check at /api/health/ready. See keeping an eye on
it.
Private addresses
Section titled “Private addresses”Plugboard blocks outbound requests to private, loopback and link-local addresses by default, so a monitor target cannot be used to reach internal hosts or a cloud metadata service.
A self-hosted install that legitimately monitors LAN addresses needs:
ALLOW_PRIVATE_EGRESS=1A managed deployment needs a connector agent instead, or a target reachable from the internet.
Permissions
Section titled “Permissions”| Permission | Allows |
|---|---|
monitor.view | See monitors and their history |
monitor.manage | Create and configure them |
Used by also needs service.view.