kafka_exporter job from prometheus/31.0.0

Github source: c2d6d4c or master branch

Properties¶

kafka_exporter¶

concurrent¶

enable¶

If true, all scrapes will trigger kafka operations otherwise, they will share results. WARN - This should be disabled on large clusters

Default

false

group¶

exclude¶

Regex that determines which consumer groups to exclude

Default

^$

filter¶

Regex that determines which consumer groups to collect

Default

.*

kafka¶

allow_auto_topic_creation¶

If true, the broker may auto-create topics that we requested which do not already exist

Default

false

labels¶

Kafka cluster name

servers¶

List of Kafka server addresses (host:port)

Example

- kafka1:9092
- kafka2:9092

version¶

Kafka broker version

Default

2.0.0

log¶

enable_sarama¶

Turn on Sarama logging

Default

false

format¶

Output format of log messages. One of [logfmt, json]

Default

logfmt

level¶

Only log messages with the given severity or above. One of [debug, info, warn, error]

Default

info

offset¶

show_all¶

Whether show the offset/lag for all consumer group, otherwise, only show connected consumer groups

Default

true

refresh¶

metadata¶

Metadata refresh interval

Default

30s

sasl¶

aws_region¶

The AWS region for IAM SASL authentication

disable_pa_fx_fast¶

Configure the Kerberos client to not use PA_FX_FAST

Default

false

enabled¶

Connect using SASL/PLAIN

Default

false

handshake¶

Only set this to false if using a non-Kafka SASL proxy

Default

true

kerberos_auth_type¶

Kerberos auth type. Either ‘keytabAuth’ or ‘userAuth’

kerberos_config_path¶

Kerberos config path

keytab_path¶

Kerberos keytab file path

mechanism¶

SASL SCRAM SHA algorithm (sha256 or sha512) or SASL mechanism (gssapi or awsiam)

password¶

SASL user password

realm¶

Kerberos realm

service_name¶

Service name when using kerberos Auth

username¶

SASL user name

server¶

tls¶

ca_file¶

The certificate authority file for the web server

cert_file¶

The certificate file for the web server

enabled¶

Enable TLS for web server

Default

false

key_file¶

The key file for the web server

mutual_auth_enabled¶

Enable TLS client mutual authentication

Default

false

tls¶

ca_file¶

The optional certificate authority file for Kafka TLS client authentication

cert_file¶

The optional certificate file for Kafka client authentication

enabled¶

Connect to Kafka using TLS

Default

false

insecure_skip_tls_verify¶

If true, the server’s certificate will not be checked for validity

Default

false

key_file¶

The optional key file for Kafka client authentication

server_name¶

Used to verify the hostname on the returned certificates unless tls.insecure_skip_tls_verify is given

topic¶

exclude¶

Regex that determines which topics to exclude

Default

^$

filter¶

Regex that determines which topics to collect

Default

.*

workers¶

Number of topic workers

Default

100

use¶

consumelag¶

zookeeper¶

If you need to use a group from zookeeper

Default

false

verbosity¶

Verbosity log level

Default

0

web¶

listen_address¶

Address to listen on for web interface and telemetry

Default

:9308

telemetry_path¶

Path under which to expose metrics

Default

/metrics

zookeeper¶

servers¶

List of zookeeper server addresses (hosts)

Example

- localhost:2181

Templates¶

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/kafka_exporter/ directory (learn more).

• bin/kafka_exporter_ctl (from bin/kafka_exporter_ctl)

Packages¶

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.

• kafka_exporter