Update documentation about logging changes from version 1.8.3 (#665).

This commit is contained in:
Dan Helfman 2023-11-06 21:13:46 -08:00
parent 9baf06a2f7
commit 12b75f9075
2 changed files with 15 additions and 12 deletions

View file

@ -126,7 +126,7 @@ for more information.
## Hook output ## Hook output
Any output produced by your hooks shows up both at the console and in syslog 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 <a (when enabled). For more information, read about <a
href="https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/">inspecting href="https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/">inspecting
your backups</a>. your backups</a>.

View file

@ -116,27 +116,30 @@ archive, complete with file sizes.
## Logging ## Logging
By default, borgmatic logs to a local syslog-compatible daemon if one is By default, borgmatic logs to the console. You can enable simultaneous syslog
present and borgmatic is running in a non-interactive console. Where those logging and customize its log level with the `--syslog-verbosity` flag, which
logs show up depends on your particular system. If you're using systemd, try is independent from the console logging `--verbosity` flag described above.
running `journalctl -xe`. Otherwise, try viewing `/var/log/syslog` or For instance, to enable syslog logging, run:
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:
```bash ```bash
borgmatic --syslog-verbosity 1 borgmatic --syslog-verbosity 1
``` ```
Or to increase syslog logging to include debug spew: To increase syslog logging further to include debugging information, run:
```bash ```bash
borgmatic --syslog-verbosity 2 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.
<span class="minilink minilink-addedin">Prior to version 1.8.3</span>borgmatic
logged to syslog by default whenever run at a non-interactive console.
### Rate limiting ### Rate limiting
If you are using rsyslog or systemd's journal, be aware that by default they If you are using rsyslog or systemd's journal, be aware that by default they