kafka-observ-lib

Kafka observability library

This lib can be used to generate dashboards, rows, panels for Kafka signals.

The library supports two metrics sources (metricsSource):

• prometheus: JMX configs from prometheus/jmx_exporter and kafka_exporter
• grafanacloud: JMX configs from kafka-mixin and kafka_exporter fork (used in grafana-agent/alloy).
• bitnami: JMX configs from bitnami helm chart

You can also pick on the three JVM metrics sources (jvmMetricsSource):

• jmx_exporter if you use jmx_exporter in http mode or javaagent mode with the additional config snippet (see README)
• prometheus_old if you use jmx_exporter in javaagent mode and version prior to 1.0.1
• prometheus if you use jmx_exporter in javaagent mode and version 1.0.1 or newer

If you pick jmx_exporter option, make sure you add the following snippet to your jmx_exporter config:

lowercaseOutputName: true
lowercaseOutputLabelNames: true
rules:
  - pattern: java.lang<type=(.+), name=(.+)><(.+)>(\w+)
    name: java_lang_$1_$4_$3_$2
  - pattern: java.lang<type=(.+), name=(.+)><>(\w+)
    name: java_lang_$1_$3_$2
  - pattern : java.lang<type=(.*)>

Import

jb init
jb install https://github.com/grafana/jsonnet-libs/kafka-observ-lib

Example

Kafka broker overview dashboard:

Kafka topic overview dashboard:

Zookeeper overview dashboard: