Update README.md

This commit is contained in:
Drew DeVault 2020-01-06 10:04:15 -05:00
parent ec727ab3a3
commit a230739c40
1 changed files with 16 additions and 0 deletions

View File

@ -6,3 +6,19 @@ package from mirror.sr.ht (for Alpine only) as metrics.sr.ht-rules.
Our Prometheus instance is public:
https://metrics.sr.ht
## Usage instructions
1. Install our package
2. Add our `rules_files` entries to your `prometheus.yml` for each set of rules
you wish to use
3. Configure alertmanager accordingly
Our alerts are categorized into three severity groups:
- **interesting** alerts are worth noting, as they may be useful in identifying
trends over time, for forensic attention after an outage, or for addressing on
a rainy day. Upstream, we send these to our IRC channel.
- **important** alerts are likely to be actionable, but do not require immediate
attention.
- **urgent** alerts require immediate attention.