routeros-scripts/doc/log-forward.md
Christian Hesse c872c18d76 doc/log-forward: remove extra character
Looks like copy'n'paste error...
2022-02-22 22:41:59 +01:00

55 lines
1.6 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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
> installation. See [main README](../README.md) for details.
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
* Matrix and Telegram are not supported
The script is intended to be run periodically. It collects log messages
and forwards them via notification.
### Sample notification
![log-forward notification](log-forward.d/notification.svg)
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:
* `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)
Also notification settings are required for e-mail,
[matrix](mod/notification-matrix.md) and/or
[telegram](mod/notification-telegram.md).
---
[◀ Go back to main README](../README.md)
[▲ Go back to top](#top)