OS Manuals

/usr/lib/kafka/bin/kafka-verifiable-consumer.sh

Community edition of Confluent Kafka.

From confluent-kafka 8.4.0.215-r1 (os), captured 2026-11-08 by running kafka-verifiable-consumer.sh --help (exit 1). permalink

usage: verifiable-consumer [-h] --topic TOPIC [--group-protocol GROUP-PROTOCOL]
                           [--group-remote-assignor GROUP-REMOTE-ASSIGNOR] --group-id GROUP-ID
                           [--group-instance-id GROUP-INSTANCE-ID]
                           [--max-messages MAX-MESSAGES] [--session-timeout TIMEOUT-MS]
                           [--verbose] [--enable-autocommit] [--reset-policy RESET-POLICY]
                           [--assignment-strategy ASSIGNMENT-STRATEGY]
                           [--consumer.config CONFIG-FILE] [--command-config CONFIG-FILE]
                           --bootstrap-server HOST1:PORT1[,HOST2:PORT2[...]]

This tool consumes messages  from  a  specific  topic  and  emits  consumer  events (e.g. group
rebalances, received messages, and offsets committed) as JSON objects to STDOUT.

optional arguments:
  -h, --help             show this help message and exit
  --topic TOPIC          Consumes messages from this topic.
  --group-protocol GROUP-PROTOCOL
                         Group protocol (must be one of CLASSIC, CONSUMER) (default: classic)
  --group-remote-assignor GROUP-REMOTE-ASSIGNOR
                         Group remote assignor; only used if the group protocol is CONSUMER
  --group-id GROUP-ID    The group id of the consumer group
  --group-instance-id GROUP-INSTANCE-ID
                         A unique identifier of the consumer instance
  --max-messages MAX-MESSAGES
                         Consume this many messages.  If  -1  (the  default), the consumer will
                         consume until the process is killed externally (default: -1)
  --session-timeout TIMEOUT-MS
                         Set the consumer's session  timeout,  note  that this configuration is
                         not supported when group protocol is consumer
  --verbose              Enable to log individual consumed records (default: false)
  --enable-autocommit    Enable offset auto-commit on consumer (default: false)
  --reset-policy RESET-POLICY
                         Set reset policy  (must  be  either  'earliest',  'latest', or 'none')
                         (default: earliest)
  --assignment-strategy ASSIGNMENT-STRATEGY
                         Set  assignment   strategy   (e.g.  org.apache.kafka.clients.consumer.
                         RoundRobinAssignor); only  used  if  the  group  protocol  is  CLASSIC
                         (default: org.apache.kafka.clients.consumer.RangeAssignor)
  --consumer.config CONFIG-FILE
                         (DEPRECATED) Consumer config  properties  file.  This  option  will be
                         removed in a future version. Use --command-config instead
  --command-config CONFIG-FILE
                         Config properties  file  (config  options  shared  with  command  line
                         parameters will be overridden).

Connection Group:
  Group of arguments for connection to brokers

  --bootstrap-server HOST1:PORT1[,HOST2:PORT2[...]]
                         The server(s) to connect to. Comma-separated  list of Kafka brokers in
                         the form HOST1:PORT1,HOST2:PORT2,...
Options (15)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--topic TOPICConsumes messages from this topic.help
--group-protocol GROUP-PROTOCOLGroup protocol (must be one of CLASSIC, CONSUMER) (default: classic)help
--group-remote-assignor GROUP-REMOTE-ASSIGNORGroup remote assignor;help
--group-id GROUP-IDThe group id of the consumer grouphelp
--group-instance-id GROUP-INSTANCE-IDA unique identifier of the consumer instancehelp
--max-messages MAX-MESSAGESConsume this many messages.help
--session-timeout TIMEOUT-MSSet the consumer's session timeout, note that this configuration is not supported when group protocol is consumerhelp
--verboseEnable to log individual consumed records (default: false)help
--enable-autocommitEnable offset auto-commit on consumer (default: false)help
--reset-policy RESET-POLICYSet reset policy (must be either 'earliest', 'latest', or 'none') (default: earliest)help
--assignment-strategy ASSIGNMENT-STRATEGYSet assignment strategy (e.g. org.apache.kafka.clients.consumer.help
--consumer.config CONFIG-FILE(DEPRECATED) Consumer config properties file.help
--command-config CONFIG-FILEConfig properties file (config options shared with command line parameters will be overridden).help
--bootstrap-server HOST1:PORT1The server(s) to connect to.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.