From ec535cc66a3e300dcadb13bb557382fbd48a9626 Mon Sep 17 00:00:00 2001 From: James Seward Date: Wed, 1 Jan 2025 21:29:22 +0000 Subject: [PATCH] Add docs for remotehosts monitor --- docs/monitors/remotehosts.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/monitors/remotehosts.rst diff --git a/docs/monitors/remotehosts.rst b/docs/monitors/remotehosts.rst new file mode 100644 index 00000000..fc7ae2c6 --- /dev/null +++ b/docs/monitors/remotehosts.rst @@ -0,0 +1,25 @@ +remotehosts - monitor remote simplemonitors +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This monitor inspects the state of the local simplemonitor instance to check expected remotes are sending data to it. + +.. warning:: At startup, simplemonitor doesn't know any remote hosts. They'll only be known once they've connected once, which means this monitor may fail initially. Consider using the ``tolerance`` option to reduce false positives. + +.. confval:: hosts + + :type: comma-separated list of string + :required: true + + the remote hosts to expect. This will need to be a list of IPs as simplemontitor doesn't reverse-lookup connections. However, if you want to give names to your remotes, you can use the ``custom_name`` property of the network logger and then specify that here. + +.. confval:: max_age + + :type: int + :required: false + :default: 300 + + the maximum time in seconds since a remote host last contacted us before it's considered missing + +.. note:: Note that depending on your OS/configuration, you may see IPv4 IPs with a ``::ffff:`` prefix. + +.. tip:: This monitor reports both missing and unexpected remotes, so you can use that to see what should go in your configuration.