SpringCloud/spring-cloud-stream
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

polishing doc

Browse Source 
Resolves #1504
This commit is contained in:
Oleg Zhurakousky
2018-10-22 12:51:19 +02:00
parent 8e7b6bc7f6
commit 5c9fb07677
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
spring-cloud-stream-core-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc
View File

@@ -2468,9 +2468,9 @@ When autoconfiguration is disabled, the test binder is available on the classpat
Spring Cloud Stream provides a health indicator for binders.
It is registered under the name `binders` and can be enabled or disabled by setting the `management.health.binders.enabled` property.
You need to provide the required actuator dependencies in your application to enable health check - `spring-boot-starter-actuator` and `spring-boot-starter-web`.
To enable health check you first need to enable both "web" and "actuator" by including its dependencies (see <<spring-cloud-stream-preface-actuator-web-dependencies>>)
If `management.health.binders.enabled` is not set explicitly by the application, then `management.health.defaults.enabled` is matched as true and the binder health indicators are enabled.
If `management.health.binders.enabled` is not set explicitly by the application, then `management.health.defaults.enabled` is matched as `true` and the binder health indicators are enabled.
If you want to disable health indicator completely, then you have to set `management.health.binders.enabled` to `false`.
You can use Spring Boot actuator health endpoint to access the health indicator - `/actuator/health`.
@@ -2479,8 +2479,8 @@ In order to receive the full details from the binder specific health indicators,
Health indicators are binder-specific and certain binder implementations may not necessarily provide a health indicator.
If you want to completely disable all the out of the box health indicators support from Spring Cloud Stream and instead provide your own health indicators,
you can do that by setting the property `management.health.binders.enabled` to false and then provide your own `HealthIndicator` beans in your application.
If you want to completely disable all health indicators available out of the box and instead provide your own health indicators,
you can do so by setting property `management.health.binders.enabled` to `false` and then provide your own `HealthIndicator` beans in your application.
In this case, the health indicator infrastructure from Spring Boot will still pick up these custom beans.
Even if you are not disabling the binder health indicators, you can still enhance the health checks by providing your own `HealthIndicator` beans in addition to the out of the box health checks.