第一句子网 > kafka-consumer-groups.sh 命令行工具使用手册附测试用例

kafka-consumer-groups.sh 命令行工具使用手册附测试用例

时间：2024-03-27 03:04:54

kafka-consumer-groups 命令行工具使用手册

该手册原文出自$KAFKA_HOME\bin\windows\kafka-consumer-groups.bat --help命令的输出结果，并由 Redisant 提供翻译和测试用例。

--all-groups

Apply to all consumer groups.

指定所有的消费者组。和--describe,--delete,--reset-offsets,--delete-offsets配合使用

--all-topics

Consider all topics assigned to a group in thereset-offsetsprocess.

指定所有的消费者组。和--reset-offsets配合使用

--bootstrap-server

REQUIRED: The server(s) to connect to.

必填项，Kafka服务器的地址和端口。

--by-duration

Reset offsets to offset by duration from current timestamp. Format: ‘PnDTnHnMnS’

--command-config

Property file containing configs to be passed to Admin Client and Consumer.

--delete

Pass in groups to delete topic partition offsets and ownership information over the entire consumer group. For instance --group g1 --group g2

删除整个消费者组（包括已保存的偏移量信息和所有权信息），在执行该操作之前，必须关闭所有的消费者。

删除所有的消费者组

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --all-groups CountryCounter --deleteDeletion of requested consumer groups ('CountryCounter', 'OrderCounter') was successful.

删除指定的消费者组

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --group CountryCounter --deleteDeletion of requested consumer groups ('CountryCounter') was successful.

--delete-offsets

Delete offsets of consumer group. Supports one consumer group at the time, and multiple topics.

删除消费者组的偏移量。例如：

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --delete-offsets --group CountryCounter --topic t1

--describe

Describe consumer group and list offset lag (number of messages not yet processed) related to given group.

列出消费者组里所有主题的信息和每个分区的偏移量。例如：

查看指定的消费者组：

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --group CountryCounter --describeGROUP TOPIC PARTITION CURRENT-OFFSET LOG-END-OFFSET LAG CONSUMER-ID HOST CLIENT-IDCountryCounter user_card 0214 214 0chenjing_client-42cc37c6-695f-4c47-b844-764a3d2169d3 /111.18.132.232 chenjing_clientCountryCounter t1 0189 189 0chenjing_client-42cc37c6-695f-4c47-b844-764a3d2169d3 /111.18.132.232 chenjing_client

查看所有的消费者组：

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --all-groups --describeGROUP TOPIC PARTITION CURRENT-OFFSET LOG-END-OFFSET LAG CONSUMER-ID HOST CLIENT-IDCountryCounter user_card 0214 214 0chenjing_client-42cc37c6-695f-4c47-b844-764a3d2169d3 /111.18.132.232 chenjing_clientCountryCounter t1 0189 189 0chenjing_client-42cc37c6-695f-4c47-b844-764a3d2169d3 /111.18.132.232 chenjing_clientGROUP TOPIC PARTITION CURRENT-OFFSET LOG-END-OFFSET LAG CONSUMER-IDHOST CLIENT-IDOrderCounter t1 0189 189 0client_2-26992db5-d5ab-4252-a219-995bdbe37388 /111.18.132.232 client_2OrderCounter t2 01257 1257 0client_2-26992db5-d5ab-4252-a219-995bdbe37388 /111.18.132.232 client_2

--group

The consumer group we wish to act on.

配合其他命令执行消费者组

--help

Print usage information.

打印帮助手册

--list

List all consumer groups.

列出所有的消费者组。例如：

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --listOrderCounterCountryCounter

--members

Describe members of the group. This option may be used with ‘–describe’ and ‘–bootstrap-server’ options only. Example: --bootstrap-server localhost:9092 --describe --group group1 --members

查看消费者组里有哪些成员，该选项只能和--describe和--bootstrap-server一起使用。例如：

查看指定的消费者组里有哪些成员

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --group CountryCounter --describe --membersGROUP CONSUMER-ID HOST CLIENT-ID #PARTITIONSCountryCounter chenjing_client-42cc37c6-695f-4c47-b844-764a3d2169d3 /111.18.132.232 chenjing_client 2

查看所有的消费者组里有哪些成员

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --all-groups --describe --membersGROUP CONSUMER-ID HOST CLIENT-ID #PARTITIONSCountryCounter chenjing_client-42cc37c6-695f-4c47-b844-764a3d2169d3 /111.18.132.232 chenjing_client 2GROUP CONSUMER-IDHOST CLIENT-ID #PARTITIONSOrderCounter client_2-26992db5-d5ab-4252-a219-995bdbe37388 /111.18.132.232 client_2 2

--reset-offsets

Reset offsets of consumer group. Supports one consumer group at the time, and instances should be inactive.

Has 2 execution options: --dry-run (the default) to plan which offsets to reset, and --execute to update the offsets. Additionally, the --export option is used to export the results to a CSV format.

You must choose one of the following reset specifications: --to-datetime, --by-duration, --to-earliest, --to-latest, --shift-by, --from-file, --to-current, --to-offset.

To define the scope use --all-topics or --topic. One scope must be specified unless you use ‘–from-file’.

重置消费者组的偏移量。如果执行消费者组，一次只能指定一个消费组（需要提前关闭相关的消费者和生产者）。有两个执行参数：--dry-run（默认值）用于打印计划要重置的偏移量，以及--execute以更新偏移量。此外，--export选项用于将结果导出为 CSV 格式。必须选择以下重置类型之一（关于这些重置类型的更多参考请查看官方文档）：--to-datetime,--by-duration,--to-earliest,--to-latest,--shift-by,--from-file,--to-current,--to-offset。

例如（以下所有命令均使用--dry-run参数打印执行计划，如果执行计划符合你的期望，请把--dry-run替换为--execute以真正更新偏移量）：

重置指定消费组的所有Topic的偏移量

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --reset-offsets --to-earliest --group CountryCounter --dry-run --all-topicsGROUPTOPICPARTITION NEW-OFFSETCountryCounter user_card 10CountryCounter user_card 0521CountryCounter user_card 20CountryCounter t1 00

重置指定消费组的指定Topic的偏移量

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --reset-offsets --to-earliest --group CountryCounter --dry-run --topic t1GROUPTOPICPARTITION NEW-OFFSETCountryCounter t1 00

重置所有消费组的所有Topic的偏移量

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --reset-offsets --to-earliest --all-groups --dry-run --all-topicsGROUPTOPICPARTITION NEW-OFFSETOrderCounter t2 20OrderCounter t1 00OrderCounter t2 10OrderCounter t2 00CountryCounter user_card 10CountryCounter user_card 0521CountryCounter user_card 20CountryCounter t1 00

重置所有消费组中指定Topic的偏移量

--shift-by <Long: number-of-offsets>

Reset offsets shifting current offset by ‘n’, where ‘n’ can be positive or negative.

--state [String]

When specified with ‘–describe’, includes the state of the group. Example: --bootstrap-server localhost:9092 --describe --group group1 --state

和--describe配合使用，列出消费者组的状态。例如：

列出指定消费者组的状态

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --group CountryCounter --describe --stateGROUP COORDINATOR (ID)ASSIGNMENT-STRATEGY STATE #MEMBERSCountryCounter 192.168.31.253:9092 (0) rangeStable1

列出所有消费者组的状态

PS C:\Users\chenjing\kafka_2.12-3.3.1> .\bin\windows\kafka-consumer-groups.bat --bootstrap-server 192.168.31.253:9092 --all-groups --describe --stateGROUP COORDINATOR (ID)ASSIGNMENT-STRATEGY STATE #MEMBERSCountryCounter 192.168.31.253:9092 (0) rangeStable1GROUP COORDINATOR (ID)ASSIGNMENT-STRATEGY STATE #MEMBERSOrderCounter 192.168.31.253:9092 (0) rangeStable1

--timeout <Long: timeout (ms)>

The timeout that can be set for some use cases. For example, it can be used when describing the group to specify the maximum amount of time in milliseconds to wait before the group stabilizes (when the group is just created, or is going through some changes). (default: 5000)

可以为某些用例设置的超时。例如，在显示消费者组的详情时，可以使用它来指定在组稳定之前等待的最长时间（以毫秒为单位）（当组刚刚创建或正在经历一些更改时），默认值：5000

--topic

The topic whose consumer group information should be deleted or topic whose should be included in the reset offset process. Inreset-offsetscase, partitions can be specified using this format:topic1:0,1,2, where 0,1,2 are the partition to be included in the process. Reset-offsets also supports multiple topic inputs.

配合其他命令指定主题名

--verbose

Provide additional information, if any, when describing the group. This option may be used with ‘–offsets’/‘–members’/‘–state’ and ‘–bootstrap-server’ options only.