From 003197edd4a6af7511211269705877dab7540dbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Mierzwa?= Date: Sun, 14 Jun 2020 17:19:14 +0100 Subject: [PATCH 1/2] fix(docs): recommend alertmanager 0.19.0 in docs --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a766987fb..21f7aa496 100644 --- a/README.md +++ b/README.md @@ -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 @@ -65,7 +69,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) From 8110d08481752626f31b9c50f7759d3802a6e127 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Mierzwa?= Date: Sun, 14 Jun 2020 17:25:45 +0100 Subject: [PATCH 2/2] fix(docs): mention @cluster in docs --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 21f7aa496..f48a1ca0f 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,10 @@ 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) @@ -37,7 +41,10 @@ is configured with multiple Alertmanager instances. 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.