aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2022-02-08 17:39:53 +0100
committerGravatar Christian Hesse <mail@eworm.de>2022-02-08 17:40:55 +0100
commit42c203291a7db814be00f40caddb6980632358fa (patch)
treec455fa438e36faf131643a10e14dab923deaeca4
parentdd19aea3628471ce54fefa30913879322f20e63a (diff)
doc/netwatch-notify: add sections
-rw-r--r--doc/netwatch-notify.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/netwatch-notify.md b/doc/netwatch-notify.md
index 78a0eed..9b504f7 100644
--- a/doc/netwatch-notify.md
+++ b/doc/netwatch-notify.md
@@ -38,6 +38,8 @@ The hosts to be checked have to be added to netwatch with specific comment:
/ tool netwatch add comment="notify, hostname=example.com" host=[ :resolve "example.com" ];
+### Hooks
+
It is possible to run an up hook command (`up-hook`) or down hook command
(`down-hook`) when a notification is triggered. This has to be added in
comment, note that some characters need extra escaping:
@@ -48,10 +50,14 @@ Also there is a `pre-down-hook` that fires at two thirds of failed checks
required for the notification. The idea is to fix the issue before a
notification is sent.
+### Count threshould
+
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;
+### Parents & dependencies
+
If the host is behind another checked host add a dependency, this will
suppress notification if the parent host is down:
@@ -61,6 +67,8 @@ suppress notification if the parent host is down:
Note that every configured parent in a chain increases the check count
threshould by one.
+### Update from DNS
+
The host address can be updated dynamically. Give extra parameter `resolve`
with a resolvable name: