2020-03-27 20:41:40 +00:00
Notify about health state
=========================
2024-03-06 13:30:18 +00:00
[![GitHub stars ](https://img.shields.io/github/stars/eworm-de/routeros-scripts?logo=GitHub&style=flat&color=red )](https://github.com/eworm-de/routeros-scripts/stargazers)
[![GitHub forks ](https://img.shields.io/github/forks/eworm-de/routeros-scripts?logo=GitHub&style=flat&color=green )](https://github.com/eworm-de/routeros-scripts/network)
[![GitHub watchers ](https://img.shields.io/github/watchers/eworm-de/routeros-scripts?logo=GitHub&style=flat&color=blue )](https://github.com/eworm-de/routeros-scripts/watchers)
[![required RouterOS version ](https://img.shields.io/badge/RouterOS-7.12-yellow?style=flat )](https://mikrotik.com/download/changelogs/)
[![Telegram group @routeros_scripts ](https://img.shields.io/badge/Telegram-%40routeros__scripts-%2326A5E4?logo=telegram&style=flat )](https://t.me/routeros_scripts)
[![donate with PayPal ](https://img.shields.io/badge/Like_it%3F-Donate!-orange?logo=githubsponsors&logoColor=orange&style=flat )](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick& hosted_button_id=A4ZXBD6YS2W8J)
2023-01-10 13:45:27 +00:00
[⬅️ Go back to main README ](../README.md )
2020-03-27 20:41:40 +00:00
2022-02-12 12:05:56 +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.
2021-05-03 13:07:50 +00:00
2020-03-27 20:41:40 +00:00
Description
-----------
This script is run from scheduler periodically, sending notification on
health related events:
2023-02-14 19:09:41 +00:00
* high CPU utilization
2023-10-24 14:26:14 +00:00
* high RAM utilization (low available RAM)
2023-02-13 10:15:06 +00:00
* voltage jumps up or down more than configured threshold
* voltage drops below hard lower 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.
2023-10-24 14:26:14 +00:00
Monitoring CPU and RAM utilization (available processing and memory
resources) works on all devices. Other than that only sensors available
in hardware can be checked. See what your hardware supports:
2020-03-27 20:41:40 +00:00
2022-05-11 07:57:09 +00:00
/system/health/print;
2020-03-27 20:41:40 +00:00
2021-06-17 13:23:51 +00:00
### Sample notifications
2023-02-14 19:09:41 +00:00
#### CPU utilization
2023-01-20 13:24:20 +00:00
2023-02-14 19:09:41 +00:00
![check-health notification cpu utilization high ](check-health.d/notification-01-cpu-utilization-high.avif )
![check-health notification cpu utilization ok ](check-health.d/notification-02-cpu-utilization-ok.avif )
2023-01-20 13:24:20 +00:00
2023-10-24 14:26:14 +00:00
#### RAM utilization (low available RAM)
2023-01-20 13:34:18 +00:00
2023-10-24 14:26:14 +00:00
![check-health notification ram utilization high ](check-health.d/notification-03-ram-utilization-high.avif )
![check-health notification ram utilization ok ](check-health.d/notification-04-ram-utilization-ok.avif )
2023-01-20 13:34:18 +00:00
2021-06-17 13:23:51 +00:00
#### Voltage
2023-01-20 13:34:18 +00:00
![check-health notification voltage ](check-health.d/notification-05-voltage.avif )
2021-06-17 13:23:51 +00:00
#### Temperature
2023-01-20 13:34:18 +00:00
![check-health notification temperature high ](check-health.d/notification-06-temperature-high.avif )
![check-health notification temperature ok ](check-health.d/notification-07-temperature-ok.avif )
2021-06-17 13:23:51 +00:00
#### PSU state
2023-01-20 13:34:18 +00:00
![check-health notification psu fail ](check-health.d/notification-08-psu-fail.avif )
![check-health notification psu ok ](check-health.d/notification-09-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;
2023-03-31 15:45:55 +00:00
/system/scheduler/add interval=53s name=check-health on-event="/system/script/run check-health;" start-time=startup;
> ℹ ️ **Info**: Running lots of scripts simultaneously can tamper the
> precision of cpu utilization, escpecially on devices with limited
> resources. Thus an unusual interval is used here.
2020-03-27 20:41:40 +00:00
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
2023-06-07 12:12:01 +00:00
> ℹ ️ **Info**: Copy relevant configuration from
> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
> your local `global-config-overlay` and modify it to your specific needs.
2022-09-23 13:07:30 +00:00
Also notification settings are required for
[e-mail ](mod/notification-email.md ),
2023-10-11 05:40:55 +00:00
[matrix ](mod/notification-matrix.md ),
[ntfy ](mod/notification-ntfy.md ) and/or
2021-11-16 15:03:43 +00:00
[telegram ](mod/notification-telegram.md ).
2020-03-27 20:41:40 +00:00
---
2023-01-10 13:45:27 +00:00
[⬅️ Go back to main README ](../README.md )
[⬆️ Go back to top ](#top )