Skip to content
muster-ioPublic

About

Self-hosted alert grouping and response for Alertmanager: one editable message per Alert Group in Mattermost, Telegram or a webhook, with acknowledge, resolve and snooze.

Resources

Contributing

Security policy

Stars

6 stars

Watchers

1 watching

Forks

Latest commit

 

History

374 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Muster

Artifact Hub

Muster is a self-hosted alert grouping and on-call service that sits after Alertmanager. It turns Alertmanager's notifications into Alert Groups — one problem with a number, a status and an Owner — and shows each Alert Group as one editable message in Mattermost, in Slack, in Telegram, in any other messenger through a Bridge, or through an outgoing webhook. People acknowledge, resolve and snooze an Alert Group from the chat or the web UI, and Muster keeps its message current, sends a Loud update only when someone has to react and records everything in a Timeline and an Audit log.

An Alert Group arrives in the Muster web UI, is acknowledged from its page and resolves

Muster is an open alternative to Grafana IRM for teams that run Prometheus-style monitoring and want their alerting path to keep working inside their own network. One binary and one PostgreSQL database are a complete installation.

The whole web UI and the API work only after sign-in — with a password, through OpenID Connect, or with a token for automation — and each User's Role, Admin, Responder or Viewer, decides what they see and change. People link their messenger accounts to their User themselves, with Account links, so that a button pressed in a messenger acts as them.

Install

The first release, L1, is Muster 0.1.x. Requirements and tested versions lists what Muster needs and explains its version numbers and image tags.

  • Quick start: Docker Compose on one machine, beside its own PostgreSQL, in about five minutes.
  • Install with Helm: the chart oci://ghcr.io/muster-io/charts/muster on Kubernetes, with an external PostgreSQL.

The documentation covers installing, connecting Alertmanager and messengers, and running Muster. The product requirements, architecture decisions, database schema, API specification and the story contracts that the implementation follows are in design/ and api/.

Roadmap

Muster is built in four layers. Each layer is usable on its own and is the base for the next.

  • L1 — Alert Groups in messengers (the first release). Alertmanager webhooks read as Snapshots, with a Heartbeat per Integration; Routes and Group keys built in the UI; the Alert Group lifecycle — Firing, Acknowledged, Resolved, Snoozed — with Reopen, visible reasons and a Timeline; a web UI that also works on a phone; commands from the web UI, the API, Mattermost, Slack, Telegram and Bridges; one reconciled Root message per Destination, with Threads and Storm summaries; Bridges to any other messenger over the Bridge protocol, with the bridge libraries for Go, muster-bridge-go, and for Python, muster-bridge-python, and the example bridge in examples/chat of muster-bridge-go; outgoing webhooks; ack timeouts and Reminders; local and OIDC sign-in, TOTP, Account links, Personal access tokens, Service accounts and an Audit log; Muster's own metrics, alert rules and Internal alerts; a Quick start with Docker Compose, a Helm chart and the documentation site. See L1.
  • L2 — On-call parity. Schedules, rotations, escalations and paging the person on call; asking Alertmanager directly; a generic inbound webhook; backup Destinations; Alertmanager silence sync; a Terraform provider and an MCP server. See L2.
  • L3 — Incidents. A coordinated response to a problem that may span several Alert Groups, with its own lifecycle and record. See L3.
  • L4 — AI-assisted investigation. An optional module, off unless configured, that brings your own model: it summarizes the context of an Alert Group and later investigates it with read-only tools, adding the result to the message that has already been sent. See L4.

Design

Document Content
CONTEXT.md The glossary; its terms are used everywhere, code included
Product requirements What Muster does, layer by layer, and how to check it
Architecture decisions Every technical decision with its reasons and the alternatives
Architecture The system, its flows and state machines
Database schema Tables, invariants, indexes and retention
API Conventions of the HTTP API and its OpenAPI specification
Stories The contracts the implementation is built from, one pull request each

Building

You need Go 1.27, Node 24 (see .node-version), pnpm 12 (packageManager in web/package.json), GNU make and git. With the default GOTOOLCHAIN=auto, the go command fetches the toolchain that go.mod asks for.

make help                          # list the targets
make build && ./bin/muster version # muster 0.0.0-dev (commit <commit>)
make ci                            # the checks a pull request runs

Contributing

Read CONTRIBUTING.md and AGENTS.md, the guide for everyone who writes code for Muster, people and coding agents alike. Contributions are accepted under the Contributor License Agreement.

Licence

Muster is licensed under the GNU Affero General Public License, version 3 only (AGPL-3.0-only). Third-party code is listed in NOTICE.

The Bridge protocol specification, api/bridge.yaml, is licensed under the MIT License, so that a bridge may stay closed. The bridge libraries, muster-bridge-go and muster-bridge-python, and the example bridge, in examples/chat of muster-bridge-go, are MIT licensed too, in repositories of their own that take contributions without a CLA.

About

Self-hosted alert grouping and response for Alertmanager: one editable message per Alert Group in Mattermost, Telegram or a webhook, with acknowledge, resolve and snooze.

Resources

Contributing

Security policy

Stars

6 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages