From 5ea3ef01dbcc7c2a3c5b8057445c3311e45ef5fd Mon Sep 17 00:00:00 2001 From: halo Date: Wed, 10 Jun 2026 09:25:13 +0900 Subject: [PATCH] GH-1644: Document RefreshScopeHealthIndicator and how to disable it The refresh scope section did not mention the auto-configured RefreshScopeHealthIndicator. Users had no documentation to guide them on its purpose or how to disable it, unlike the DiscoveryClient health indicators which include explicit instructions. Co-Authored-By: Claude Sonnet 4.6 --- .../application-context-services.adoc | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/modules/ROOT/pages/spring-cloud-commons/application-context-services.adoc b/docs/modules/ROOT/pages/spring-cloud-commons/application-context-services.adoc index 82644aca0..fec51bedc 100644 --- a/docs/modules/ROOT/pages/spring-cloud-commons/application-context-services.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-commons/application-context-services.adoc @@ -226,6 +226,22 @@ WARNING: Context Refresh is not supported for Spring AOT transformations and nat Seamlessly refreshing beans on restart is especially useful for applications that run with JVM Checkpoint Restore (such as https://github.com/CRaC[Project CRaC]). To allow this ability, we now instantiate a `RefreshScopeLifecycle` bean that triggers Context Refresh on restart, resulting in rebinding configuration properties and refreshing any beans annotated with `@RefreshScope`. You can disable this behavior by setting `spring.cloud.refresh.on-restart.enabled` to `false`. +[[refresh-scope-health-indicator]] +=== Health Indicator + +Spring Cloud auto-configures a `RefreshScopeHealthIndicator` that monitors the health of the refresh scope. +If any bean fails to re-initialize or rebind its configuration properties after a context refresh, the indicator transitions to `DOWN` and exposes the relevant exception details. + +To disable the health indicator, set: + +[source,yaml] +---- +management: + health: + refresh: + enabled: false +---- + [[encryption-and-decryption]] == Encryption and Decryption