Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

[Messenger] Add per-message priority#15452

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.

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

Already on GitHub?Sign in to your account

Open
kozlice wants to merge1 commit intosymfony:6.2
base:6.2
Choose a base branch
Loading
fromkozlice:messenger-priority-stamp
Open
Show file tree
Hide file tree
Changes fromall commits
Commits
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
3 changes: 3 additions & 0 deletionscomponents/messenger.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -146,6 +146,9 @@ Here are some important envelope stamps that are shipped with the Symfony Messen

#. :class:`Symfony\\Component\\Messenger\\Stamp\\DelayStamp`,
to delay handling of an asynchronous message.
#. :class:`Symfony\\Component\\Messenger\\Stamp\\PriorityStamp`,
to prioritize messages of the same type within a queue. Read more
at :doc:`/messenger/message_priority`.
#. :class:`Symfony\\Component\\Messenger\\Stamp\\DispatchAfterCurrentBusStamp`,
to make the message be handled after the current bus has executed. Read more
at :doc:`/messenger/dispatch_after_current_bus`.
Expand Down
136 changes: 136 additions & 0 deletionsmessenger/message_priority.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
Message Priority
================

By default messenger uses the first in, first out principle: messages will be
received in the same order they were sent (except the delayed ones).

Basic priority can be achieved by using :doc:`prioritized transports </messenger>`,
but only for different message types.

With AMQP and Beanstalkd transports, you can have a priority queue for messages
of the same type::

use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\Stamp\PriorityStamp;

$bus->dispatch(
(new Envelope($message))->with(new PriorityStamp(255))
);

.. tip::

Priorities between ``0`` (lowest) and ``255`` (highest) are supported.

Priority can be used together with delay::

use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\Stamp\DelayStamp;
use Symfony\Component\Messenger\Stamp\PriorityStamp;

$bus->dispatch(
(new Envelope($message))->with(
new PriorityStamp(255),
new DelayStamp(5000)
)
);

When the time comes, if other messages in queue have lower priority, this one
will be delivered first.

Using with Beanstalkd transport
-------------------------------

Beanstalkd does not require any additional configuration. You can start using priority
stamp right away.

.. note::

Internally Beanstalkd uses a different priority system, where priority
can take values between ``2^32 - 1`` and ``0``, with zero being the highest priority.
Messenger handles the transformation internally.

Using with AMQP transport
-------------------------

With AMQP transport, you need to enable priority for the queue in configuration:

.. configuration-block::

.. code-block:: yaml

# config/packages/messenger.yaml
framework:
messenger:
transports:
async:
dsn: "%env(MESSENGER_TRANSPORT_DSN)%"
options:
queues:
messenger:
arguments:
x-max-priority: 255

.. code-block:: xml

<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:framework="http://symfony.com/schema/dic/symfony"
xsi:schemaLocation="http://symfony.com/schema/dic/services
https://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony
https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

<framework:config>
<framework:messenger>
<framework:transport name="async"
dsn="%env(MESSENGER_TRANSPORT_DSN)%"
>
<framework:options>
<framework:queues>
<framework:messenger>
<framework:arguments>
<framework:x-max-priority>255</framework:x-max-priority>
</framework:arguments>
</framework:messenger>
</framework:queues>
</framework:options>
</framework:transport>
</framework:messenger>
</framework:config>
</container>

.. code-block:: php

// config/packages/messenger.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
$messenger = $framework->messenger();

$messenger->transport('async')
->dsn('%env(MESSENGER_TRANSPORT_DSN)%')
->options([
'queues' => [
'messenger' => [
'arguments' => [
'x-max-priority' => 255,
],
]
]
]);
};

.. caution::

It's not safe to set ``x-max-priority`` for an existing queue.
RabbitMQ can not change existing queue's configuration. Messenger will
fail to auto-setup and priorities won't work.

.. note::

`RabbitMQ manual recommends`_ using up to 10 different priority levels.
For example, you may use 255 for high, 127 for medium and 0 for low priority.
Having more levels may have an impact on performance.

.. _`RabbitMQ manual recommends`: https://www.rabbitmq.com/priority.html
[8]ページ先頭
©2009-2025 Movatter.jp