Skip to content

Commit

Permalink
Document alertmanager
Browse files Browse the repository at this point in the history
  • Loading branch information
nuriel77 committed Dec 21, 2017
1 parent b127407 commit cdde190
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
34 changes: 34 additions & 0 deletions docs/appendix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,37 @@ https://www.digitalocean.com/community/tutorials/how-to-create-a-self-signed-ssl
I encourage you to refer to the previous chapter about configuring FQDN for Peer Manager and Grafana. From there you can proceed to adding HTTPS to those configurations.



Sending Alert Notifications
===========================

Since release v1.1 a new feature has been introduced to support alerting.

This is considered an advanced feature. Configuration hereof requires some basic Linux and system configuration experience.

The monitoring system has a set of default alerting rules. These are configured to monitor various data of the full node.

|
For example:

* CPU load high
* Memory usage high
* Swap usage high
* Disk space low
* Too few or too many neighbors
* Inactive neighbors
* Milestones sync


It is possible to add or tweak existing rules. The alerting rules are part of Prometheus and are configured in ``/etc/prometheus/alert.rules.yml``.

The alerting manager is a daemon to which Prometheus will send alerts when they occur.


The configuration file for alertmanager can be found in ``/opt/prometheus/alertmanager/config.yml``. This is where you can set your email address and/or slack channel (not from iota!) to where you want to send the notifications.

The email template used for the emails can be found in ``/opt/prometheus/alertmanager/template/email.tmpl``.


For more information see `Documentation Prometheus Alertmanager <https://prometheus.io/docs/alerting/alertmanager/>`_
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ In this installation
* Password protect IOTA Peer Manager
* Optionally install `Nelson <https://github.com/SemkoDev/nelson.cli>`_.
* Install monitoring graphs. Big thanks to Chris Holliday's `IOTA Exporter <https://github.com/crholliday/iota-prom-exporter>`_.

* Alert notifications manager

.. note::

Expand Down

0 comments on commit cdde190

Please sign in to comment.