Viewing and Resetting Kafka Consumption Offsets

Prerequisites

The consumer offset cannot be reset on the fly. You must first stop retrieval of the desired consumer group.

After a client is stopped, the server considers the client offline only after the time period specified in ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG (1000 ms by default).

Viewing Consumer Offsets (Console)

1. Log in to the 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 the instance details.
5. In the navigation pane, choose Consumer Groups.
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, message consumption progress in each partition of the topic (accumulated messages, offset, latest offset, consumer ID, consumer address, and client ID).
   Figure 1 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 username and password, and 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. Add the username and password, and the SSL certificate configuration 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 

Resetting Consumer Offsets

1. Log in to the 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 the instance 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, you can perform the following operations:
   • To reset the consumer offset of all partitions of a single topic, click Reset Consumer Offset in the row containing the desired topic.
   • To reset the consumer offset of a single partition of a single topic, click Reset Consumer Offset in the row containing the desired partition.
   • To reset the consumer offset of all partitions in all topics, click Reset Offset above the list.

8. In the displayed Reset Consumer Offset dialog box, set the parameters by referring to Table 1.

   Table 1 Parameters for resetting the consumer offset

   Parameter	Description
   Reset By	You can reset an offset by: Time: Reset the offset to the specified time. Offset: Reset the offset to the specified position. If you reset offsets in batches, they can only be reset to the specified time.
   Time	Set this parameter if Reset By is set to Time. Select a time point. After the reset is complete, retrieval starts from this time point. Earliest: earliest offset Custom: a custom time point Latest: latest offset
   Offset	Set this parameter if Reset By is set to Offset. Enter an offset, which is greater than or equal to 0. After the reset is complete, retrieval starts from this offset.

9. Click OK.
10. Click Yes in the confirmation dialog box. The consumer offset is reset.