diff --git a/docs/appendix.rst b/docs/appendix.rst index 634b7ba..5d920f4 100644 --- a/docs/appendix.rst +++ b/docs/appendix.rst @@ -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 `_ diff --git a/docs/index.rst b/docs/index.rst index 1ea1b18..42e8326 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -24,7 +24,7 @@ In this installation * Password protect IOTA Peer Manager * Optionally install `Nelson `_. * Install monitoring graphs. Big thanks to Chris Holliday's `IOTA Exporter `_. - +* Alert notifications manager .. note::