OS Manuals

/usr/lib/kafka/bin/kafka-share-consumer-perf-test.sh

Community edition of Confluent Kafka.

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

This tool is used to verify the share consumer performance.
Option                                   Description
------                                   -----------
--bootstrap-server <String: server to    REQUIRED. The server(s) to connect to.
  connect to>
--command-config <String: config file>   Config properties file.
--command-property <String: prop1=val1>  Kafka share consumer related
                                           configuration properties like client.
                                           id. These configs take precedence
                                           over those passed via --command-
                                           config or --consumer.config.
--consumer.config <String: config file>  (DEPRECATED) Share consumer config
                                           properties file. This option will be
                                           removed in a future version. Use --
                                           command-config instead.
--date-format <String: date format>      The date format to use for formatting
                                           the time field. See java.text.
                                           SimpleDateFormat for options.
                                           (default: yyyy-MM-dd HH:mm:ss:SSS)
--fetch-size <Integer: size>             The amount of data to fetch in a
                                           single request. (default: 1048576)
--group <String: gid>                    The group id to consume on. (default:
                                           perf-share-consumer)
--help                                   Print usage information.
--hide-header                            If set, skips printing the header for
                                           the stats.
--messages <Long: count>                 (DEPRECATED) The number of records to
                                           consume. This option will be removed
                                           in a future version. Use --num-
                                           records instead.
--num-records <Long: count>              REQUIRED: The number of records to
                                           consume.
--print-metrics                          Print out the metrics.
--reporting-interval <Long:              Interval in milliseconds at which to
  interval_ms>                             print progress info. (default: 5000)
--show-consumer-stats                    If set, stats are reported for each
                                           share consumer depending on the no.
                                           of threads.
--show-detailed-stats                    If set, stats are reported for each
                                           reporting interval as configured by
                                           reporting-interval.
--socket-buffer-size <Integer: size>     The size of the tcp RECV size.
                                           (default: 2097152)
--threads <Integer: count>               The number of share consumers to use
                                           for sharing the load. (default: 1)
--timeout [Long: milliseconds]           The maximum allowed time in
                                           milliseconds between returned
                                           records. (default: 10000)
--topic <String: topic>                  REQUIRED: The topic to consume from.
--version                                Display Kafka version.
Options (20)
OptionDescriptionSource
--bootstrap-server String:REQUIRED.help
--command-config String:Config properties file.help
--command-property String:Kafka share consumer related configuration properties like client.help
--consumer.config String:(DEPRECATED) Share consumer config properties file.help
--date-format String:The date format to use for formatting the time field.help
--fetch-size Integer:The amount of data to fetch in a single request.help
--group String:The group id to consume on.help
--helpPrint usage information.help
--hide-headerIf set, skips printing the header for the stats.help
--messages Long:(DEPRECATED) The number of records to consume.help
--num-records Long:REQUIRED: The number of records to consume.help
--print-metricsPrint out the metrics.help
--reporting-interval Long:Interval in milliseconds at which to interval_ms> print progress info.help
--show-consumer-statsIf set, stats are reported for each share consumer depending on the no.help
--show-detailed-statsIf set, stats are reported for each reporting interval as configured by reporting-interval.help
--socket-buffer-size Integer:The size of the tcp RECV size.help
--threads Integer:The number of share consumers to use for sharing the load.help
--timeout Long:The maximum allowed time in milliseconds between returned records.help
--topic String:REQUIRED: The topic to consume from.help
--versionDisplay Kafka version.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.