Package io.micronaut.configuration.kafka.streams.health

Class KafkaStreamsHealth

java.lang.Object
io.micronaut.configuration.kafka.streams.health.KafkaStreamsHealth
All Implemented Interfaces:
io.micronaut.core.order.Ordered, io.micronaut.management.health.indicator.HealthIndicator
@Singleton @Requires(classes=io.micronaut.management.health.indicator.HealthIndicator.class) @Requires(property="kafka.health.streams.enabled",value="true",defaultValue="true") public class KafkaStreamsHealth extends Object implements io.micronaut.management.health.indicator.HealthIndicator
A HealthIndicator for Kafka Streams.
Since:
2.0.1
Author:
Christian Oestreich

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ENABLED_PROPERTY
     

    Fields inherited from interface io.micronaut.core.order.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Constructor Summary

    Constructors
    Constructor
    Description
    KafkaStreamsHealth(KafkaStreamsFactory kafkaStreamsFactory, io.micronaut.management.health.aggregator.HealthAggregator<?> healthAggregator)
    Constructor for the health check.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.reactivestreams.Publisher<io.micronaut.management.health.indicator.HealthResult>
    getResult()
    Get the health result of the streams.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface io.micronaut.core.order.Ordered

    getOrder

  • Field Details

  • Constructor Details

    • KafkaStreamsHealth

      public KafkaStreamsHealth(KafkaStreamsFactory kafkaStreamsFactory, io.micronaut.management.health.aggregator.HealthAggregator<?> healthAggregator)
      Constructor for the health check.
      Parameters:
      kafkaStreamsFactory - The stream factory to get streams from
      healthAggregator - Health aggregator

  • Method Details

    • getResult

      public org.reactivestreams.Publisher<io.micronaut.management.health.indicator.HealthResult> getResult()
      Get the health result of the streams. Will attempt to interrogate details of each stream as well. The application.id will be used for each configured stream as the primary health check name.
      Specified by:
      getResult in interface io.micronaut.management.health.indicator.HealthIndicator
      Returns:
      Health Result Aggregate