borgmatic/docs/how-to/inspect-your-backups.md at 3846155d624e94caa972a1e2fba4d39390a846f2

Dan Helfman 386979ebb4 Mention --stats option in documentation.

2019-09-23 13:13:34 -07:00

2.9 KiB

Raw Blame History

title
How to inspect your backups

Backup progress

By default, borgmatic runs proceed silently except in the case of errors. But if you'd like to to get additional information about the progress of the backup as it proceeds, use the verbosity option:

borgmatic --verbosity 1

This lists the files that borgmatic is archiving, which are those that are new or changed since the last backup.

Or, for even more progress and debug spew:

borgmatic --verbosity 2

Backup summary

If you're less concerned with progress during a backup, and you just want to see the summary of archive statistics at the end, you can use the stats option:

borgmatic --stats

Existing backups

Borgmatic provides convenient flags for Borg's list and info functionality:

borgmatic list
borgmatic info

(No borgmatic list or info actions? Try the old-style --list or --info. Or upgrade borgmatic!)

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 similiar.

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:

borgmatic --syslog-verbosity 1

Or to increase syslog logging to include debug spew:

borgmatic --syslog-verbosity 2

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 in /etc/systemd/journald.conf if you're finding that borgmatic journald logs are missing.

Note that the sample borgmatic systemd service file already has this rate limit disabled.

Scripting borgmatic

To consume the output of borgmatic in other software, you can include an optional --json flag with create, list, or info to get the output formatted as JSON.

Note that when you specify the --json flag, Borg's other non-JSON output is suppressed so as not to interfere with the captured JSON. Also note that JSON output only shows up at the console, and not in syslog.

2.9 KiB Raw Blame History