diff --git a/README.md b/README.md index 48914ff5e..2955d649e 100644 --- a/README.md +++ b/README.md @@ -5,23 +5,23 @@ Alert dashboard for Alertmanager UI is useful for browsing alerts and managing silences, but it's lacking as a dashboard tool - karma aims to fill this gap. -Starting with `0.7.0` release it can also aggregate alerts from multiple -Alertmanager instances, running either in HA mode or separate. Duplicated alerts -are deduplicated so only unique alerts are displayed. Each alert is tagged with -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. +Starting with the `0.7.0` release it can aggregate alerts from multiple +Alertmanager instances, running either in HA mode or separate. Unique alerts are +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. ![Screenshot](/screenshot.png) 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 -first few alerts will be presented, the rest can be expanded or hidden +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. -Each individual alert will only show unique labels and annotations, labels -and annotations that are shared between all alerts will be moved to the footer. +Each individual alert will show unique labels and annotations. Labels +and annotations that are shared between all alerts are moved to the footer. Example: ![Example](/alertGroup.png)