/usr/bin/kafka-consumer-groups.sh

This tool helps to list, describe, delete and manage the offsets of consumer groups.
Option                                  Description
------                                  -----------
--all-groups                            Apply to all consumer groups.
--all-topics                            Apply to all topics.
--bootstrap-server <String: server to   The server(s) to connect to. REQUIRED
  connect to>                             for all options except for --
                                          validate-regex.
--by-duration <String: duration>        Reset offsets by duration from current
                                          timestamp. Format: 'PnDTnHnMnS'
--command-config <String: command       Property file containing configs to be
  config property file>                   passed to Admin Client and Consumer.
--delete                                Delete topic partition offsets and
                                          ownership information for one or
                                          more consumer groups.
--delete-offsets                        Delete offsets of consumer group.
                                          Supports one consumer group at a
                                          time, and multiple topics.
--describe                              Describe consumer group and list
                                          offset lag (number of messages not
                                          yet processed) related to given
                                          group.
--dry-run                               Output offset reset information
                                          without executing the operation.
                                          Supported operation: reset-offsets.
--execute                               Execute the offset reset operation.
                                          Supported operation: reset-offsets.
--export                                Generate offset reset information in
                                          CSV format for export to a file.
                                          Supported operation: reset-offsets.
--from-file <String: path to CSV file>  Reset offsets to values defined in CSV
                                          file.
--group <String: group id>              The consumer group id.
--help                                  Print usage information.
--list                                  List all consumer groups.
--members                               Describe members of the group. This
                                          option may be used with the --
                                          describe option only.
                                        Example: --bootstrap-server localhost:
                                          9092 --describe --group group1 --
                                          members
--offsets                               Describe the group and list all topic
                                          partitions in the group along with
                                          their offset lag. This is the
                                          default sub-action of and may be
                                          used with the --describe option only.
                                        Example: --bootstrap-server localhost:
                                          9092 --describe --group group1 --
                                          offsets
--reset-offsets                         Reset offsets of consumer group.
                                          Supports one consumer group at a
                                          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 can
                                          be used to generate the offsets in
                                          CSV format for export to a file.
                                        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. The scope must be
                                          specified unless you use --from-file.
--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, it
                                          displays the state of the group.
                                        Example: --bootstrap-server localhost:
                                          9092 --describe --group group1 --
                                          state
                                        When specified with --list, it
                                          displays the states of the groups.
                                          It can also be used to list groups
                                          with specific states.
                                        Example: --bootstrap-server localhost:
                                          9092 --list --state stable,empty
                                        This option may be used with --
                                          describe and --list options only.
--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: 30000)
--to-current                            Reset offsets to current offset.
--to-datetime <String: datetime>        Reset offsets to offset from datetime.
                                          Format: 'YYYY-MM-DDThh:mm:ss.sss'
--to-earliest                           Reset offsets to earliest offset.
--to-latest                             Reset offsets to latest offset.
--to-offset <Long: offset>              Reset offsets to a specific offset.
--topic <String: topic>                 The topic whose offset information
                                          should be deleted or reset. In
                                          `reset-offsets` case, partitions can
                                          be specified using this format:
                                          `topic:0,1,2`, where 0,1,2 are the
                                          partitions to be included. Reset-
                                          offsets also supports multiple
                                          topics.
--type [String]                         When specified with --list, it
                                          displays the types of the groups. It
                                          can also be used to list groups with
                                          specific types.
                                        Example: --bootstrap-server localhost:
                                          9092 --list --type classic,consumer
                                        This option may be used with the --
                                          list option only.
--validate-regex <String: regex>        Validate the syntax of the regular
                                          expression according to the RE2
                                          format.
--verbose                               Provide additional information, if
                                          any, when describing the group. This
                                          option may be used with the --
                                          describe option only.
--version                               Display Kafka version.