GH-1644: Document RefreshScopeHealthIndicator#1695
Open
won-seoop wants to merge 1 commit into
Open
Conversation
Add a section under 'Refresh Scope' describing the RefreshScopeHealthIndicator that is auto-configured when Spring Boot Actuator is on the classpath. The indicator reports DOWN with error details when a @RefreshScope or @ConfigurationProperties bean fails to rebind after a config refresh, and how to disable it using management.health.refresh.enabled=false. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #1644
Adds a
[[refresh-scope-health-indicator]]subsection to the Refresh Scope section ofapplication-context-services.adocthat:RefreshScopeHealthIndicatoris auto-configured when Spring Boot Actuator is on the classpathUPwhen no refresh errors exist,DOWNwith error details when a@RefreshScopeor@ConfigurationPropertiesbean fails to rebind after a config refreshmanagement.health.refresh.enabled=falseThis follows the same style as the
DiscoveryClientHealthIndicatordocumentation incommon-abstractions.adoc.The health indicator is wired via
@ConditionalOnEnabledHealthIndicator("refresh")inRefreshEndpointAutoConfiguration, which maps to themanagement.health.refresh.enabledproperty.Test plan
management.health.refresh.enabled=falsesnippet renders as YAML🤖 Generated with Claude Code