mirror of
https://github.com/eworm-de/routeros-scripts.git
synced 2026-01-15 05:29:32 +00:00
875ac9f7c3
This was introduced with RouterOS 7.22beta1. Initializing $LogForwardLast with boolean value looks odd, but this is reuqired to match the very first message.
103 lines
4.2 KiB
Markdown
103 lines
4.2 KiB
Markdown
Forward log messages via notification
|
||
=====================================
|
||
|
||
[](https://github.com/eworm-de/routeros-scripts/stargazers)
|
||
[](https://github.com/eworm-de/routeros-scripts/network)
|
||
[](https://github.com/eworm-de/routeros-scripts/watchers)
|
||
[](https://mikrotik.com/download/changelogs/)
|
||
[](https://t.me/routeros_scripts)
|
||
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A4ZXBD6YS2W8J)
|
||
|
||
[⬅️ Go back to main README](../README.md)
|
||
|
||
> ℹ️ **Info**: This script can not be used on its own but requires the base
|
||
> installation. See [main README](../README.md) for details.
|
||
|
||
Description
|
||
-----------
|
||
|
||
RouterOS itself supports sending log messages via e-mail or to a syslog
|
||
server (see `/system/logging`). This has some limitation, however:
|
||
|
||
* does not work early after boot if network connectivity is not
|
||
yet established, or breaks intermittently
|
||
* lots of messages generate a flood of mails
|
||
* Gotify, Matrix, Ntfy and Telegram are not supported
|
||
|
||
The script works around the limitations, for example it does:
|
||
|
||
* read from `/log`, including messages from early boot
|
||
* skip multi-repeated messages
|
||
* rate-limit itself to mitigate flooding
|
||
* forward via notification (which includes *e-mail*, *Gotify*, *Matrix*,
|
||
*Ntfy* and *Telegram* when installed and configured, see below)
|
||
|
||
It is intended to be run periodically from scheduler, then collects new
|
||
log messages and forwards them via notification.
|
||
|
||
### Sample notifications
|
||
|
||
|
||
|
||
|
||
Requirements and installation
|
||
-----------------------------
|
||
|
||
Just install the script:
|
||
|
||
$ScriptInstallUpdate log-forward;
|
||
|
||
... and add a scheduler:
|
||
|
||
/system/scheduler/add interval=1m name=log-forward on-event="/system/script/run log-forward;" start-time=startup;
|
||
|
||
Configuration
|
||
-------------
|
||
|
||
The default configuration should provide reasonable presets, filtering
|
||
*info*, and effectively forwarding *warning* and *error*.
|
||
|
||
> 💡️ **Hint**: Please try with defaults first, especially if you are not
|
||
> familiar with regular expressions!
|
||
|
||
The configuration goes to `global-config-overlay`, these are the parameters:
|
||
|
||
* `LogForwardFilter`: define topics *not* to be forwarded
|
||
* `LogForwardFilterMessage`: define message text *not* to be forwarded
|
||
* `LogForwardInclude`: define topics to be forwarded (even if filter matches)
|
||
* `LogForwardIncludeMessage`: define message text to be forwarded (even if
|
||
filter matches)
|
||
|
||
> ℹ️ **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.
|
||
|
||
These patterns are matched as
|
||
[regular expressions ↗️](https://wiki.mikrotik.com/wiki/Manual:Regular_Expressions).
|
||
To forward **all** (ignoring severity) log messages with topics `account`
|
||
(which includes user logins) and `dhcp` you need something like:
|
||
|
||
:global LogForwardInclude "(account|dhcp)";
|
||
|
||
Also notification settings are required for
|
||
[e-mail](mod/notification-email.md),
|
||
[gotify](mod/notification-gotify.md),
|
||
[matrix](mod/notification-matrix.md),
|
||
[ntfy](mod/notification-ntfy.md) and/or
|
||
[telegram](mod/notification-telegram.md).
|
||
|
||
Tips & Tricks
|
||
-------------
|
||
|
||
### Notification on reboot
|
||
|
||
You want to receive a notification on every device (re-)boot? Quite easy,
|
||
just add:
|
||
|
||
:global LogForwardIncludeMessage "(^router rebooted)";
|
||
|
||
This will match on every log message beginning with `router rebooted`.
|
||
|
||
---
|
||
[⬅️ Go back to main README](../README.md)
|
||
[⬆️ Go back to top](#top)
|