Self-Hosted Backup & Restore
Quick Backup
If you need a quick way to backup and restore your Sentry instance and you don't need historical event data, you can use the built in export
and import
commands. These commands will save and load all project and user data, but will not contain any event data.
Backup
docker-compose run --rm -T -e SENTRY_LOG_LEVEL=CRITICAL web export > backup.json
Note
Restore
Once you have a backup by using the export
command, the easiest way to restore it is to place it under the sentry
directory in your main onpremise
repo, next to the config files. This directory automatically gets mounted to /etc/sentry
so you can run the following to restore your backup:
docker-compose run --rm -T web import /etc/sentry/backup.json
If you don't see any errors and the process exits with code 0
, congratulations, you have just restored your backup.
Full Backup
The ideal way to backup and restore Sentry is to backup and restore all Docker volumes that it uses. All volumes that hold critical long-term data are already defined as global volumes at install time and are prefixed with sentry-
:
sentry-data
sentry-postgres
sentry-redis
sentry-zookeeper
sentry-kafka
sentry-clickhouse
sentry-symbolicator
Note
docker-compose
automatically creates, typically with the sentry_onpremise_sentry-
prefix.Docker documents how to backup and restore volumes on their documentation. You may use different methods as long as the volumes can be read back without issues.