summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2023-06-01 20:55:52 +0300
committerPaul Buetow <paul@buetow.org>2023-06-01 20:55:52 +0300
commit125c4c8a8d6e78e55d6d88977c1f8a244c07b6a4 (patch)
treeae6bbcf8846da3730504ae3731da20a2e9d265e9
parent0dc22f943e9e45c16da4815bf971a4253bc56d0b (diff)
add retry docs
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index fa6e186..02ea034 100644
--- a/README.md
+++ b/README.md
@@ -138,12 +138,14 @@ To configure Gogios, create a JSON configuration file (e.g., `/etc/gogios.json`)
* `CheckTimeoutS`: Sets the timeout for checks in seconds.
* `CheckConcurrency`: Determines the number of concurrent checks that can run simultaneously.
* `StateDir`: Specifies the directory where Gogios stores its persistent state in a `state.json` file.
-* `Checks`: Defines a list of checks to be performed, each with a unique name, plugin path, and arguments.
+* `Checks`: Defines a list of checks to be performed, each with a unique name, plugin path, and arguments.
Adjust the configuration file according to your needs, specifying the checks you want Gogios to perform.
If you want to execute checks only when another check succeeded (status OK), use `DependsOn`. In the example above, the HTTP checks won't run when the hosts aren't pingable. They will show up as `UNKNOWN` in the report.
+`Retries` and `RetryInterval` are optional check configuration parameters. In case of failure, Gogios will retry `Retries` times each `RetryInterval` seconds.
+
For remote checks, use the `check_nrpe` plugin. You also need to have the NRPE server set up correctly on the target host (out of scope for this document).
The `state.json` file mentioned above keeps track of the monitoring state and check results between Gogios runs, enabling Gogios only to send email notifications when there are changes in the check status.