- How-to guides
- Reference guides
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 only want to see the summary of archive statistics at the end, you can use the stats option when performing a backup:
Existing backups ¶
borgmatic provides convenient actions for Borg's list and info functionality:
info actions? Try the old-style
--info. Or upgrade borgmatic!)
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
journalctl -xe. Otherwise, try viewing
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
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 or the per-service rate limit if you're finding that borgmatic logs are missing.
Note that the sample borgmatic systemd service file 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
file, use the
borgmatic --log-file /path/to/file.log
Note that if you use the
--log-file flag, you are responsible for rotating
the log file so it doesn't grow too large, for example with
logrotate. Also, there is a
--log-file-verbosity flag to customize the log file's log level.
Improve this documentation
Have an idea on how to make this documentation even better? Use our issue tracker to send your feedback!