dramatiq-kombu-broker 0.3.0

Dramatiq Kombu-based broker

dramatiq-kombu-broker

Dramatiq Kombu-based broker

Key features:

• Connection pool support (native): no unexpected connections count grow up!
• Channel pool support (via kombu-pyamqp-threadsafe lib): consume and produce through channels, "Connection limit reach" fixed now!
• Memory protection via configurable max_delay_time limits: prevents RabbitMQ memory exhaustion from long-delayed messages
• Deadlock protection via confirm_timeout: prevents infinite blocking when RabbitMQ connection fails during message publishing (default: 5s timeout)

Minor features

• Auto-add hostname to connection props.
• Allow change default queue name without changing each actor (e.g. 'default' -> 'dramatiq'). See configuration docs
• Consumer healthcheck support
• Ignore topology difference (PreconditionFailed), you can change your queue options safely
• No scary Pika logs. Fully based on kombu.
• ACK/NACK in YOUR middleware. Check message acknowledge status: Message.acknowledged

Auto-add hostname to connection props. Now you can see location of each connection in RabbitMQ web admin

Installing

To install this package, run:

pip install dramatiq-kombu-broker

Using

Django Dramatiq

settings.py

    DRAMATIQ_BROKER = {
        'BROKER': 'dramatiq_kombu_broker.broker.ConnectionSharedKombuBroker',
        'OPTIONS': {
            'kombu_connection_options': KOMBU_RABBITMQ_PARAMS,
        },
    }

Contributing

Prerequisites

1. Set up Git to use SSH

1. Generate an SSH key and add the SSH key to your GitHub account.
2. Configure SSH to automatically load your SSH keys:

   cat << EOF >> ~/.ssh/config
   
   Host *
     AddKeysToAgent yes
     IgnoreUnknown UseKeychain
     UseKeychain yes
     ForwardAgent yes
   EOF
   

2. Install Docker

1. Install Docker Desktop.
   • Linux only:
     • Export your user's user id and group id so that files created in the Dev Container are owned by your user:

       cat << EOF >> ~/.bashrc
       
       export UID=$(id --user)
       export GID=$(id --group)
       EOF
       

3. Install VS Code or PyCharm

1. Install VS Code and VS Code's Dev Containers extension. Alternatively, install PyCharm.
2. Optional: install a Nerd Font such as FiraCode Nerd Font and configure VS Code or configure PyCharm to use it.

Development environments

The following development environments are supported:

1. ⭐️ GitHub Codespaces: click on Code and select Create codespace to start a Dev Container with GitHub Codespaces.
2. ⭐️ Dev Container (with container volume): click on Open in Dev Containers to clone this repository in a container volume and create a Dev Container with VS Code.
3. Dev Container: clone this repository, open it with VS Code, and run Ctrl/⌘ + ⇧ + P → Dev Containers: Reopen in Container.
4. PyCharm: clone this repository, open it with PyCharm, and configure Docker Compose as a remote interpreter with the dev service.
5. Terminal: clone this repository, open it with your terminal, and run docker compose up --detach dev to start a Dev Container in the background, and then run docker compose exec dev zsh to open a shell prompt in the Dev Container.

Developing

• This project follows the Conventional Commits standard to automate Semantic Versioning and Keep A Changelog with Commitizen.
• Run poe from within the development environment to print a list of Poe the Poet tasks available to run on this project.
• Run poetry add {package} from within the development environment to install a run time dependency and add it to pyproject.toml and poetry.lock. Add --group test or --group dev to install a CI or development dependency, respectively.
• Run poetry update from within the development environment to upgrade all dependencies to the latest versions allowed by pyproject.toml.
• Run cz bump to bump the package's version, update the CHANGELOG.md, and create a git tag.