Package io.micronaut.configuration.kafka.config

Interface KafkaHealthConfiguration

All Superinterfaces:
io.micronaut.core.util.Toggleable
All Known Implementing Classes:
KafkaHealthConfigurationProperties
public interface KafkaHealthConfiguration extends io.micronaut.core.util.Toggleable
Kafka Health indicator Configuration.
Since:
5.1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isRestricted()
    By default, the health check requires cluster-wide permissions in order to get information about the nodes in the Kafka cluster.

    Methods inherited from interface io.micronaut.core.util.Toggleable

    isEnabled

  • Method Details

    • isRestricted

      boolean isRestricted()
      By default, the health check requires cluster-wide permissions in order to get information about the nodes in the Kafka cluster. If your application doesn't have admin privileges (for example, this might happen in multi-tenant scenarios), you can switch to a "restricted" version of the health check which only validates basic connectivity but doesn't require any additional permissions.
      Returns:
      Whether to switch to a "restricted" version of the health check.