Skip to content

Commit 164a83f

Browse files
committed
docs: add table of supported events
1 parent e023af4 commit 164a83f

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,25 @@ The bundle logs queueing, receiving, handled, failed, and retried events. If
3232
the installed Messenger version supports `WorkerMessageSkipEvent`, skipped
3333
messages are logged as well.
3434

35+
Symfony Messenger dispatches the following events in the supported versions of
36+
this bundle (`6.4`, `7.4`, `8.0`). The table also maps what this bundle does
37+
for each event.
38+
39+
| Symfony Messenger event | Meaning | Availability in supported Symfony versions | Our usage in this bundle |
40+
| --- | --- | --- | --- |
41+
| `SendMessageToTransportsEvent` | Dispatched before a message is sent to one or more transports. | `6.4`, `7.4`, `8.0` | Yes: `SendMessageToTransportsEventSubscriber` adds/reuses UUID, logs `Messenger message queued.`, includes `sender_names` (`log_levels.queued`). |
42+
| `MessageSentToTransportsEvent` | Dispatched after a message has been sent to at least one transport (once even if multiple transports are used). | `7.4`, `8.0` | No: not used currently. |
43+
| `WorkerMessageReceivedEvent` | Dispatched when a worker receives a message from a transport, before handling. | `6.4`, `7.4`, `8.0` | Yes: `WorkerMessageReceivedEventSubscriber` ensures UUID and logs `Messenger message received.` with `receiver_name` (`log_levels.received`). |
44+
| `WorkerMessageHandledEvent` | Dispatched after a worker successfully handles a message. | `6.4`, `7.4`, `8.0` | Yes: `WorkerMessageHandledEventSubscriber` ensures UUID and logs `Messenger message handled.` with `receiver_name` (`log_levels.handled`). |
45+
| `WorkerMessageFailedEvent` | Dispatched when message handling fails. | `6.4`, `7.4`, `8.0` | Yes: `WorkerMessageFailedEventSubscriber` ensures UUID and logs `Messenger message failed.` with `receiver_name`, `will_retry`, and exception fields (`log_levels.failed`). |
46+
| `WorkerMessageRetriedEvent` | Dispatched when a failed message is scheduled to be retried. | `6.4`, `7.4`, `8.0` | Yes: `WorkerMessageRetriedEventSubscriber` ensures UUID and logs `Messenger message scheduled for retry.` with `receiver_name` (`log_levels.retried`). |
47+
| `WorkerRateLimitedEvent` | Dispatched when the worker is rate-limited and must wait before consuming. | `6.4`, `7.4`, `8.0` | No: not used currently. |
48+
| `WorkerRunningEvent` | Dispatched after each worker loop iteration (message processed or idle). | `6.4`, `7.4`, `8.0` | No: not used currently. |
49+
| `WorkerStartedEvent` | Dispatched when a worker starts running. | `6.4`, `7.4`, `8.0` | No: not used currently. |
50+
| `WorkerStoppedEvent` | Dispatched when a worker stops. | `6.4`, `7.4`, `8.0` | No: not used currently. |
51+
| `WorkerMessageSkipEvent` | Dispatched when a failed message is explicitly skipped in `messenger:failed:retry`. | `7.4`, `8.0` | Yes: `WorkerMessageSkipEventSubscriber` is conditionally registered (`class_exists`) and logs `Messenger message skipped.` with `receiver_name` (`log_levels.skipped`). |
52+
53+
3554
## Installation
3655

3756
### Package Installation

0 commit comments

Comments
 (0)