Getting Support

If you are stuck, found a bug, or want to request a feature, here is how to get help.

Before Asking for Help

1. Check the Common Errors page -- your issue may already be documented
2. Enable debug logging (-v or -vv) and review the output (see Debug Mode)
3. Search existing issues on GitHub Issues -- someone may have already reported it

GitHub Issues

Report bugs and request features on the GitHub issue tracker:

https://github.com/osodevops/rabbitmq-backup/issues

Bug Report Template

When filing a bug report, include the following information to help us diagnose the issue quickly:

## Description

A clear description of what happened.

## Steps to Reproduce

1. Created config file with the following content: (paste relevant config, redact credentials)
2. Ran command: `rabbitmq-backup backup --config backup.yaml`
3. Got error: (paste error message)

## Expected Behavior

What you expected to happen.

## Actual Behavior

What actually happened (paste full error output).

## Environment

- **rabbitmq-backup version**: (output of `rabbitmq-backup --version`)
- **RabbitMQ version**: (output of `rabbitmqctl version` or Management API)
- **Operating system**: (e.g., Ubuntu 22.04, macOS 14, Docker image)
- **Storage backend**: (S3, Azure, GCS, filesystem)
- **Deployment method**: (bare metal, Docker, Kubernetes)

## Configuration (redacted)

```yaml
mode: backup
backup_id: "..."
source:
  amqp_url: "amqp://user:***@host:5672/%2f"
  management_url: "http://host:15672"
  ...
storage:
  backend: s3
  bucket: my-bucket
  ...

Debug Logs

Debug output (rabbitmq-backup backup -v --config ...)

(paste debug output here, redact any sensitive data)

### What to Redact

Before posting logs or config, redact:

- Passwords and tokens
- Access keys and secret keys
- Hostnames and IPs (if sensitive)
- Message content

Replace with placeholder values like `***`, `REDACTED`, or `example.com`.

## GitHub Discussions

For questions, ideas, and general discussion:

**https://github.com/osodevops/rabbitmq-backup/discussions**

Use Discussions for:

- How-to questions
- Architecture and design discussions
- Feature brainstorming
- Sharing your setup or use case

## Feature Requests

Open a GitHub issue with the `enhancement` label and describe:

- **What** you want to do
- **Why** the current functionality does not support it
- **How** you imagine it working (optional, but helpful)

## Contributing

Contributions are welcome. See the repository for contribution guidelines:

**https://github.com/osodevops/rabbitmq-backup**

### Development Setup

```bash
git clone https://github.com/osodevops/rabbitmq-backup.git
cd rabbitmq-backup

# Start local dev environment
docker compose up -d rabbitmq minio

# Build and test
cargo build
cargo test --workspace

# Run linter and formatter
cargo clippy --workspace --all-targets
cargo fmt --all -- --check

Running Tests

# Unit tests
cargo test --workspace --lib

# All tests (requires Docker for integration tests)
cargo test --workspace

# Tests with output
cargo test -- --nocapture

Commercial Support

For enterprise support, SLAs, and consulting on RabbitMQ backup strategies, contact OSO DevOps.

Useful Links

Resource	URL
GitHub Repository	https://github.com/osodevops/rabbitmq-backup
Issue Tracker	https://github.com/osodevops/rabbitmq-backup/issues
Discussions	https://github.com/osodevops/rabbitmq-backup/discussions
RabbitMQ Documentation	https://www.rabbitmq.com/docs
RabbitMQ Management API	https://www.rabbitmq.com/docs/management#http-api
RabbitMQ Stream Protocol	https://www.rabbitmq.com/docs/streams