PagerDuty

In case you're new here: borgmatic is simple, configuration-driven backup software for servers and workstations, powered by Borg Backup.

PagerDuty provides incident monitoring and alerting. borgmatic has built-in integration that can notify you via PagerDuty as soon as a backup fails, so you can make sure your backups keep working.

First, create a PagerDuty account and service on their site. On the service, add an integration and set the Integration Type to "borgmatic".

Then, configure borgmatic with the unique "Integration Key" for your service. Here's an example:

pagerduty:
    integration_key: a177cad45bd374409f78906a810a3074

Prior to version 1.8.0 Put this option in the hooks: section of your configuration.

With this configuration, borgmatic creates a PagerDuty event for your service whenever backups fail, but only when any of the create, prune, compact, or check actions are run. Note that borgmatic does not contact PagerDuty when a backup starts or when it ends without error.

You can configure PagerDuty to notify you by a variety of mechanisms when backups fail.

If you have any issues with the integration, please contact us.

Sending logs

New in version 1.9.14 borgmatic can include logs in the payload data sent to PagerDuty. This means that (truncated) borgmatic logs, including error messages, can show up in the PagerDuty incident UI and corresponding notification emails. borgmatic has a send_logs option to enable or disable log sending:

pagerduty:
    integration_key: a177cad45bd374409f78906a810a3074
    send_logs: true

New in version 2.1.0 To avoid revealing private log information to a third-party service, logs are no longer sent by default when send_logs is omitted.

Prior to version 2.1.0 Logs were sent by default when send_logs was omitted.

You can customize the verbosity of the logs that are sent with borgmatic's --monitoring-verbosity flag. The --list and --stats flags may also be of use. See create action documentation for more information.

New in version 2.0.0Set the defaults for these flags in your borgmatic configuration via the monitoring_verbosity, list, and statistics options.