From f4e7b2fce75c834e4cc37285cfee45bb8aff9faf Mon Sep 17 00:00:00 2001 From: Soby Chacko Date: Tue, 3 Apr 2018 16:56:47 -0400 Subject: [PATCH] Revise health indicator docs Resolves #1256 Addressing PR review comments --- .../src/main/asciidoc/spring-cloud-stream-overview.adoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/spring-cloud-stream-core-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc b/spring-cloud-stream-core-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc index b1351235f..95a87745d 100644 --- a/spring-cloud-stream-core-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc +++ b/spring-cloud-stream-core-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc @@ -2321,6 +2321,10 @@ 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 of `binders` and can be enabled or disabled by setting the `management.health.binders.enabled` property. +If `management.health.binders.enabled` is `false`, then no health indicator is shown on `/health`. +Setting `management.health.binders.enabled` to `true` enables the health indicator. +When you use the `/health` endpoint, you can retrieve the binder health indicators. +Health indicators are binder-specific and certain binder implementations may not necessarily provide a health indicator. [[spring-cloud-stream-overview-metrics-emitter]] == Metrics Emitter