diff options
| author | Ben Kochie <superq@gmail.com> | 2018-03-15 12:15:24 +0100 |
|---|---|---|
| committer | Ben Kochie <superq@gmail.com> | 2018-03-15 12:15:24 +0100 |
| commit | aa242bfa95a36c7ccb50c2546b0210c203774eaf (patch) | |
| tree | 312b6c48a881a03f06e5bf168bd2cd0939cd51a1 | |
| parent | 0c375c8045f7169e4cead1568d60649039904054 (diff) | |
| download | gitlab-ce-bjk/alertmanager_docs.tar.gz | |
Document the Prometheus Alertmanagerbjk/alertmanager_docs
Add basic documentation for the Prometheus Alertmanager.
| -rw-r--r-- | doc/administration/monitoring/prometheus/alertmanager.md | 29 | ||||
| -rw-r--r-- | doc/administration/monitoring/prometheus/index.md | 6 |
2 files changed, 35 insertions, 0 deletions
diff --git a/doc/administration/monitoring/prometheus/alertmanager.md b/doc/administration/monitoring/prometheus/alertmanager.md new file mode 100644 index 00000000000..81cfc9e8409 --- /dev/null +++ b/doc/administration/monitoring/prometheus/alertmanager.md @@ -0,0 +1,29 @@ +# Alertmanager + +>**Note:** +Available since [Omnibus GitLab 10.6][2205]. For installations from source +you'll have to install and configure it yourself. + +The Prometheus [Alertmanager][alertmanager] allows you to route Prometheus alerts to users. + +To enable the Alertmanager: + +1. [Enable Prometheus](index.md#configuring-prometheus) +1. Edit `/etc/gitlab/gitlab.rb` +1. Add or find and uncomment the following lines: + + ```ruby + alertmanager['enable'] = true + alertmanager['admin_email'] = 'admin@example.com' + ``` +1. Configure [SMTP][smtp] for sending email. +1. Save the file and [reconfigure GitLab][reconfigure] for the changes to + take effect + + +[← Back to the main Prometheus page](index.md) + +[2205]: https://gitlab.com/gitlab-org/omnibus-gitlab/merge_requests/2205 +[alertmanager]: https://github.com/prometheus/alertmanager +[reconfigure]: ../../restart_gitlab.md#omnibus-gitlab-reconfigure +[smtp]: https://docs.gitlab.com/omnibus/settings/smtp.html diff --git a/doc/administration/monitoring/prometheus/index.md b/doc/administration/monitoring/prometheus/index.md index f43c89dad87..ec02f493149 100644 --- a/doc/administration/monitoring/prometheus/index.md +++ b/doc/administration/monitoring/prometheus/index.md @@ -119,6 +119,12 @@ GitLab monitors its own internal service metrics, and makes them available at th [➔ Read more about the GitLab Metrics.](gitlab_metrics.md) +## Prometheus Alertmanager + +The Prometheus Alertmanager is used to route notifications from alerting rules to users. + +[➔ Read more about the Alertmanager.](alertmanager.md) + ## Prometheus exporters There are a number of libraries and servers which help in exporting existing |