-
Notifications
You must be signed in to change notification settings - Fork 614
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding docs for
ReactorKafkaBinderHealthIndicator
See #2948
- Loading branch information
1 parent
a89331c
commit 7e20c9e
Showing
2 changed files
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 changes: 19 additions & 0 deletions
19
docs/modules/ROOT/pages/kafka/kafka-reactive-binder/health_indicator.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
[[reactor-kafka-binder-health-indicator]] | ||
= Reactor Kafka Binder Health Indicator | ||
|
||
Reactor Kafka binder provides a `HealthIndicator` implementation that will be used when invoking the Spring Boot Actuator `health` endpoint. | ||
When Spring Boot actuator dependency is on the classpath, the Reactor Kafka binder can be enabled with a binder health indicator. | ||
This health indicator provides information about the status of the binder based application, i.e. if it is currently `UP` or `DOWN`, the topics in usage by the application, and the various details about the message producer components that the binder uses internally. | ||
|
||
|
||
The Reactor Kafka Binder Health Indicator is registered with the key `reactorKafka` internally by the framework. | ||
Therefore, it can be queried programmatically as shown below. | ||
|
||
[source, java] | ||
---- | ||
CompositeHealthContributor compositeHealthContributor = context | ||
.getBean("bindersHealthContributor", CompositeHealthContributor.class); | ||
ReactorKafkaBinderHealthIndicator healthIndicator = (ReactorKafkaBinderHealthIndicator) compositeHealthContributor.getContributor("reactorKafka"); | ||
Health health = healthIndicator.health(); | ||
---- | ||
|