Alarm Pages

An alarm page is a view of the alarms a reader may read: the Active count, one tile per pinned layer, the timeline, the incident list and the detail panel — the Alarms page, with its own tiles.

Every deployment has the default alarm page at /alarms, shown in the sidebar as Alarms. You can add named pages, for example one per team, each pinning the layers — and, within a layer, the service groups — that team watches. A named page is its own row in the sidebar, right after Alarms, and opens at /alarms/<id>.

What a page shows

Which alarms a reader may see is decided by their alarms:read permission alone; no page adds to them.

• Alarms, the default page, shows all of them: a tile per pin, an Other tile for the alarms no pin covers, and a tab above the list for every other layer with an active alarm.
• A named page shows only the alarms its pins cover. It has no Other tile and no extra layer tabs, and its filter row offers only its own layers and the services its pins cover. So Payments on-call pinning GENERAL[payments] lists, and lets you filter by, the payments services only — for a reader who may read every GENERAL service too.

A named page narrows what a reader sees; it never widens it. To keep a team to its own alarms everywhere, limit its role, for example alarms:read@GENERAL[payments] — see Roles and Permissions.

Pins

A pin is a layer, optionally narrowed to OAP service groups in it, written the way a role limits a permission:

The services an alarm concerns are the service it is raised on — for an instance or an endpoint, the service that owns it — and, for a relation, the service at either end. A service group is the part of a service’s name before :: (payments::checkout is in payments). An alarm counts under every tile it matches, so the tiles can add up to more than Active.

Who sees which page

• Alarms (the default page) is shown to every role that holds alarms:read, on any layer.
• A named page is shown to a role that reaches at least one of its pins: alarms:read without a layer reaches every pin (a Platform monitoring layer also needs cluster:read); alarms:read@GENERAL reaches every GENERAL pin; alarms:read@GENERAL[payments] reaches GENERAL and GENERAL[payments], but not GENERAL[risk].
• On any page, the pins a role cannot reach are left out, and a note says how many. A pin with several groups keeps the groups the role reaches.
• An address of a page the role is not shown reads “This alarm page does not exist or is not available to you.”

Setting up pages

Alarm pages are set up at Dashboard setup → Alarm pages (/admin/alert-page-setup). Viewing it needs alarm-setup:read; saving, adding and deleting need alarm-setup:write. Named pages are stored on OAP, so they exist only with templates.mode: live; in readonly mode there is only the default page.

The page lists Alarms (default) first, then the named pages. Select one to edit it:

• Page — named pages only: the Title shown in the sidebar and as the page heading, and the Order among the named pages (lower first, then by title).
• Pinned — up to 8 pins, in tile order. Add a pin by choosing a layer — the layers your own role sees in the sidebar are offered, whether or not they have services now — and, optionally, one or more service groups. The groups of the layer’s services your role reads are suggested; you may type another, and a group none of them has at the moment is saved with a warning. A group whose name contains ,, [ or ], or is -, cannot be written in a pin.
• Default time window — the window the page opens on: 20 minutes, 2 hours or 4 hours. A named page can also take the default page’s.
• Overview alarms widget — default page only: the Fetch cap, how many alarms an overview Alarms widget reads.

+ New page asks for an id and a title. The id becomes the page’s address, /alarms/<id>: lowercase letters, digits, - and _, and neither default nor page-setup. Delete removes a named page from every reader’s sidebar; its id cannot be given to a new page afterwards. The default page cannot be deleted.

The default page’s window also sets the window of the alarm count in the sidebar and the top bar.

Stored format

Each page is one OAP UI template record. The admin page reads and writes these; the fields are listed here for reference and for authoring outside the UI.

The default page, horizon.alert.default:

{
  "pinnedLayers": ["GENERAL", "MESH"],
  "defaultWindowMs": 1200000,
  "overviewAlarmsLimit": 200
}

A named page, horizon.alert.<id>:

{
  "id": "payments",
  "title": "Payments on-call",
  "order": 10,
  "pinnedLayers": ["GENERAL[payments]", "MESH[payments]"],
  "defaultWindowMs": 7200000
}