aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/netwatch-notify.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/netwatch-notify.md b/doc/netwatch-notify.md
index 557ae88..11371ff 100644
--- a/doc/netwatch-notify.md
+++ b/doc/netwatch-notify.md
@@ -8,8 +8,9 @@ Description
This script sends notifications about host UP and DOWN events. In comparison
to just netwatch (`/ tool netwatch`) and its `up-script` and `down-script`
-this script implements a simple state machine. Host down events are triggered
-only if the host is down for several checks to avoid false alerts.
+this script implements a simple state machine and dependency model. Host
+down events are triggered only if the host is down for several checks and
+optional parent host is not down to avoid false alerts.
Requirements and installation
-----------------------------
@@ -39,6 +40,15 @@ The count threshould (default is 5 checks) is configurable as well:
/ tool netwatch add comment="notify, hostname=example.com, count=10" host=104.18.144.11;
+If the host is behind another checked host add a dependency, this will
+suppress notification if the parent host is down:
+
+ / tool netwatch add comment="notify, hostname=gateway" host=93.184.216.1;
+ / tool netwatch add comment="notify, hostname=example.com, parent=gateway" host=93.184.216.34;
+
+Note that every configured parent in a chain increases the check count
+threshould by one.
+
Also notification settings are required for e-mail and telegram.
---