Skip to content

GH-1644: Document RefreshScopeHealthIndicator and how to disable it #1697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
won-seoop wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −0
Open

GH-1644: Document RefreshScopeHealthIndicator and how to disable it #1697

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/modules/ROOT/pages/spring-cloud-commons/application-context-services.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down