Using Magento 2.3 MySQL Queues

© 2019 Magento, Inc. Page | 1
Magento 2.3
Using MySQL For Queues

© 2019 Magento, Inc.
.
Page | 2
Senior Software Developer at BORN Group
Renu Mishra

Agenda

Agenda
 Need Of Queue
 Introduction to Queues
 Creating Queues with MySQL
 Publishing messages to Queue
 Consuming the published message

Not In Scope

Not In Scope
 Parallel Consumer processing.
 Batch Processing.
 AMQP Implementation (RabbitMQ).
 Advanced Error handling (Rejecting and Re-queuing).
 Supervisiord for consumer monitoring.

What is Queue and it’s
uses ?

What is Queue and it’s uses ?
 It distribute load across the application allowing work to placed in a
queue and process independently.
 Received and processes the message asynchronously.
 It also includes a mechanism for storing undelivered messages.
 Queue works in background. It has no frontend user interaction.

Introduction Of Queue

Queue Processing Diagram
Routes

Queue Processing Description
 A publisher is configured to send messages to a topic.
• A topic is a way to categorize messages to consumers.
• A consumer is configured to listen for messages with specific topics.
• Queues route topics to consumers.
• Consumers accept messages and perform actions on them.

Enough Talk Let’s Get
Started!

Registering The Module

<module_root>/registration.php

<module_root>/etc/module.xml

Let’s Creates the Queue Files
Now

Declaring The Publisher

Send the message to broker

<module_root>/etc/publisher.xml

<module_root>/etc/publisher.xml
- publisher element
- topic : The name of the topic.Wildcards character are not supported.
- connection element
- name : For AMQP connections, the connection name must match the
connection attribute in the queue_topology.xml file. Otherwise,
the connection name must be db.
- exchange : The name of the exchange to publish to. The default
system exchange name is magento.

<module_root>/etc/communication.xml

<module_root>/etc/communication.xml
- topic element
- name : A string that uniquely identifies the topic.Wildcards character
are not supported in the communication.xml file(*,%,[] and so on).
- request : Specifies the data type of the topic.
- handler element
- name : A string that uniquely defines the handler.
- type : The class that defines the handler.
- method : The method this handler executes.

Declare The Broker

Receive the Data From
Producer/Publisher

<module_root>/etc/queue.xml

- broker element
- topic : A topic defined in the communication.xml file.
- exchange : The name of the exchange to publish to. The default
system exchange name is magento
- type : The type of message broker. For this release, the value
must be amqp or db.

- queue element
- name : Defines the queue name to send the message to.
- consumer : The name of the consumer.
- consumerInstance : The path to a Magento class that consumes the
message.
- handler : Specifies the class and method that processes the
message. The value must be specified in the format
<Vendor>Module<ServiceName>::<methodName>.

Declaring The Topology

Queue route topics to consumers

<module_root>/etc/queue_topology.xml

- exchange element
- name : A unique ID for the exchange.
- type : Specifies the type of exchange. Must be topic.
- connection : For AMQP connections, a string that identifies the
connection. For MySQL connections, the connection
name must be db.

- binding element
- id : A unique ID for this binding.
- topic : The name of a topic.
- destinationType : Must be queue.
- destination : Identifies the name of a queue.

Declaring The Consumer

Consume the publish message
Routes

<module_root>/etc/queue_consumer.xml

<module_root>/etc/queue_consumer.xml
- consumer element
- name : The name of the consumer.
- queue : Defines the queue name to send the message to.
- handler : Specifies the class and method that processes the message.
The value must be specified in the format
<Vendor>Module<ServiceName>::<methodName>.
- consumerInstance : The Magento class name that consumes the
message
- connection : For AMQP connections, the connection name must match
the connection attribute in the queue_topology.xml file.
Otherwise, the connection name must be db.

So many files right ?

Enough XMLs now its PHP
time !!

Request Class Declaration

Requested Class in Communication.xml

Requested Class Interface

Concrete Class
Declaration

Concrete Class declare in etc/di.xml

Concrete Class Implementation

Publishing The Message

Publish The Message in Controller

MagentoFrameworkMessageQueuePu
blisherInterface

Publish The Message in Controller

Consume The Message

Finally Code
Implementation Done !!!

Execute The Queue

Wait we need to run the
command before
executing the Queue

Upgrade Command
Install the Queue Module

What is happening in
background when
command executed ?

Queue Table

Now Let’s Publish the
Queue using Controller

[base_url]/queue1/index/index

What happen in
background when queue
published?

queue_message Table

It’s time to consume the
published message

View a list of available
message queue
consumers

View a list of available message queue
consumers

Command that consume
the message

Consume the message

What happen when
consumer start processing
?

queue_message_status table

status column in queue_message_status
table

Queue Execution On
Production

MySQL Message Queue Setting
Stores > Settings > Configuration > Advanced > System > Cron

Configure cron job consumer_runner in
app/etc/env.php

 cron_run - the option for enabling/disabling cron job consumers_runner, by
default is true.
 max_messages - the maximum number of messages for each consumer
that must be processed before consumer terminate, by default is 1000. If it
is 0, then the consumer never stops working.
 consumers - the list of consumers which will be run, by default is empty
array (all consumers are allowed to be run).
consumer_runner parameter Details

Start message queue consumers

Now you know pretty
well about Queue

Questions ?

Thank You

Using Magento 2.3 MySQL Queues

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to Using Magento 2.3 MySQL Queues

Similar to Using Magento 2.3 MySQL Queues (20)

Recently uploaded

Recently uploaded (20)

Using Magento 2.3 MySQL Queues