Querying Consumer Group Details

Prerequisites

The consumer list can be viewed only when consumers in a consumer group are connected to the Kafka instance (that is, the consumer group is in the STABLE state).

Viewing the Consumer Group List (Console)

1. Log in to the management console.
2. Click in the upper left corner to select a region.
   

   Select the region where your Kafka instance is located.

3. Click and choose Application > Distributed Message Service for Kafka to open the console of DMS for Kafka.
4. Click the desired Kafka instance to view its details.
5. In the navigation pane, choose the Consumer Groups tab.

   The consumer group name, status, and Coordinator are displayed. Coordinator indicates the broker where the coordinator component is located. The consumer group status can be:

   • DEAD: The consumer group has no member or metadata.
   • EMPTY: The consumer group has metadata but has no member.
   • PREPARING_REBALANCE: The consumer group is to be rebalanced.
   • COMPLETING_REBALANCE: All members have joined the consumer group.
   • STABLE: Members in the consumer group can consume messages normally.
   Figure 1 Consumer group list
   

6. (Optional) To query a specific consumer group, enter the consumer group name in the search box and click .
7. (Optional) To refresh the consumer group list, click in the upper right corner.

Viewing the Consumer Group List (Kafka CLI)

• If SASL is not enabled for the Kafka instance, run the following command in the /{directory where the CLI is located}/kafka_{version}/bin/ directory to query the consumer group list:

  ./kafka-consumer-groups.sh --bootstrap-server {broker_ip}:{port} --list

• If SASL has been enabled for the Kafka instance, perform the following steps to query the consumer group list:
  1. (Optional) If the SSL certificate configuration has been set, skip this step. Otherwise, perform the following operations:

     Create the ssl-user-config.properties file in the /config directory of the Kafka client and add the SSL certificate configurations by referring to 3.

  2. Run the following command in the /{directory where the CLI is located}/kafka_{version}/bin/ directory to query the consumer group list:

     ./kafka-consumer-groups.sh --bootstrap-server {broker_ip}:{port} --list --command-config ./config/ssl-user-config.properties 

Viewing the Consumer List (Console)

1. Log in to the management console.
2. Click in the upper left corner to select a region.
   

   Select the region where your Kafka instance is located.

3. Click and choose Application > Distributed Message Service for Kafka to open the console of DMS for Kafka.
4. Click the desired Kafka instance to view its details.
5. In the navigation pane, choose the Consumer Groups tab.
6. Click the name of the desired consumer group.
7. On the Consumers tab page, view the consumer list.

   In the consumer list, you can view the consumer ID, consumer address, and client ID.

8. (Optional) To query a specific consumer, enter the consumer ID in the search box and click .

Viewing the Consumer List (Kafka CLI)

• If SASL is not enabled for the Kafka instance, run the following command in the /{directory where the CLI is located}/kafka_{version}/bin/ directory to query the consumer list:

  ./kafka-consumer-groups.sh --bootstrap-server {broker_ip}:{port} --group {group_name} --members --describe

• If SASL has been enabled for the Kafka instance, perform the following steps to query the consumer list:
  1. (Optional) If the SSL certificate configuration has been set, skip this step. Otherwise, perform the following operations:

     Create the ssl-user-config.properties file in the /config directory of the Kafka client and add the SSL certificate configurations by referring to 3.

  2. Run the following command in the /{directory where the CLI is located}/kafka_{version}/bin/ directory to query the consumer list:

     ./kafka-consumer-groups.sh --bootstrap-server {broker_ip}:{port} --group {group_name} --members --describe --command-config ./config/ssl-user-config.properties 

Viewing Consumer Offsets (Console)

1. Log in to the management console.
2. Click in the upper left corner to select a region.
   

   Select the region where your Kafka instance is located.

3. Click and choose Application > Distributed Message Service for Kafka to open the console of DMS for Kafka.
4. Click the desired Kafka instance to view its details.
5. In the navigation pane, choose the Consumer Groups tab.
6. Click the name of the desired consumer group.
7. On the Consumer Offset tab page, view the list of topics that the consumer group has subscribed to, total number of messages accumulated in the topic, number of messages accumulated in each partition of the topic, offset of each partition, and latest offset.
   Figure 2 Consumer offsets
   

8. (Optional) To query the consumer offsets of a specific topic, enter the topic name in the search box and click .

Viewing Consumer Offsets (Kafka CLI)

• If SASL is not enabled for the Kafka instance, run the following command in the /{directory where the CLI is located}/kafka_{version}/bin/ directory to query consumer offsets:

  ./kafka-consumer-groups.sh --bootstrap-server {broker_ip}:{port} --offsets --describe --all-groups

• If SASL has been enabled for the Kafka instance, perform the following steps to query consumer offsets:
  1. (Optional) If the SSL certificate configuration has been set, skip this step. Otherwise, perform the following operations:

     Create the ssl-user-config.properties file in the /config directory of the Kafka client and add the SSL certificate configurations by referring to 3.

  2. Run the following command in the /{directory where the CLI is located}/kafka_{version}/bin/ directory to query consumer offsets:

     ./kafka-consumer-groups.sh --bootstrap-server {broker_ip}:{port} --offsets --describe --all-groups --command-config ./config/ssl-user-config.properties