2020-03-27 20:41:40 +00:00
|
|
|
Notify about health state
|
|
|
|
|
=========================
|
|
|
|
|
|
|
|
|
|
[◀ Go back to main README](../README.md)
|
|
|
|
|
|
2021-05-03 13:07:50 +00:00
|
|
|
🛈 This script can not be used on its own but requires the base 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:
|
|
|
|
|
|
2021-11-13 20:29:33 +00:00
|
|
|
* 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;
|
|
|
|
|
|
2021-06-17 13:23:51 +00:00
|
|
|
### Sample notifications
|
|
|
|
|
|
|
|
|
|
#### Voltage
|
|
|
|
|
|
2021-11-11 21:42:54 +00:00
|
|
|
|
2021-06-17 13:23:51 +00:00
|
|
|
|
|
|
|
|
#### Temperature
|
|
|
|
|
|
2021-11-11 21:42:54 +00:00
|
|
|
|
|
|
|
|
|
2021-06-17 13:23:51 +00:00
|
|
|
|
|
|
|
|
#### PSU state
|
|
|
|
|
|
2021-11-11 21:42:54 +00:00
|
|
|
|
|
|
|
|
|
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;
|
|
|
|
|
|
|
|
|
|
Configuration
|
|
|
|
|
-------------
|
|
|
|
|
|
2021-06-18 08:24:33 +00:00
|
|
|
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
|
2021-11-13 20:29:33 +00:00
|
|
|
* `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
|
|
|
|
|
|
2021-05-28 15:30:37 +00:00
|
|
|
Also notification settings are required for e-mail, matrix and/or telegram.
|
2020-03-27 20:41:40 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
[◀ Go back to main README](../README.md)
|
|
|
|
|
[▲ Go back to top](#top)
|
