Skip to content
SHC Docs

Paging: the on-call lane

GoAlert holds the oncall league (ruling). It is the estate’s pager: on-call schedules, escalation policies, and delivery (SMS, voice, email, Slack, webhook) that keeps going until somebody acknowledges.

lanecarriervolumewhat it is for
visibilityMatrix room via hookshot (-i webhook=<hookshot>)everythinga team reads it
pagingGoAlert (-i goalert=<goalert-stack>)rarea human is woken

Producers feed both independently. Nothing bridges one into the other, on purpose: a pager that mirrors a chat room is a chat room with a siren.

Terminal window
shc install goalert -t <tenant> --stack oncall -i postgres=<pg> -i oidc=<keycloak> -i smtp=<mail>

Zero-touch: break-glass admin (vars.admin.username/vars.admin.password, vault), Keycloak login on the login page, email as a contact method, webhook destinations on, and an escalation policy named shc-default with no steps. Twilio (SMS + voice) is the one thing that cannot be zero-touch: it is your carrier account. Set vars.twilio.accountSid, authToken and fromNumber (all three, or nothing happens) or enter them under Admin → Config.

  1. Sign in with Keycloak. Add a contact method (SMS/voice/email) and a notification rule on your profile.
  2. Create a rotation and a schedule, or just pick users.
  3. Edit escalation policy shc-default: add a step that targets the schedule (or users), with a delay. Every service SHC mints is born on this policy; give a specific service its own policy later if it needs one.
producerbindwhat it does
Uptime Kumashc update <kuma-stack> -i goalert=<goalert-stack>adds the native GoAlert notification (default + applied to existing monitors); posts a proof alert on creation; down/up becomes one alert that opens and closes
Wazuhshc update <wazuh-stack> -i goalert=<goalert-stack>installs a custom-shc-goalert integrator; alerts at or above vars.goalertAlertLevel (default 12) page; dedup per rule + agent

Each bind mints ONE GoAlert service (named by the plug: uptime-kuma-<stack>, wazuh-<stack>) and one integration key. Disconnecting revokes the key and keeps the service with its alert history; delete it in the UI if unwanted.

Phase 2 (not built): PMM via keyType: grafana, CrowdSec via its http plugin.

Feeds that are NOT plugs (SHC core and modules)

Section titled “Feeds that are NOT plugs (SHC core and modules)”

Plugs are catalog-app-to-catalog-app. SHC core and modules cannot present as plugs, so these are operator setup:

SHC notifications → GoAlert. In GoAlert: Services → create shc-notifications on shc-default → Integration Keys → new Generic API key → copy the URL (it ends in /api/v2/generic/incoming?token=…). In SHC, add a notification rule with that URL; the module detects the goalert flavor from the path and ships a summary/details/dedup template; nothing else to fill in:

notifications:
- name: page-on-critical
url: https://goalert.example.com/api/v2/generic/incoming?token=<key>
on: ["V500*", "X5*"]

Test it: shc notification test page-on-critical.

OpenObserve → GoAlert. Same key shape. OpenObserve → Alerts → Destinations → new webhook destination with that URL, method POST, template body {"summary": "{alert_name}", "details": "{rows}", "dedup": "{alert_name}"}; attach it to the alerts that should page.

GoAlert owns no volumes. shc backup create -s <goalert-stack> --all-connected captures its database with it; vars.dataEncryptionKey (vault) must travel with the database or the stored config (OIDC secret, Twilio token, SMTP password) is unreadable after restore.