Muster¶

Muster is a self-hosted alert grouping and on-call service that sits after Alertmanager. It groups Alerts into Alert Groups, the problems people act on; keeps one editable message per Alert Group in Mattermost, in Telegram, in any other messenger through a Bridge, or behind an outgoing webhook; and lets people acknowledge, resolve and snooze Alert Groups.

flowchart LR
  am["Alertmanager"] -- "Snapshots" --> integration
  subgraph muster["Muster"]
    integration["Integration"] --> routes["Routes"] --> groups["Alert Groups"]
  end
  subgraph destinations["Destinations"]
    mm["Mattermost"]
    tg["Telegram"]
    br["Bridge"]
    wh["Outgoing webhook"]
  end
  groups --> mm
  groups --> tg
  groups --> br
  groups --> wh

The Alertmanager of each cluster sends its notifications to an Integration of Muster. Routes pick Alerts by their labels, group them into Alert Groups and decide the Destinations they are delivered to, and Muster keeps the message of each Alert Group there up to date until the Alert Group is resolved.

Sections¶

• Quick start: run Muster with Docker Compose, sign in, connect Alertmanager and send a test alert, in about five minutes.
• Install: run Muster in production with Helm and an external PostgreSQL, and read the requirements and tested versions and how to verify a release.
• Integrations: connect the Alertmanager of a cluster, connect Grafana Alerting directly or through an Alertmanager, and watch the path from Alertmanager with a Heartbeat.
• Messengers: see what each Destination type can do, connect Mattermost and Telegram, reach any other messenger through a Bridge (and write one), link your messenger accounts, and set a proxy for a client.
• Outgoing webhooks: send the lifecycle events of Alert Groups in the events mode, or keep a message in any chat in the template mode; recipes for a phone call, a status page, a second chat and an issue tracker.
• Configure: change what messages and templates say, add links with Lookup tables and Link rules, set the Organization, and automate with API tokens.
• Sign-in: Roles and ways to sign in; OpenID Connect with Keycloak, TOTP, and closed networks.
• Concepts: what an Alert Group is, how Routes and Group keys group Alerts, the rules of Snapshots, Loud and Quiet messages, the statuses and commands, and Broken Destinations.
• Operations: back up and restore, upgrade, rotate the master keys, run more than one replica, monitor Muster, set an outgoing heartbeat, use the command line, and read the Request log.
• Runbooks: what each alert about Muster means and how to fix it.
• Reference: metrics, log events, Internal alerts, environment variables, chart values, the API and the Bridge protocol.

AI agents¶

AI agents and coding assistants start at llms.txt: the map of this documentation for agents, with a Markdown version of every page and the full text in one file.