Package org.sdase.commons.spring.boot.kafka

Class KafkaHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.sdase.commons.spring.boot.kafka.KafkaHealthIndicator

All Implemented Interfaces:

org.springframework.boot.actuate.endpoint.OperationResponseBody, org.springframework.boot.actuate.health.HealthContributor, org.springframework.boot.actuate.health.HealthIndicator

@Component("kafka")
@ConditionalOnEnabledHealthIndicator("kafka")
public class KafkaHealthIndicator
extends org.springframework.boot.actuate.health.AbstractHealthIndicator
implements org.springframework.boot.actuate.endpoint.OperationResponseBody

HealthIndicator testing if a client is able to connect to Kafka and if there are any ListenerContainers running.

Constructor Summary

Constructors

Constructor	Description
KafkaHealthIndicator(Duration kafkaCommandTimeout, org.springframework.kafka.core.KafkaAdmin kafkaAdmin, org.springframework.kafka.config.KafkaListenerEndpointRegistry kafkaListenerEndpointRegistry)

Method Summary

Modifier and Type	Method	Description
protected void	doHealthCheck(org.springframework.boot.actuate.health.Health.Builder builder)

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

Methods inherited from interface org.springframework.boot.actuate.health.HealthIndicator

getHealth

Constructor Details

KafkaHealthIndicator

public KafkaHealthIndicator(@Value("${management.health.kafka.timeout:4s}")
 Duration kafkaCommandTimeout,
 org.springframework.kafka.core.KafkaAdmin kafkaAdmin,
 org.springframework.kafka.config.KafkaListenerEndpointRegistry kafkaListenerEndpointRegistry)

Method Details

doHealthCheck

protected void doHealthCheck(org.springframework.boot.actuate.health.Health.Builder builder)
                      throws Exception

Specified by:

doHealthCheck in class org.springframework.boot.actuate.health.AbstractHealthIndicator

Throws:

Exception