From 6786aba6e5563c9fdd8ccbe4b875f8cc92a90bd1 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] 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.