diff options
| -rw-r--r-- | check-health | 1 | ||||
| -rw-r--r-- | doc/check-health.md | 43 |
2 files changed, 44 insertions, 0 deletions
diff --git a/check-health b/check-health index a7ead46..ef9fd23 100644 --- a/check-health +++ b/check-health @@ -3,6 +3,7 @@ # Copyright (c) 2019-2020 Christian Hesse <mail@eworm.de> # # check for RouterOS health state +# https://git.eworm.de/cgit/routeros-scripts/about/doc/check-health.md :global CheckHealthLast; :global CheckHealthTemperature; diff --git a/doc/check-health.md b/doc/check-health.md new file mode 100644 index 0000000..37f8e34 --- /dev/null +++ b/doc/check-health.md @@ -0,0 +1,43 @@ +Notify about health state +========================= + +[◀ Go back to main README](../README.md) + +Description +----------- + +This script is run from scheduler periodically, sending notification on +health related events: + +* voltage jumps up or down more than configured threshold +* power supply failed or recovered +* temperature is above or below threshold + +Note that bad initial state will not trigger an event. + +Only sensors available in hardware can be checked. See what your +hardware supports: + + / system health print; + +Requirements and installation +----------------------------- + +Just install the script and create a scheduler: + + $ScriptInstallUpdate check-health; + / system scheduler add interval=1m name=check-health on-event="/ system script run check-health;" start-time=startup; + +Configuration +------------- + +The configuration goes to `global-config-overlay`, These are the parameters: + +* `CheckHealthTemperature`: an array specifying temperature thresholds for sensors +* `CheckHealthVoltagePercent`: percentage value to trigger voltage jumps + +Also notification settings are required for e-mail and telegram. + +--- +[◀ Go back to main README](../README.md) +[▲ Go back to top](#top) |