OS Manuals

/usr/lib/kafka/bin/kafka-jmx.sh

Community edition of Confluent Kafka.

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

Also provided by 1 other package version
Dump JMX values to standard output.
Option                                   Description
------                                   -----------
--attributes <String: name>              The list of attributes to include in
                                           the query. This is a comma-separated
                                           list. If no attributes are specified
                                           all objects will be queried.
--date-format <String: format>           The date format to use for formatting
                                           the time field. See java.text.
                                           SimpleDateFormat for options.
--help                                   Print usage information.
--jmx-auth-prop <String: jmx-auth-prop>  A mechanism to pass property in the
                                           form 'username=password' when
                                           enabling remote JMX with password
                                           authentication.
--jmx-ssl-enable <Boolean: ssl-enable>   Flag to enable remote JMX with SSL.
                                           (default: false)
--jmx-url <String: service-url>          The url to connect to poll JMX data.
                                           See Oracle javadoc for JMXServiceURL
                                           for details. (default: service:jmx:
                                           rmi:///jndi/rmi://:9999/jmxrmi)
--object-name <String: name>             A JMX object name to use as a query.
                                           This can contain wild cards, and
                                           this option can be given multiple
                                           times to specify more than one
                                           query. If no objects are specified
                                           all objects will be queried.
--one-time [Boolean: one-time]           Flag to indicate run once only.
                                           (default: false)
--report-format <String: report-format>  output format name: either 'original',
                                           'properties', 'csv', 'tsv'
                                           (default: original)
--reporting-interval <Integer: ms>       Interval in MS with which to poll jmx
                                           stats; default value is 2 seconds.
                                           Value of -1 equivalent to setting
                                           one-time to true (default: 2000)
--version                                Display Kafka version.
--wait                                   Wait for requested JMX objects to
                                           become available before starting
                                           output. Only supported when the list
                                           of objects is non-empty and contains
                                           no object name patterns.
Options (12)
OptionDescriptionSource
--attributes String:The list of attributes to include in the query.help
--date-format String:The date format to use for formatting the time field.help
--helpPrint usage information.help
--jmx-auth-prop String:A mechanism to pass property in the form 'username=password' when enabling remote JMX with password authentication.help
--jmx-ssl-enable Boolean:Flag to enable remote JMX with SSL.help
--jmx-url String:The url to connect to poll JMX data.help
--object-name String:A JMX object name to use as a query.help
--one-time Boolean:Flag to indicate run once only.help
--report-format String:output format name: either 'original', 'properties', 'csv', 'tsv' (default: original)help
--reporting-interval Integer:Interval in MS with which to poll jmx stats;help
--versionDisplay Kafka version.help
--waitWait for requested JMX objects to become available before starting output.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.