routeros-scripts/doc/check-health.md
Michael Gisbers 8375673d93 global-functions: implement notifications via Matrix
Matrix is an open network for secure, decentralized communication - and
it has a web api.

A warning on message type: Using 'm.notice' breaks rendering on Element
for Android (no fixed width font) and does not pop up desktop
notification. Thus we use 'm.text'. Should be safe as we do not send the
messages in response to other messages.

https://matrix.org/
2021-06-08 21:07:25 +02:00

1.3 KiB

Notify about health state

◀ Go back to main README

🛈 This script can not be used on its own but requires the base installation. See main README for details.

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, matrix and/or telegram.


◀ Go back to main README
▲ Go back to top