Creating a RocketMQ Consumer Group

Notes and Constraints

Consumer group names cannot be used across instances. For example, Group01 created in instance A cannot be used in instance B.

Prerequisite

A RocketMQ instance has been purchased.

Creating a RocketMQ Consumer Group

1. Log in to the RocketMQ console.
2. Click a RocketMQ instance name to go to the instance overview page.
3. In the navigation pane, choose Instance > Consumer Groups.
4. Click Create Consumer Group.
5. Configure the consumer group name and other parameters by referring to Table 1.

   Table 1 Consumer group parameters

   Parameter	Description
   Consumer Group Name	Name of the consumer group. A consumer group must meet the following requirements: Contains 3 to 64 characters. Contains only letters, digits, percent signs (%), vertical bars (|), hyphens (-), and underscores (_). A percent (%) or vertical bar (|) contained in a consumer group name will be converted to an underscore (_) by Cloud Eye. For example, if a consumer group name is test%01, it will be displayed as test_01 on Cloud Eye. Once the consumer group is created, you cannot modify its name.
   Brokers	This parameter is mandatory for a RocketMQ 4.8.0 instance. Select one or multiple brokers to create consumer groups as required. The consumer groups are automatically created. Once the consumer group is created, you cannot modify its brokers.
   Maximum Retries	Maximum number of retry attempts allowed for normal messages. Value range: 1–16 For ordered retrievals, this limit can be configured by using the setMaxReconsumeTimes method.
   Broadcast	Indicates whether messages are broadcast. If this option is enabled, each message is retrieved by all consumers in the consumer group. If this option is disabled, each message is retrieved by only one consumer in the consumer group.
   Orderly	This parameter is mandatory for a RocketMQ 5.x instance. If this option is enabled, consumers consume messages in sequence. Orderly consumption ensures sequential consumption by message sending. In this case, earlier messages are consumed before later messages
   Description	Description of the consumer group. Value range: 0–200 characters.

6. Click OK.

   When a consumer group is created, Consumer Group Status and Consumption Mode are displayed in the consumer group list (only for v4.8.0).

   • Consumer Group Status can be Online or Offline.
   • Consumption Mode can be:
     • CLUSTERING: cluster consumption mode. Each message is processed by only one consumer within the group.
     • BROADCASTING: broadcast consumption mode. RocketMQ pushes each message to all consumers in the consumer group to ensure that the message is consumed at least once by each consumer.

     Consumption Mode is -- when the consumer group is offline.

Related Documents

• To create a consumer group by calling an API, see Creating a Consumer Group or Batch Deleting Consumer Groups.
• To create multiple users and assign different consumer group permissions to them, enable ACL and configure users. For details, see Enabling RocketMQ ACL and Configuring RocketMQ ACL Users.