routeros-scripts/doc/log-forward.md

56 lines
1.6 KiB
Markdown
Raw Normal View History

2020-07-15 10:22:55 +00:00
Forward log messages via notification
=====================================
[◀ Go back to main README](../README.md)
> **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-07-15 10:22:55 +00:00
Description
-----------
RouterOS supports sending log messages via e-mail or to a syslog server.
This has some limitation, however:
* does not work early after boot if network connectivity is not
yet established
* lots of messages generate a flood of mails
2021-06-09 12:36:49 +00:00
* Matrix and Telegram are not supported
2020-07-15 10:22:55 +00:00
The script is intended to be run periodically. It collects log messages
and forwards them via notification.
2021-06-17 13:23:51 +00:00
### Sample notification
![log-forward notification](log-forward.d/notification.svg)
2021-06-17 13:23:51 +00:00
2020-07-15 10:22:55 +00:00
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 configuration goes to `global-config-overlay`, these are the parameters:
2020-07-15 10:22:55 +00:00
* `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)
2020-07-15 10:22:55 +00:00
2021-11-16 15:03:25 +00:00
Also notification settings are required for e-mail,
[matrix](mod/notification-matrix.md) and/or
2021-11-16 15:03:43 +00:00
[telegram](mod/notification-telegram.md)m.
2020-07-15 10:22:55 +00:00
---
[◀ Go back to main README](../README.md)
[▲ Go back to top](#top)