From 79690b66cad113c10cbee5c9c4a09e9f6366be11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Soko=C5=82owski?= Date: Mon, 7 Dec 2020 12:40:09 +0100 Subject: [PATCH] re-organize the README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jakub SokoĊ‚owski --- README.md | 59 ++++++++++++++++++++++++++----------------------------- 1 file changed, 28 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 9001ed3..60e97e7 100644 --- a/README.md +++ b/README.md @@ -2,39 +2,8 @@ This role configures [AlertManager](https://prometheus.io/docs/alerting/alertmanager/) to notify people of threshold breaches in rules configured in Prometheus __master__ instance. -# Service - -AlertManager runs in a cluster to achieve high availability. The peer connect via [Tinc VPN](https://github.com/status-im/infra-role-bootstrap/tree/master/tasks/tinc). -The service listens on `:9093` and the Prometheus instance connects to that port via the VPN to inform it of threshold breaches. - -The service UI is available at: https://alerts.status.im/ - -# CLI Tool - -You can manage existing alerts by using the `amtool` on any of the hosts running this: -``` - > amtool alert -Alertname Starts At Summary -Test_Alert 2018-07-06 18:30:18 UTC This is a testing alert! - > amtool silence -ID Matchers Starts At Ends At Updated At Created By Comment -9635b573-5177-4601-a3b0-ac6a25d0a4ef alertname=InstanceDown 2018-07-06 12:37:04 UTC 2018-07-06 14:36:05 UTC 2018-07-06 12:37:04 UTC jakubgs test -``` - # Configuration -The main configuration resides in [`templates/alertmanager.yml.j2`](templates/alertmanager.yml.j2). It configures all the receivers of alerts generated by Prometheus __master__ instance. - -The are three main sections: - -* `global` - Configure general auth related options for SMTP and Slack receivers. -* `receivers` - Defines destinations of alets which can be used in the `route` section. -* `route` - Defines rules based on which alerts are directed to defined receivers. - -For more details see: https://prometheus.io/docs/alerting/configuration/ - -# Ansible Variables - The bare minimum should be: ```yml alertmanager_domain: 'alerts.example.org' @@ -48,3 +17,31 @@ alertmanager_victorops_api_key: 'secret-victorops-api-key' alertmanager_victorops_routing_key: 'alert-manager' ``` Take note you will have to create an `alert-manager` routing rule in VictorOps. + +# Management + +You can manage existing alerts by using the `amtool` on any of the hosts running this: +``` + > amtool alert +Alertname Starts At Summary +Test_Alert 2018-07-06 18:30:18 UTC This is a testing alert! + > amtool silence +ID Matchers Starts At Ends At Updated At Created By Comment +9635b573-5177-4601-a3b0-ac6a25d0a4ef alertname=InstanceDown 2018-07-06 12:37:04 UTC 2018-07-06 14:36:05 UTC 2018-07-06 12:37:04 UTC jakubgs test +``` + +# Details + +AlertManager runs in a cluster to achieve high availability. The peer connect via [Tinc VPN](https://github.com/status-im/infra-role-bootstrap/tree/master/tasks/tinc). +The service listens on `:9093` and the Prometheus instance connects to that port via the VPN to inform it of threshold breaches. + +The main configuration resides in [`templates/alertmanager.yml.j2`](templates/alertmanager.yml.j2). +It configures all the receivers of alerts generated by Prometheus __master__ instance. + +The are three main sections: + +* `global` - Configure general auth related options for SMTP and Slack receivers. +* `receivers` - Defines destinations of alets which can be used in the `route` section. +* `route` - Defines rules based on which alerts are directed to defined receivers. + +For more details see: https://prometheus.io/docs/alerting/configuration/