Client metrics monitoring in Kafka - Commands & Configuration

Introduction

Monitoring client metrics helps you understand how your Kafka clients perform and behave. It solves the problem of not knowing if your producers or consumers are working efficiently or facing issues.

When you want to track how many messages your producer sends per second to Kafka.

When you need to check if your consumer is lagging behind the latest messages.

When you want to monitor network errors or retries happening in your Kafka clients.

When you want to see the average time your client takes to send or receive messages.

When you want to collect metrics to alert you if your Kafka client stops working properly.

Config File - client.properties

client.properties

bootstrap.servers=localhost:9092
client.id=my-kafka-client
metric.reporters=org.apache.kafka.common.metrics.JmxReporter
metrics.sample.window.ms=30000
metrics.num.samples=2

bootstrap.servers: Kafka broker addresses your client connects to.

client.id: A name to identify your client in metrics.

metric.reporters: Enables JMX reporting for metrics collection.

metrics.sample.window.ms: Time window for metrics sampling.

metrics.num.samples: Number of samples to keep for averaging metrics.

Commands

Starts a Kafka producer using the client.properties file to send messages to 'test-topic'. This enables metrics collection as configured.

Terminal

kafka-console-producer --broker-list localhost:9092 --topic test-topic --producer.config client.properties

Expected Output

No output (command runs silently)

→

--broker-list - Specifies Kafka broker addresses to connect.

→

--topic - Specifies the topic to send messages to.

→

--producer.config - Loads client configuration including metrics settings.

Opens Java JMX console to connect to the Kafka client process and view metrics exposed via JMX.

Terminal

jconsole

Expected Output

No output (command runs silently)

Shows consumer group details including lag, which is a key metric to monitor consumer health.

Terminal

kafka-consumer-groups --bootstrap-server localhost:9092 --describe --group my-consumer-group

Expected Output

GROUP           TOPIC           PARTITION  CURRENT-OFFSET  LOG-END-OFFSET  LAG  CONSUMER-ID                                    HOST            CLIENT-ID

my-consumer-group  test-topic     0          15              20              5    consumer-1-12345-67890-abcde                  /127.0.0.1      consumer-1

→

--bootstrap-server - Specifies Kafka broker addresses to connect.

→

--describe - Shows detailed information about the consumer group.

→

--group - Specifies the consumer group to describe.

Key Concept

If you remember nothing else from client metrics monitoring, remember: enabling JMX reporting in your client config lets you collect and view detailed performance metrics easily.

Common Mistakes

Not enabling metric.reporters in the client configuration.

Without metric.reporters, no metrics are exposed for monitoring.

Add 'metric.reporters=org.apache.kafka.common.metrics.JmxReporter' to your client.properties file.

Trying to view metrics without connecting to the correct Java process in JConsole.

JConsole won't show metrics if not connected to the Kafka client JVM process.

Start your Kafka client with JMX enabled and connect JConsole to that process.

Checking consumer lag without specifying the correct consumer group.

You will not see relevant lag metrics if the wrong group is queried.

Use the exact consumer group name with '--group' flag in kafka-consumer-groups command.

Summary

Configure your Kafka client with JMX metric reporting enabled in client.properties.

Run your Kafka producer or consumer with this configuration to start collecting metrics.

Use JConsole to connect to the client JVM and view detailed metrics.

Check consumer lag using kafka-consumer-groups command to monitor consumer health.

Practice

1. What is the main purpose of client metrics monitoring in Kafka?

easy

A. To configure Kafka brokers for better storage

B. To track real-time performance data like message counts and errors

C. To manage user access permissions

D. To backup Kafka data automatically

Solution

1. Step 1: Understand client metrics monitoring

   Client metrics monitoring collects data about Kafka client performance such as message counts, latency, and errors.

2. Step 2: Identify the main purpose

   The main goal is to observe client behavior in real time to improve reliability and troubleshoot issues quickly.

3. Final Answer:

   To track real-time performance data like message counts and errors -> Option B

4. Quick Check:

   Client metrics = performance data tracking [OK]

Hint: Client metrics = real-time client performance data [OK]

Common Mistakes:

• Confusing client metrics with broker configuration
• Thinking metrics manage user permissions
• Assuming metrics handle data backup

2. Which of the following is the correct way to enable client metrics reporting in a Kafka producer configuration?

easy

A. "client.metrics.enabled=yes"

B. "enable.metrics=true"

C. "metrics.recording.level=DEBUG"

D. "metrics.sample.window.ms=30000"

Solution

1. Step 1: Review Kafka producer metric configs

   Kafka uses properties like "metrics.sample.window.ms" to control metrics sampling intervals.

2. Step 2: Identify valid configuration syntax

   "metrics.sample.window.ms=30000" is a valid setting to enable metrics sampling every 30 seconds.

3. Final Answer:

   "metrics.sample.window.ms=30000" -> Option D

4. Quick Check:

   Correct metric config syntax = "metrics.sample.window.ms=30000" [OK]

Hint: Look for valid Kafka metric property names [OK]

Common Mistakes:

• Using non-existent properties like enable.metrics
• Wrong boolean values like 'yes' instead of true/false
• Confusing logging level with metrics config

3. Given the following Kafka consumer metrics output snippet:
{"records-consumed-total": 1500, "fetch-latency-avg": 25, "fetch-errors-total": 0}
What does this tell you about the consumer's performance?

medium

A. The consumer has consumed 1500 records with an average fetch latency of 25 ms and no fetch errors

B. The consumer has 1500 fetch errors and average latency of 0 ms

C. The consumer has not consumed any records yet

D. The consumer is experiencing high fetch errors

Solution

1. Step 1: Interpret each metric value

   "records-consumed-total": 1500 means 1500 messages consumed; "fetch-latency-avg": 25 means average fetch latency is 25 milliseconds; "fetch-errors-total": 0 means no fetch errors.

2. Step 2: Summarize consumer performance

   The consumer is working well, consuming messages with reasonable latency and no errors.

3. Final Answer:

   The consumer has consumed 1500 records with an average fetch latency of 25 ms and no fetch errors -> Option A

4. Quick Check:

   Metrics values = The consumer has consumed 1500 records with an average fetch latency of 25 ms and no fetch errors [OK]

Hint: Check counts and latency values carefully [OK]

Common Mistakes:

• Misreading zero errors as errors present
• Confusing latency with error count
• Assuming no records consumed when count is positive

4. You configured Kafka client metrics but see no metrics reported. Which of the following is the most likely cause?

medium

A. Metrics reporting interval is set too high, delaying output

B. Kafka broker is down

C. Client metrics are disabled by default and need explicit enabling

D. Network firewall blocking Kafka ports

Solution

1. Step 1: Understand default client metrics behavior

   Kafka clients do not always enable metrics reporting by default; explicit configuration is often required.

2. Step 2: Evaluate other options

   Broker down or firewall issues affect connectivity but not metrics reporting directly; reporting interval delays metrics but does not stop them completely.

3. Final Answer:

   Client metrics are disabled by default and need explicit enabling -> Option C

4. Quick Check:

   Metrics disabled by default = Client metrics are disabled by default and need explicit enabling [OK]

Hint: Check if metrics are explicitly enabled in config [OK]

Common Mistakes:

• Assuming broker status affects client metrics directly
• Ignoring need to enable metrics explicitly
• Blaming network issues without checking configs

5. You want to monitor Kafka producer client metrics to detect high message send latency and errors in real time. Which approach is best to achieve this?

hard

A. Configure the producer to expose JMX metrics and use a monitoring tool to collect and alert on latency and error metrics

B. Increase the producer batch size to reduce latency

C. Enable debug logging on the Kafka broker

D. Use Kafka Connect to export metrics to a database

Solution

1. Step 1: Identify how to access client metrics

   Kafka producer clients expose metrics via JMX (Java Management Extensions), which can be collected by monitoring tools.

2. Step 2: Choose the best monitoring approach

   Using JMX with a monitoring tool allows real-time collection and alerting on latency and errors, which fits the requirement.

3. Step 3: Evaluate other options

   Increasing batch size affects performance but not monitoring; debug logging on broker does not monitor client metrics; Kafka Connect exports data but is not the direct way to monitor client metrics.

4. Final Answer:

   Configure the producer to expose JMX metrics and use a monitoring tool to collect and alert on latency and error metrics -> Option A

5. Quick Check:

   JMX metrics + monitoring tool = Configure the producer to expose JMX metrics and use a monitoring tool to collect and alert on latency and error metrics [OK]

Hint: Use JMX metrics with monitoring tools for real-time alerts [OK]

Common Mistakes:

• Confusing performance tuning with monitoring setup
• Relying on broker logs for client metrics
• Using Kafka Connect for direct client metric monitoring