Crash_Override/routeros-scripts
1
0
Fork 0
mirror of https://github.com/eworm-de/routeros-scripts synced 2024-05-14 08:04:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
routeros-scripts/doc/log-forward.md

57 lines
1.6 KiB
Markdown
Raw Normal View History

add 'log-forward', drop 'early-errors'
2020-07-15 10:22:55 +00:00
Forward log messages via notification
=====================================
[◀ Go back to main README](../README.md)
doc: use another info icon: 🛈 -> ℹ️
2022-02-12 12:05:56 +00:00
> ℹ️ **Info**: This script can not be used on its own but requires the base
doc: put hints into block quote
2022-02-11 22:34:39 +00:00
> installation. See [main README](../README.md) for details.
doc: inform about dependency on base installation That should make the documentation clearer if external sites link to the documentation of a specific script.
2021-05-03 13:07:50 +00:00
add 'log-forward', drop 'early-errors'
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
doc/log-forward: mention Matrix
2021-06-09 12:36:49 +00:00
* Matrix and Telegram are not supported
add 'log-forward', drop 'early-errors'
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.
doc: add sample notifications
2021-06-17 13:23:51 +00:00
### Sample notification
doc: move notification images to script-specific directories
2021-11-11 21:42:54 +00:00
![log-forward notification](log-forward.d/notification.svg)
doc: add sample notifications
2021-06-17 13:23:51 +00:00
add 'log-forward', drop 'early-errors'
2020-07-15 10:22:55 +00:00
Requirements and installation
-----------------------------
Just install the script:
$ScriptInstallUpdate log-forward;
... and add a scheduler:
doc/log-forward: RouterOS v7 path syntax
2022-05-11 08:10:34 +00:00
/system/scheduler/add interval=1m name=log-forward on-event="/system/script/run log-forward;" start-time=startup;
add 'log-forward', drop 'early-errors'
2020-07-15 10:22:55 +00:00
Configuration
-------------
log-forward: add filter on log message text
2020-09-25 20:21:59 +00:00
The configuration goes to `global-config-overlay`, these are the parameters:
add 'log-forward', drop 'early-errors'
2020-07-15 10:22:55 +00:00
* `LogForwardFilter`: define topics *not* to be forwarded
log-forward: add filter on log message text
2020-09-25 20:21:59 +00:00
* `LogForwardFilterMessage`: define message text *not* to be forwarded
log-forward: implement reverse logic to include messages... ... even if a filter matches to exclude them. Let's have an example: :global LogForwardFilter "(debug|info)"; :global LogForwardInclude "account"; This will forward everything about topic *account* (login, logout, failed login, ...) - even with topic *info*.
2021-06-09 12:32:52 +00:00
* `LogForwardInclude`: define topics to be forwarded (even if filter matches)
* `LogForwardIncludeMessage`: define message text to be forwarded (even if
filter matches)
add 'log-forward', drop 'early-errors'
2020-07-15 10:22:55 +00:00
introduce 'mod/notification-email', split off from global-functions
2022-09-23 13:07:30 +00:00
Also notification settings are required for
[e-mail](mod/notification-email.md),
add doc/mod/notification-matrix
2021-11-16 15:03:25 +00:00
[matrix](mod/notification-matrix.md) and/or
doc/log-forward: remove extra character Looks like copy'n'paste error...
2022-02-22 21:41:59 +00:00
[telegram](mod/notification-telegram.md).
add 'log-forward', drop 'early-errors'
2020-07-15 10:22:55 +00:00
---
[◀ Go back to main README](../README.md)
[▲ Go back to top](#top)
Reference in a new issue Copy permalink