This is a simple project built on top of Spring Boot's Actuator and Spring Boot for Apache Kafka project that aims to provide a simple way of getting health-check functionality for your Kafka Spring Boot application.
It was inspired by existent functionalities present in the Spring Cloud Stream project.
Maven Central
<dependency>
<groupId>io.github.leofuso</groupId>
<artifactId>actuator-kafka</artifactId>
<version>v3.0.2.0.RELEASE</version>
</dependency>
JitPack
<dependency>
<groupId>com.github.leofuso</groupId>
<artifactId>actuator-kafka</artifactId>
<version>v3.0.2.0.RELEASE</version>
</dependency>
The version indicates the compatibility with the Spring Boot. In other worlds, I'll try to keep it up to date with other
Spring Boot versions, e.g, the v3.0.x.y.RELEASE
should be compatible with the Spring Boot 3.0.x
version and so on.
This package assumes a KafkaAdmin
bean available on the classpath. Simply import it, and you can assign it to a health
group as kafka
, just like any other health-check dependency.
management.endpoint.health.group.readiness.include=ping, kafka
name | type | description |
---|---|---|
response-timeout | Duration | Time to wait for a response from the cluster description operation. |
consider-replication-factor | boolean | Use the replication factor of the broker to validate if it has enough nodes. |