mirror of
https://github.com/prymitive/karma
synced 2026-05-07 03:26:52 +00:00
feat(docs): Add more docs
This commit is contained in:
18
README.md
18
README.md
@@ -9,10 +9,26 @@ 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.
|
||||
on those tags (`@alertmanager`). Note that `@alertmanager` tags will be visible
|
||||
only if unsee 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
|
||||
first few alerts will be presented, the rest can be 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.
|
||||
Example:
|
||||
|
||||

|
||||
|
||||
Each group can be collapsed to only show the title bar using top right toggle
|
||||
icon.
|
||||
|
||||
[Online demo](https://unsee-demo.herokuapp.com/)
|
||||
|
||||
To get notifications about new unsee releases you can subscribe to the RSS feed
|
||||
|
||||
BIN
alertGroup.png
Normal file
BIN
alertGroup.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 195 KiB |
Reference in New Issue
Block a user