tencent cloud

Feedback

Group Management

Last updated: 2024-08-21 11:11:50

    Overview

    A Group is used to identify a category of Consumers. These consumers typically consume the same kind of messages and subscribe to them in a consistent manner.
    This document provides instructions on how to create, delete, and query a Group in the TDMQ for RocketMQ console.

    Prerequisites

    A corresponding namespace must be previously established.
    You have created a message producer and consumer using the SDK provided by TDMQ, and they are functioning normally.

    Directions

    Creating a Group

    5.x Cluster
    4.x Cluster
    1. Log in to the Console for RocketMQ.
    2. Select Group Management from the left sidebar, select the desired region and target cluster.
    
    3. Click Create to access the Group creation page.
    4. Provide the related Group details.
    Group Name: Enter the group name (cannot be modified after creation). It can contain 3 to 64 characters, including letters, numbers, "-" and "_".
    Group Description: Enter a description for the Group.
    Maximum retries: Indicates the maximum number of times a message can be redelivered. If the maximum number of message retries is exceeded and the message has not been successfully consumed, it will be delivered to a dead letter queue or discarded. If you are using the RocketMQ 4.x client, the number of message retries is determined by the number of retry you set in the client. If you are using the RocketMQ 5.x client, then the number of message retries is based on what you have set on the current page.
    Delivery Order: The order in which the server delivers messages to consumers. It supports ordered and concurrent delivery. By default, messages are delivered concurrently.
    Enable Consumption: If this option is disabled, all consumers in the Group will stop consumption, but will resume consuming if it is enabled again.
    5. Click Submit to complete Group creation.
    
    1. Log in to TDMQ for RocketMQ Console, select the region, and then click the ID of the target cluster to enter the cluster information page.
    2. Click Group tab at the top, select the namespace, and then click Create to enter the Group creation page.
    3. Enter Group related information.
    
    Group name: Enter a Group name (cannot be modified after creation), 3-64 characters, and the Group name can only include letters, numbers, hyphens (-) and underscores (_).
    Protocol type: Supports HTTP and TCP protocols.
    Group description: Enter a Group description.
    Enable consumption: When disabled, all consumption under the Group will be paused. It can be resumed once re-enabled.
    Enable broadcast mode: When it is disabled, all consumers declared as broadcast mode under the Group will be paused. It can be resumed once re-enabled.
    4. Click Submit to complete Group creation.
    Note:
    To ensure the stability of online clusters and avoid metadata redundancy in the console, Tencent Cloud TDMQ for RocketMQ disabled the automatic creation of groups in late February 2023. Users need to create the corresponding Group in the console before starting the consumer client.

    View Consumer Details

    1. In Group list, click the Group name to enter the client connection list, where you can view the basic information about the Group as well as the client connection list.
    5.x Cluster
    4.x Cluster
    Group Name
    Creation Time
    Delivery Order: Ordered delivery or concurrent delivery
    Consumer Type: PUSH or PULL
    Total Message Heaps: The total number of heaped messages.
    Consumption mode: Cluster mode or broadcast mode
    Cluster consumption: If the cluster mode is used, any message only needs to be processed by any consumer in the cluster.
    Broadcast Consumption: If the broadcast mode is used, each message will be pushed to all registered consumers in the cluster to ensure that the message is consumed by each consumer at least once.
    Client protocol: Supports TCP and HTTP protocols.
    Total message heap: The total number of heaped messages
    Consumer type: ACTIVELY (proactive message pulling, Pull Mode) or PASSIVELY (client waits for server to push messages, Push Mode)
    2. Click View Details in the client operation column to review consumer details.
    
    3. Click View Stack in the client to view the stack details and the number of threads of the client.
    
    
    
    4. Switch to the Subscription Relationship tab to view the list and subscription attributes of the Group subscribed Topics.
    

    Set an offset

    1. In Group list, click Reset Offset in the operation column of the target Group.
    
    2. In the pop-up window, you can either choose to Start from the latest offset or Start from a specified point to set the Topic's Consumer Offset (Namely, specify where the consumer under this subscription begins to consume messages).
    3. Click Submit to complete the setting.
    
    Note:
    TDMQ-RocketMQ supports resetting the offset for offline Groups, but currently only supports consumer groups under the Push consumption mode; otherwise, it might fail to reset.

    Edit Group

    1. In Group list, click Edit in the operations column of the target Group.
    
    2. In the pop-up window, edit the Group information.
    3. Click Submit to complete the modification.

    Delete Group

    Batch Deletion: In Group list, select all the Groups that need to be deleted, click Batch Delete at the top-left corner. In the prompt box, click Delete to complete the deletion.
    Single Deletion: In Group list, locate the Group that requires to delete, click Delete in the operations column. In the prompt box, click Delete to complete the deletion.
    
    Note:
    After the Group is deleted, consumers identified by this Group will cease to receive messages immediately. All configurations under this Group will be erased and are irretrievable, please proceed with caution.

    Metadata Import/Export

    Metadata Export

    You can directly export metadata through the
    
    button at the upper-right corner of the Group list page. The exported metadata will be formatted as an .xlsx table file.

    Metadata Import

    If you need to load Group information from one cluster into another, after exporting metadata, click the
    
    button in the upper-right corner of the Group list page to import Group data into the specified namespace.
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support