OS Manuals

/usr/bin/kafka_exporter

Kafka exporter for Prometheus

From kafka_exporter 1.9.0-r54 (os), captured 2026-11-05 by running kafka_exporter --help (exit 0). permalink

Also provided by 2 other package versions
usage: kafka_exporter [<flags>]


Flags:
  -h, --[no-]help                Show context-sensitive help (also try --help-long and --help-man).
      --web.listen-address=":9308"
                                 Address to listen on for web interface and telemetry.
      --web.telemetry-path="/metrics"
                                 Path under which to expose metrics.
      --topic.filter=".*"        Regex that determines which topics to collect.
      --topic.exclude="^$"       Regex that determines which topics to exclude.
      --group.filter=".*"        Regex that determines which consumer groups to collect.
      --group.exclude="^$"       Regex that determines which consumer groups to exclude.
      --[no-]log.enable-sarama   Turn on Sarama logging, default is false.
      --kafka.server=kafka:9092 ...
                                 Address (host:port) of Kafka server.
      --[no-]sasl.enabled        Connect using SASL/PLAIN, default is false.
      --[no-]sasl.handshake      Only set this to false if using a non-Kafka SASL proxy, default is
                                 true.
      --sasl.username=""         SASL user name.
      --sasl.password=""         SASL user password.
      --sasl.aws-region=""       The AWS region for IAM SASL authentication
      --sasl.mechanism=""        SASL SCRAM SHA algorithm: sha256 or sha512 or SASL mechanism:
                                 gssapi or awsiam
      --sasl.service-name=""     Service name when using kerberos Auth
      --sasl.kerberos-config-path=""
                                 Kerberos config path
      --sasl.realm=""            Kerberos realm
      --sasl.kerberos-auth-type=""
                                 Kerberos auth type. Either 'keytabAuth' or 'userAuth'
      --sasl.keytab-path=""      Kerberos keytab file path
      --[no-]sasl.disable-PA-FX-FAST
                                 Configure the Kerberos client to not use PA_FX_FAST, default is
                                 false.
      --[no-]tls.enabled         Connect to Kafka using TLS, default is false.
      --tls.server-name=""       Used to verify the hostname on the returned certificates unless
                                 tls.insecure-skip-tls-verify is given. The kafka server's name
                                 should be given.
      --tls.ca-file=""           The optional certificate authority file for Kafka TLS client
                                 authentication.
      --tls.cert-file=""         The optional certificate file for Kafka client authentication.
      --tls.key-file=""          The optional key file for Kafka client authentication.
      --[no-]server.tls.enabled  Enable TLS for web server, default is false.
      --[no-]server.tls.mutual-auth-enabled
                                 Enable TLS client mutual authentication, default is false.
      --server.tls.ca-file=""    The certificate authority file for the web server.
      --server.tls.cert-file=""  The certificate file for the web server.
      --server.tls.key-file=""   The key file for the web server.
      --[no-]tls.insecure-skip-tls-verify
                                 If true, the server's certificate will not be checked for validity.
                                 This will make your HTTPS connections insecure. Default is false
      --kafka.version="2.0.0"    Kafka broker version
      --[no-]use.consumelag.zookeeper
                                 if you need to use a group from zookeeper, default is false
      --zookeeper.server=localhost:2181 ...
                                 Address (hosts) of zookeeper server.
      --kafka.labels=""          Kafka cluster name
      --refresh.metadata="30s"   Metadata refresh interval
      --[no-]offset.show-all     Whether show the offset/lag for all consumer group, otherwise,
                                 only show connected consumer groups, default is true
      --[no-]concurrent.enable   If true, all scrapes will trigger kafka operations otherwise,
                                 they will share results. WARN: This should be disabled on large
                                 clusters. Default is false
      --topic.workers=100        Number of topic workers
      --[no-]kafka.allow-auto-topic-creation
                                 If true, the broker may auto-create topics that we requested which
                                 do not already exist, default is false.
      --verbosity=0              Verbosity log level
      --log.level=info           Only log messages with the given severity or above. One of: [debug,
                                 info, warn, error]
      --log.format=logfmt        Output format of log messages. One of: [logfmt, json]
      --[no-]version             Show application version.
Options (32)
OptionDescriptionSource
-hShow context-sensitive help (also try --help-long and --help-man).help
--web.listen-address ":9308"Address to listen on for web interface and telemetry.help
--web.telemetry-path "/metrics"Path under which to expose metrics.help
--topic.filter ".*"Regex that determines which topics to collect.help
--topic.exclude "^$"Regex that determines which topics to exclude.help
--group.filter ".*"Regex that determines which consumer groups to collect.help
--group.exclude "^$"Regex that determines which consumer groups to exclude.help
--kafka.server kafka:9092Address (host:port) of Kafka server.help
--sasl.username ""SASL user name.help
--sasl.password ""SASL user password.help
--sasl.aws-region ""The AWS region for IAM SASL authenticationhelp
--sasl.mechanism ""SASL SCRAM SHA algorithm: sha256 or sha512 or SASL mechanism: gssapi or awsiamhelp
--sasl.service-name ""Service name when using kerberos Authhelp
--sasl.kerberos-config-path ""Kerberos config pathhelp
--sasl.realm ""Kerberos realmhelp
--sasl.kerberos-auth-type ""Kerberos auth type.help
--sasl.keytab-path ""Kerberos keytab file pathhelp
--tls.server-name ""Used to verify the hostname on the returned certificates unless tls.insecure-skip-tls-verify is given.help
--tls.ca-file ""The optional certificate authority file for Kafka TLS client authentication.help
--tls.cert-file ""The optional certificate file for Kafka client authentication.help
--tls.key-file ""The optional key file for Kafka client authentication.help
--server.tls.ca-file ""The certificate authority file for the web server.help
--server.tls.cert-file ""The certificate file for the web server.help
--server.tls.key-file ""The key file for the web server.help
--kafka.version "2.0.0"Kafka broker versionhelp
--zookeeper.server localhost:2181Address (hosts) of zookeeper server.help
--kafka.labels ""Kafka cluster namehelp
--refresh.metadata "30s"Metadata refresh intervalhelp
--topic.workers 100Number of topic workershelp
--verbosity 0Verbosity log levelhelp
--log.level infoOnly log messages with the given severity or above.help
--log.format logfmtOutput format of log messages.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.