2019-02-04 07:20:59 +01:00
|
|
|
---
|
|
|
|
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:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
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:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
borgmatic --verbosity 2
|
|
|
|
```
|
|
|
|
|
|
|
|
## Existing backups
|
|
|
|
|
|
|
|
Borgmatic provides convenient flags for Borg's
|
|
|
|
[list](https://borgbackup.readthedocs.io/en/stable/usage/list.html) and
|
|
|
|
[info](https://borgbackup.readthedocs.io/en/stable/usage/info.html)
|
|
|
|
functionality:
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
2019-06-23 07:09:50 +02:00
|
|
|
borgmatic list
|
|
|
|
borgmatic info
|
2019-02-04 07:20:59 +01:00
|
|
|
```
|
|
|
|
|
2019-06-12 01:42:04 +02:00
|
|
|
## Logging
|
|
|
|
|
|
|
|
By default, borgmatic logs to a local syslog-compatible daemon if one is
|
2019-06-12 06:35:43 +02:00
|
|
|
present. 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
|
2019-06-12 01:42:04 +02:00
|
|
|
`--syslog-verbosity` flag, and this is independent from the console logging
|
2019-06-17 06:57:14 +02:00
|
|
|
`--verbosity` flag described above. For instance, to get additional
|
|
|
|
information about the progress of the backup as it proceeds:
|
2019-06-12 01:42:04 +02:00
|
|
|
|
|
|
|
```bash
|
2019-06-17 06:57:14 +02:00
|
|
|
borgmatic --syslog-verbosity 1
|
2019-06-12 01:42:04 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
Or to increase syslog logging to include debug spew:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
borgmatic --syslog-verbosity 2
|
|
|
|
```
|
|
|
|
|
2019-06-12 02:03:40 +02:00
|
|
|
### 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.
|
|
|
|
|
2019-02-04 07:20:59 +01:00
|
|
|
## Scripting borgmatic
|
|
|
|
|
|
|
|
To consume the output of borgmatic in other software, you can include an
|
2019-06-23 07:09:50 +02:00
|
|
|
optional `--json` flag with `create`, `list`, or `info` to get the output
|
|
|
|
formatted as JSON.
|
2019-02-04 07:20:59 +01:00
|
|
|
|
2019-06-12 01:42:04 +02:00
|
|
|
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.
|
|
|
|
|
2019-02-04 07:20:59 +01:00
|
|
|
|
|
|
|
## Related documentation
|
|
|
|
|
2019-06-01 22:23:48 +02:00
|
|
|
* [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups.md)
|
|
|
|
* [Develop on borgmatic](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic.md)
|