Backup and restore strategies in RabbitMQ - Commands & Configuration

Introduction

Backing up RabbitMQ data helps protect your messages and configurations from loss. Restoring allows you to recover your system to a previous state after failures or mistakes.

When you want to save your RabbitMQ queues and messages before upgrading the server.

When you need to move RabbitMQ data from one server to another safely.

When you want to recover from accidental message deletion or server crashes.

When you want to keep a regular snapshot of your RabbitMQ state for disaster recovery.

When you want to clone your RabbitMQ setup for testing or development.

Commands

This command exports all RabbitMQ definitions like queues, exchanges, bindings, users, and permissions to a JSON file named backup.json. It saves the configuration but not the messages.

Terminal

rabbitmqctl export_definitions backup.json

Expected Output

No output (command runs silently)

Stops the RabbitMQ application to safely back up the message store files without changes during backup.

Terminal

rabbitmqctl stop_app

Expected Output

Stopping rabbit application ...

...done.

Copies the RabbitMQ message store directory to a backup location. This saves all messages and state data.

Terminal

cp -r /var/lib/rabbitmq/mnesia /var/lib/rabbitmq/mnesia_backup

Expected Output

No output (command runs silently)

Restarts the RabbitMQ application after backup is complete to resume normal operations.

Terminal

rabbitmqctl start_app

Expected Output

Starting rabbit application ...

...done.

Stops the RabbitMQ application before restoring data to avoid conflicts.

Terminal

rabbitmqctl stop_app

Expected Output

Stopping rabbit application ...

...done.

Deletes the current message store and replaces it with the backup copy to restore messages and state.

Terminal

rm -rf /var/lib/rabbitmq/mnesia && cp -r /var/lib/rabbitmq/mnesia_backup /var/lib/rabbitmq/mnesia

Expected Output

No output (command runs silently)

Starts the RabbitMQ application after restoring the message store to resume operations with restored data.

Terminal

rabbitmqctl start_app

Expected Output

Starting rabbit application ...

...done.

Imports the saved definitions from the JSON file to restore queues, exchanges, users, and permissions.

Terminal

rabbitmqctl import_definitions backup.json

Expected Output

No output (command runs silently)

Key Concept

If you remember nothing else, remember: stop the RabbitMQ app before backing up or restoring message data to avoid corruption.

Common Mistakes

Backing up message store files while RabbitMQ is running.

This can cause inconsistent or corrupted backups because files may change during copying.

Always stop the RabbitMQ application before copying message store files.

Only exporting definitions without backing up message data.

Definitions do not include messages, so you lose all queued messages after restore.

Back up both definitions and message store files if you want full recovery.

Restoring definitions without stopping RabbitMQ app.

It can cause conflicts or errors because the app is actively using resources.

Stop the RabbitMQ app before importing definitions or restoring message files.

Summary

Use 'rabbitmqctl export_definitions' to save configuration like queues and users.

Stop the RabbitMQ app before copying message store files to back up messages safely.

Restore by replacing message files and importing definitions after stopping the app.