Kafka clients JMX collector [WIP]

Kafka clients JMX collector is Custom collector, for prometheus/client_java.

Kafka clients JMX collector does proxy JMX metrics from kafka clients.

Versioning

todo: 0.6.0-2.1.1 -> {prometheus.kafka-clients}

Usage

Import dependency.

<dependency>
    <groupId>no.sysco.middleware.prometheus</groupId>
    <artifactId>kafka-client-collector</artifactId>
    <version>${version}</version>
</dependency>

Use KafkaClientsJmxExports to initialize collectors for kafka-clients JMX metrics to conveniently register them.

KafkaClientsJmxExports.initialize();

Idea

Provide availability to expose:

• kafka clients jmx related metrics (KafkaClientsJmxExports.initialize();)
• custom metrics (developer's responsibility)
• resource utilization metrics (DefaultExports.initialize();)

Metrics types

Metrics with Attributes. Reference Name of metrics group (prometheus context) or metric type (jmx context)

Producer:

• app-info @deprecated = common clients metrics
• producer-metrics = common clients metrics + only producer related metrics
• producer-topic-metrics = only producer related metrics
• producer-node-metrics = common clients metrics

Consumer:

• app-info @deprecated = common clients metrics
• consumer-metrics = common clients metrics
• consumer-coordinator-metrics - consumer group metrics
• consumer-fetch-manager-metrics = fetch-manager metrics + per topic + per partition
• consumer-node-metrics = common clients metrics

References

• Issue 305: Add kafka client example config
• Issue 400: does the client automatically publish jmx mertices (heap size memory, thread number)?
• Blog post: JMX monitoring + Java custom metrics.
• Kafka metrics reporter
• IMO - Good example how to make custom collector