Start message queue consumers
- Topics:
- Configuration
CREATED FOR:
- Experienced
- Admin
- Developer
You must start a message queue consumer to enable asynchronous operations such as Inventory Management mass actions and REST bulk and asynchronous endpoints. To enable B2B functionality, you must start multiple consumers. Third-party modules might also require that you start a custom consumer.
To view a list of all consumers:
bin/magento queue:consumers:list
To start message queue consumers:
bin/magento queue:consumers:start [--max-messages=<value>] [--batch-size=<value>] [--single-thread] [--area-code=<value>] [--multi-process=<value>] <consumer_name>
After consuming all available messages, the command terminates. You can run the command again manually or with a cron job. You can also run multiple instances of the magento queue:consumers:start
command to process large message queues. For example, you can append &
to the command to run it in the background, return to a prompt, and continue running commands:
bin/magento queue:consumers:start <consumer_name> &
See queue:consumers:start
in the Commerce section of the Command-line tools reference for details about the command options, parameters, and values.
--multi-process
option is present in the queue:consumers:start
command, but to run consumers with parallel processes, configure the multiple_processes
option in /app/etc/env.php
. Otherwise, if queue:consumers:start
is called with the --multi-process
option, it only works on a single thread.More help on this topic
Commerce
- Overview
- General setup
- Deployment
- Cache
- Command Line
- Command-line tool
- Common commands
- Enable logging
- Manage the cache
- Manage indexers
- Configure cron jobs
- Compile code
- Operation mode
- Start message queue consumers
- URN highlighter
- Dependency reports
- Localization
- Configuration management
- Static view
- Create symlinks
- Run unit tests
- Convert layout files
- Generate data for performance testing
- Run support utilities (Commerce only)
- Configuration files
- Configuration paths
- Cron Jobs
- Logs
- Message Queues
- Multiple sites
- Search Engine
- Security
- Storage
- Return to Operational Guides