routeros-scripts/doc/check-health.md

67 lines
2 KiB
Markdown
Raw Normal View History

2020-03-27 20:41:40 +00:00
Notify about health state
=========================
[⬅️ Go back to main README](../README.md)
2020-03-27 20:41:40 +00:00
> **Info**: This script can not be used on its own but requires the base
2022-02-11 22:34:39 +00:00
> installation. See [main README](../README.md) for details.
2020-03-27 20:41:40 +00:00
Description
-----------
This script is run from scheduler periodically, sending notification on
health related events:
* voltage jumps up or down more than configured threshold or drops below limit
2020-03-27 20:41:40 +00:00
* 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;
2020-03-27 20:41:40 +00:00
2021-06-17 13:23:51 +00:00
### Sample notifications
#### Voltage
![check-health notification voltage](check-health.d/notification-01-voltage.avif)
2021-06-17 13:23:51 +00:00
#### Temperature
![check-health notification](check-health.d/notification-02-temperature-high.avif)
![check-health notification](check-health.d/notification-03-temperature-ok.avif)
2021-06-17 13:23:51 +00:00
#### PSU state
![check-health notification](check-health.d/notification-04-psu-fail.avif)
![check-health notification](check-health.d/notification-05-psu-ok.avif)
2021-06-17 13:23:51 +00:00
2020-03-27 20:41:40 +00:00
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;
2020-03-27 20:41:40 +00:00
Configuration
-------------
The configuration goes to `global-config-overlay`, these are the parameters:
2020-03-27 20:41:40 +00:00
* `CheckHealthTemperature`: an array specifying temperature thresholds for sensors
* `CheckHealthVoltageLow`: value (in volt*10) giving a hard lower limit
2020-03-27 20:41:40 +00:00
* `CheckHealthVoltagePercent`: percentage value to trigger voltage jumps
Also notification settings are required for
[e-mail](mod/notification-email.md),
2021-11-16 15:03:25 +00:00
[matrix](mod/notification-matrix.md) and/or
2021-11-16 15:03:43 +00:00
[telegram](mod/notification-telegram.md).
2020-03-27 20:41:40 +00:00
---
[⬅️ Go back to main README](../README.md)
[⬆️ Go back to top](#top)