From 12b75f90750ebc19c607e855b5149861ae37dd25 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Mon, 6 Nov 2023 21:13:46 -0800 Subject: [PATCH] Update documentation about logging changes from version 1.8.3 (#665). --- ...reparation-and-cleanup-steps-to-backups.md | 2 +- docs/how-to/inspect-your-backups.md | 25 +++++++++++-------- 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/docs/how-to/add-preparation-and-cleanup-steps-to-backups.md b/docs/how-to/add-preparation-and-cleanup-steps-to-backups.md index b34c4c9..2c71a41 100644 --- a/docs/how-to/add-preparation-and-cleanup-steps-to-backups.md +++ b/docs/how-to/add-preparation-and-cleanup-steps-to-backups.md @@ -126,7 +126,7 @@ for more information. ## Hook output Any output produced by your hooks shows up both at the console and in syslog -(when run in a non-interactive console). For more information, read about inspecting your backups. diff --git a/docs/how-to/inspect-your-backups.md b/docs/how-to/inspect-your-backups.md index b98c904..e3ce598 100644 --- a/docs/how-to/inspect-your-backups.md +++ b/docs/how-to/inspect-your-backups.md @@ -116,27 +116,30 @@ archive, complete with file sizes. ## Logging -By default, borgmatic logs to a local syslog-compatible daemon if one is -present and borgmatic is running in a non-interactive console. Where those -logs show up depends on your particular system. If you're using systemd, try -running `journalctl -xe`. Otherwise, try viewing `/var/log/syslog` or -similar. - -You can customize the log level used for syslog logging with the -`--syslog-verbosity` flag, and this is independent from the console logging -`--verbosity` flag described above. For instance, to get additional -information about the progress of the backup as it proceeds: +By default, borgmatic logs to the console. You can enable simultaneous syslog +logging and customize its log level with the `--syslog-verbosity` flag, which +is independent from the console logging `--verbosity` flag described above. +For instance, to enable syslog logging, run: ```bash borgmatic --syslog-verbosity 1 ``` -Or to increase syslog logging to include debug spew: +To increase syslog logging further to include debugging information, run: ```bash borgmatic --syslog-verbosity 2 ``` +See above for further details about the verbosity levels. + +Where these logs show up depends on your particular system. If you're using +systemd, try running `journalctl -xe`. Otherwise, try viewing +`/var/log/syslog` or similar. + +Prior to version 1.8.3borgmatic +logged to syslog by default whenever run at a non-interactive console. + ### Rate limiting If you are using rsyslog or systemd's journal, be aware that by default they