Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(docs): mention @cluster in docs #1834

Merged
merged 2 commits into from
Jun 14, 2020
Merged

fix(docs): mention @cluster in docs #1834

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
003197e
fix(docs): recommend alertmanager 0.19.0 in docs
prymitive Jun 14, 2020
8110d08
fix(docs): mention @cluster in docs
prymitive Jun 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ Alert dashboard for
Starting with karma v0.56 only Alertmanager V2 API is supported, which
requires Alertmanager `>=0.17.0`.

Alertmanager `>=0.19.0` is recommended as older versions might not show all
receivers in karma, see
[issue #812](https://github.com/prymitive/karma/issues/812) for details.

---

See [GitHub Releases](https://github.com/prymitive/karma/releases) for release
Expand All @@ -26,14 +30,21 @@ displayed by filtering duplicates. Each alert is tagged with the names of all
Alertmanager instances it was found at and can be filtered based on those tags
(`@alertmanager`). Note that `@alertmanager` tags will be visible only if karma
is configured with multiple Alertmanager instances.
If alertmanger is configured to use
[HA clusters](https://prometheus.io/docs/alerting/latest/alertmanager/#high-availability)
then `@cluster` will be available as well, to set a custom name for each cluster
see [CONFIGURATION.md](docs/CONFIGURATION.md#alertmanagers).

![Screenshot](/docs/img/screenshot.png)

### Alert visualization

Alerts are displayed grouped preserving
[group_by](https://prometheus.io/docs/alerting/configuration/#route)
configuration option in Alertmanager. If a group contains multiple alerts only
configuration option in Alertmanager.
Note that a unique alert group will be created for each receiver it uses in
alertmanager as they can have different `group_by` settings.
If a group contains multiple alerts only
the first few alerts will be presented. Alerts are expanded or hidden
using - / + buttons. The default number of alerts can be configured in the UI
settings module.
Expand Down Expand Up @@ -65,7 +76,7 @@ grid, including an extra grid for alerts without that label present.
Silence modal allows to create new silences and manage all silences already
present in Alertmanager.
Silence ACL rules can be used to control silence creation and editing, see
[ACLs](/docs/ACLs.md) docs for more details.
[ACLs](/docs/ACLs.md) docs for more details.

![Silence browser](/docs/img/silenceBrowser.png)

Expand Down