Extend Kafka health check documentation #15368
Conversation
- Explain how to enable/disable the various health check - Explain what is checked by which ones - Explain which broker each check uses
| If enabled, when you access the `/q/health/ready` endpoint of your application you will have information about the connection validation status. | ||
| When using the `quarkus-kafka` extension, you can enable _readiness_ health check by setting the `quarkus.kafka.health.enabled` property to `true` in your `application.properties`. | ||
| This check reports the status of the interaction with a _default_ Kafka broker (configured using `kafka.bootstrap.servers`). | ||
| That check requires an _admin connection_ with the Kafka broker. |
There was a problem hiding this comment.
I'm surprised you need elevated privileges for a simple thing like health checks? Or did I misunderstand what an admin connection is?
There was a problem hiding this comment.
In general, user credentials are enough to create a Kafka Admin client, and so execute the check. That being said I agree with you, it's like requiring a privileged account on a database to check if the database is present (if DROP TABLE USERS succeeds that means we are connected to the database).
That's why in reactive messaging, we moved away from that model and we have been discussing multiple alternatives. The new one (in Reactive Messaging 2.8) looks good so far and does not require an admin connection anymore. But, I would like to see if we get more reports (we had one but it was actually correct, the application was not consistent). If we don't get more reports we will apply the same strategy in the kafka-client extension.
Also, the motivation for this is that not all Kafka deployments will allow admin connections using user credentials.
Fix #15347