Kafka Metrics (JMX) and Health Checks
Understand key Kafka broker and client metrics exposed via JMX and how to perform health checks for your Spring Boot applications.
Kafka Metrics (JMX) and Health Checks is a free Advanced Spring Boot 4: Event-Driven Architecture (Kafka) lesson on CoddyKit — lesson 1 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Advanced Spring Boot 4: Event-Driven Architecture (Kafka) learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.
Why Monitor Kafka & Apps?
In event-driven systems with Kafka, understanding the health and performance of your brokers and applications is crucial. Monitoring helps you detect issues early, optimize resource usage, and ensure reliable message processing.
Without proper monitoring, you'd be flying blind, unaware of potential bottlenecks, outages, or data loss risks. It's like driving a car without a dashboard!
Introducing JMX for Java Apps
JMX stands for Java Management Extensions. It's a standard technology for monitoring and managing Java applications. Kafka, being a Java application, exposes a wealth of operational data through JMX.
JMX uses objects called MBeans (Managed Beans) to expose attributes (data) and operations (actions) of an application. These MBeans provide insights into everything from memory usage to Kafka-specific metrics.
Key Kafka Broker JMX Metrics
Kafka brokers expose numerous JMX metrics that are vital for monitoring. Here are a few examples:
- MessagesInPerSec: The rate of messages produced to topics on the broker.
- BytesInPerSec/BytesOutPerSec: Network throughput for incoming/outgoing data.
- RequestPerSec: Rate of produce, fetch, or other requests handled by the broker.
- ActiveControllerCount: Indicates which broker is the cluster controller (should be 1).
Monitoring these helps you understand load, network usage, and cluster stability.
Accessing JMX Metrics
You can access JMX metrics in several ways:
- JConsole/JVisualVM: GUI tools bundled with the JDK that connect to running Java processes.
- Prometheus JMX Exporter: A popular agent that scrapes JMX metrics and exposes them in a Prometheus-compatible format.
- Programmatic Access: Using Java code to connect to the MBeanServer and query MBeans directly.
For large-scale monitoring, integrating with tools like Prometheus and Grafana is common, which we'll cover later!
Spring Boot Actuator Health
For Spring Boot applications, Actuator provides production-ready features, including powerful health check endpoints. The primary endpoint is /actuator/health.
This endpoint aggregates the health status of various components within your application, including database connections, disk space, and crucially, external dependencies like Kafka.
Enabling Actuator Endpoints
To expose Actuator endpoints, you need to add the spring-boot-starter-actuator dependency and configure your application.properties:
management.endpoints.web.exposure.include=*: Exposes all Actuator endpoints over HTTP.management.endpoint.health.show-details=always: Shows full health details, not just UP/DOWN status.
This allows you to query http://localhost:8080/actuator/health (or your app's port) to see the aggregated health.
Building Custom Health Checks
While Actuator provides out-of-the-box health checks, you often need custom ones for specific application logic or unique external dependencies. For a Kafka-integrated app, a custom health check can verify active Kafka connectivity.
You can create a custom health check by implementing Spring Boot's HealthIndicator interface. This gives you precise control over what 'healthy' means for your application's Kafka integration.
Custom Kafka Health Check
This Spring Boot example demonstrates a custom HealthIndicator that checks if a KafkaTemplate bean is available, implying successful Kafka configuration and potential connectivity.
Dependencies: Add spring-boot-starter-web, spring-boot-starter-actuator, and spring-kafka to your project's dependencies.
application.properties:
spring.kafka.bootstrap-servers=localhost:9092management.endpoints.web.exposure.include=*management.endpoint.health.show-details=always
Run this application and visit http://localhost:8080/actuator/health to see its status, including the Kafka check.
package com.coddykit.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.context.annotation.Bean;
import org.springframework.kafka.core.KafkaTemplate;
import org.springframework.beans.factory.annotation.Autowired;
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
/**
* Custom HealthIndicator to check Kafka connectivity.
* It checks if a KafkaTemplate bean could be successfully created.
* In a real application, consider using KafkaAdminClient
* for more robust connectivity checks (e.g., listing topics).
*/
@Bean
public HealthIndicator kafkaConnectivityHealthIndicator(
@Autowired(required = false) KafkaTemplate<String, String> kafkaTemplate) {
return () -> {
if (kafkaTemplate != null) {
// If KafkaTemplate is available, assume Kafka is reachable.
return Health.up()
.withDetail("service", "Kafka Broker")
.withDetail("status", "KafkaTemplate available")
.build();
} else {
// If KafkaTemplate is null, Kafka might not be configured or reachable.
return Health.down()
.withDetail("service", "Kafka Broker")
.withDetail("error", "KafkaTemplate bean not found/failed to create")
.build();
}
};
}
}Understanding Health Endpoint
When you access /actuator/health, you'll see a JSON response. The top-level status field indicates the overall health (e.g., UP or DOWN).
Beneath that, the components field provides detailed status for each configured health indicator, including built-in ones (like disk space) and your custom Kafka check. You'll see the UP or DOWN status for each component along with any custom details you added.
Check Your Knowledge
Let's test your understanding of monitoring Kafka and Spring Boot applications.
Lesson Summary & Beyond
Great job! You've learned about the importance of monitoring, how JMX provides deep insights into Kafka brokers, and how Spring Boot Actuator enables robust health checks for your applications.
Specifically, you now understand how to expose Actuator endpoints and implement custom HealthIndicators to verify connectivity to critical services like Kafka.
Next, we'll explore integrating these metrics with powerful visualization tools like Prometheus and Grafana for comprehensive dashboards!
Frequently asked questions
Is the “Kafka Metrics (JMX) and Health Checks” lesson free?
Yes — the full text of “Kafka Metrics (JMX) and Health Checks” is free to read here on the web, and the Advanced Spring Boot 4: Event-Driven Architecture (Kafka) course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Advanced Spring Boot 4: Event-Driven Architecture (Kafka) course, upgrade to CoddyKit PRO.
What will I learn in “Kafka Metrics (JMX) and Health Checks”?
Understand key Kafka broker and client metrics exposed via JMX and how to perform health checks for your Spring Boot applications. You practise Advanced Spring Boot 4: Event-Driven Architecture (Kafka) with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start Advanced Spring Boot 4: Event-Driven Architecture (Kafka)?
No prior experience is required. Advanced Spring Boot 4: Event-Driven Architecture (Kafka) on CoddyKit is structured for beginners through advanced learners; this is — lesson 1 of 4, so you can start here or from the beginning and move at your own pace.
How long does the “Kafka Metrics (JMX) and Health Checks” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this Advanced Spring Boot 4: Event-Driven Architecture (Kafka) lesson?
Yes. Every Advanced Spring Boot 4: Event-Driven Architecture (Kafka) lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.
All lessons in this course
- Kafka Metrics (JMX) and Health Checks
- Integrating with Prometheus & Grafana
- Distributed Tracing with Sleuth/Zipkin
- Monitoring Consumer Lag and Setting Alerts