Add note about rsyslog rate limiting.

This commit is contained in:
Dan Helfman 2019-11-12 12:32:32 -08:00
parent bf0d38ff2a
commit 4c38810a32
2 changed files with 18 additions and 17 deletions

View file

@ -70,6 +70,21 @@ Or to increase syslog logging to include debug spew:
borgmatic --syslog-verbosity 2 borgmatic --syslog-verbosity 2
``` ```
### Rate limiting
If you are using rsyslog or systemd's journal, be aware that by default they
both throttle the rate at which logging occurs. So you may need to change
either [the global rate
limit](https://www.rootusers.com/how-to-change-log-rate-limiting-in-linux/) or
[the per-service rate
limit](https://www.freedesktop.org/software/systemd/man/journald.conf.html#RateLimitIntervalSec=)
if you're finding that borgmatic logs are missing.
Note that the [sample borgmatic systemd service
file](https://torsion.org/borgmatic/docs/how-to/set-up-backups/#systemd)
already has this rate limit disabled for systemd's journal.
### Logging to file ### Logging to file
If you don't want to use syslog, and you'd rather borgmatic log to a plain If you don't want to use syslog, and you'd rather borgmatic log to a plain
@ -84,20 +99,6 @@ the log file so it doesn't grow too large. Also, there is a
`--log-file-verbosity` flag to customize the log file's log level. `--log-file-verbosity` flag to customize the log file's log level.
### systemd journal
If your local syslog daemon is systemd's journal, be aware that journald by
default throttles the rate at which a particular program can log. So you may
need to [change the journald rate
limit](https://www.freedesktop.org/software/systemd/man/journald.conf.html#RateLimitIntervalSec=)
in `/etc/systemd/journald.conf` if you're finding that borgmatic journald logs
are missing.
Note that the [sample borgmatic systemd service
file](https://torsion.org/borgmatic/docs/how-to/set-up-backups/#systemd)
already has this rate limit disabled.
## Related documentation ## Related documentation
* [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/) * [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/)

View file

@ -39,9 +39,9 @@ generate-borgmatic-config --source config.yaml --destination config-new.yaml
New options start as commented out, so you can edit the file and decide New options start as commented out, so you can edit the file and decide
whether you want to use each one. whether you want to use each one.
There are a few caveats to this process, however. First, when generating the There are a few caveats to this process. First, when generating the new
new configuration file, `generate-borgmatic-config` replaces any comments configuration file, `generate-borgmatic-config` replaces any comments you've
you've written in your original configuration file with the newest generated written in your original configuration file with the newest generated
comments. Second, the script adds back any options you had originally deleted, comments. Second, the script adds back any options you had originally deleted,
although it does so with the options commented out. And finally, any YAML although it does so with the options commented out. And finally, any YAML
includes you've used in the source configuration get flattened out into a includes you've used in the source configuration get flattened out into a