Skip to content

Improve documentation and update examples #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
f3l1x merged 1 commit into from
Mar 13, 2026
Merged

Improve documentation and update examples #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 54 additions & 14 deletions .docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Content

- [Setup](#usage)
- [Setup](#setup)
- [Relying](#relying)
- [Configuration](#configuration)
- [Integrations](#integrations)
Expand All @@ -22,7 +22,7 @@ extensions:

## Relying

Take advantage of enpowering this package with 4 extra packages:
Take advantage of empowering this package with extra packages:

- `symfony/console` via [contributte/console](https://github.com/contributte/console)
- `symfony/event-dispatcher` via [contributte/event-dispatcher](https://github.com/contributte/event-dispatcher)
Expand All @@ -41,7 +41,7 @@ extensions:
console: Contributte\Console\DI\ConsoleExtension(%consoleMode%)
```

Since this moment when you type `bin/console`, there'll be registered commands from Doctrine DBAL.
Since this moment when you type `bin/console`, there will be registered commands from Symfony Messenger.

![Console Commands](https://raw.githubusercontent.com/contributte/messenger/master/.docs/assets/console.png)

Expand All @@ -61,14 +61,42 @@ extensions:

## Configuration

> At first please take a look at official documentation.
> https://symfony.com/doc/current/components/messenger.html
> https://symfony.com/doc/current/messenger.html
> [!TIP]
> See [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more details.

### Transports

| Transport | DSN | Description |
|-----------|-----|-------------|
| [Sync](https://symfony.com/doc/current/messenger.html#transport-configuration) | `sync://` | Handles messages immediately |
| [In-Memory](https://symfony.com/doc/current/messenger.html#in-memory-transport) | `in-memory://` | Stores messages in memory (testing) |
| [Redis](https://symfony.com/doc/current/messenger.html#redis-transport) | `redis://localhost:6379` | Async via Redis streams |
| [Doctrine](https://symfony.com/doc/current/messenger.html#doctrine-transport) | `doctrine://default` | Async via database table |
| [AMQP](https://symfony.com/doc/current/messenger.html#amqp-transport) | `amqp://guest:guest@localhost:5672` | Async via RabbitMQ |

### Console Commands

| Command | Description |
|---------|-------------|
| [`messenger:consume`](https://symfony.com/doc/current/messenger.html#consuming-messages-running-the-worker) | Consume messages from transport |
| [`messenger:stop-workers`](https://symfony.com/doc/current/messenger.html#deploying-to-production) | Gracefully stop workers |
| `messenger:setup-transports` | Setup transport infrastructure |
| [`messenger:failed:show`](https://symfony.com/doc/current/messenger.html#saving-retrying-failed-messages) | Show failed messages |
| [`messenger:failed:retry`](https://symfony.com/doc/current/messenger.html#saving-retrying-failed-messages) | Retry failed messages |
| [`messenger:failed:remove`](https://symfony.com/doc/current/messenger.html#saving-retrying-failed-messages) | Remove failed messages |
| `messenger:debug` | Debug routing and handlers |

Minimal configuration example:

```neon
# Just register the handler as a service to DIC
messenger:
transport:
sync:
dsn: sync://

routing:
App\Domain\SimpleMessage: [sync]

services:
- App\Domain\SimpleMessageHandler
```
Expand Down Expand Up @@ -356,7 +384,7 @@ Handling errors in async environments is little bit tricky. You need to setup lo

### Doctrine

Take advantage of enpowering this package with 6 extra packages:
Take advantage of empowering this package with Doctrine packages:

- `doctrine/dbal` via [nettrine/dbal](https://github.com/contributte/doctrine-dbal)
- `doctrine/orm` via [nettrine/orm](https://github.com/contributte/doctrine-orm)
Expand Down Expand Up @@ -425,20 +453,32 @@ services:

### 2. Example projects

We've made a few skeletons with preconfigured Symfony Messenger nad Contributte packages.
We've made a few skeletons with preconfigured Symfony Messenger and Contributte packages.

- https://github.com/contributte/messenger-skeleton

### 3. Example playground

- https://contributte.org/examples.html (more examples)

## Other
## Features

- Multiple bus types (`messageBus`, `commandBus`, `queryBus`)
- Async transports (Redis, Doctrine, AMQP)
- Retry strategies with exponential backoff
- Failure transport for dead letters
- Handler auto-discovery via `#[AsMessageHandler]` attribute
- Message routing via `#[AsMessage]` attribute
- Interface and wildcard routing
- Worker limits (memory, time, message count)
- Batch handlers support

## Credits

This repository is inspired by these packages.
This repository is inspired by these packages:

- https://github.com/fmasa/messenger
- https://gitlab.com/symfony/messenger
- https://gitlab.com/symfony/redis-messenger
- [fmasa/messenger](https://github.com/fmasa/messenger)
- [symfony/messenger](https://github.com/symfony/messenger)
- [symfony/redis-messenger](https://github.com/symfony/redis-messenger)

Thank you folks.
Loading