org.springframework.boot.actuate.kafka

Class KafkaHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.springframework.boot.actuate.kafka.KafkaHealthIndicator

All Implemented Interfaces:

HealthIndicator

public class KafkaHealthIndicator
extends AbstractHealthIndicator

HealthIndicator for Kafka cluster.

Since:

2.0.0

Author:

Juan Rada

Constructor Summary

Constructors

Constructor and Description
KafkaHealthIndicator(org.springframework.kafka.core.KafkaAdmin kafkaAdmin, long requestTimeout) Create a new KafkaHealthIndicator instance.

Method Summary

Modifier and Type	Method and Description
protected void	doHealthCheck(Health.Builder builder) Actual health check logic.

Methods inherited from class org.springframework.boot.actuate.health.AbstractHealthIndicator

health

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KafkaHealthIndicator

public KafkaHealthIndicator(org.springframework.kafka.core.KafkaAdmin kafkaAdmin,
                            long requestTimeout)

Create a new KafkaHealthIndicator instance.

Parameters:

kafkaAdmin - the kafka admin

requestTimeout - the request timeout in milliseconds

Method Detail

doHealthCheck

protected void doHealthCheck(Health.Builder builder)
                      throws Exception

Description copied from class: AbstractHealthIndicator

Actual health check logic.

Specified by:

doHealthCheck in class AbstractHealthIndicator

Parameters:

builder - the Health.Builder to report health status and details

Throws:

Exception - any Exception that should create a Status.DOWN system status.