Micronaut Kafka Configuration Reference

Every documented configuration property of Micronaut Kafka, with types, descriptions, and defaults.

13 properties across 2 sections

Micronaut Kafka Config Properties

Configuration properties for KafkaDefaultConfiguration

Property	Type	Description
`kafka.health-timeout`	java.time.Duration	The health check timeout. Default value (10 seconds).

Configuration properties for KafkaConsumerConfiguration

Property	Type	Description
`kafka.consumers.*.key-deserializer`	org.apache.kafka.common.serialization.Deserializer	Sets the key deserializer.
`kafka.consumers.*.value-deserializer`	org.apache.kafka.common.serialization.Deserializer	Sets the default value deserializer.

Property	Type	Description
`kafka.default-listener-exception-handler.skip-record-on-deserialization-failure`	boolean	Whether to skip record on deserialization failure. Default value true
`kafka.default-listener-exception-handler.commit-record-on-deserialization-failure`	boolean	Whether to commit record on deserialization failure. Default value false

Property	Type	Description
`kafka.health.enabled`	boolean	Whether the Kafka health check is enabled. Default value true.
`kafka.health.restricted`	boolean	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.. Default value false

Configuration properties for KafkaProducerConfiguration

Property	Type	Description
`kafka.producers.*.key-serializer`	org.apache.kafka.common.serialization.Serializer	Sets the key serializer.
`kafka.producers.*.value-serializer`	org.apache.kafka.common.serialization.Serializer	Sets the default value serializer.
`kafka.producers.*.executor`	java.lang.String	Sets the default executor to use to enable non-blocking producers.

Property	Type	Description
`micronaut.metrics.binders.kafka.metric-name-style`	MetricNameStyle	The metric naming style. Defaults to {@link MetricNameStyle#MICROMETER}.

Configuration properties for KafkaStreamsConfiguration

Property	Type	Description
`kafka.streams.*.close-timeout`	java.time.Duration	the time to wait for the stream to shut down.
`kafka.streams.*.name`	java.lang.String	the logical name of the stream