From 4c38810a32856acaf559e1eac7d5ee2914ee947a Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Tue, 12 Nov 2019 12:32:32 -0800 Subject: [PATCH] Add note about rsyslog rate limiting. --- docs/how-to/inspect-your-backups.md | 29 +++++++++++++++-------------- docs/how-to/upgrade.md | 6 +++--- 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/docs/how-to/inspect-your-backups.md b/docs/how-to/inspect-your-backups.md index 370eb6b..cb52808 100644 --- a/docs/how-to/inspect-your-backups.md +++ b/docs/how-to/inspect-your-backups.md @@ -70,6 +70,21 @@ Or to increase syslog logging to include debug spew: 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 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. -### 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 * [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/) diff --git a/docs/how-to/upgrade.md b/docs/how-to/upgrade.md index 18455e8..b99dea9 100644 --- a/docs/how-to/upgrade.md +++ b/docs/how-to/upgrade.md @@ -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 whether you want to use each one. -There are a few caveats to this process, however. First, when generating the -new configuration file, `generate-borgmatic-config` replaces any comments -you've written in your original configuration file with the newest generated +There are a few caveats to this process. First, when generating the new +configuration file, `generate-borgmatic-config` replaces any comments you've +written in your original configuration file with the newest generated 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 includes you've used in the source configuration get flattened out into a