GH-1644: Document RefreshScopeHealthIndicator and how to disable it#1697
Open
won-seoop wants to merge 1 commit into
Open
GH-1644: Document RefreshScopeHealthIndicator and how to disable it#1697won-seoop wants to merge 1 commit into
won-seoop wants to merge 1 commit into
Conversation
…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 <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.
The
@RefreshScopesection lacked any mention of the auto-configuredRefreshScopeHealthIndicator. Users discovering therefreshhealth indicator in their/actuator/healthoutput had no documentation explaining its purpose or how to opt out.This PR adds a Health Indicator subsection under Refresh Scope that:
RefreshScopeHealthIndicatordoes (transitions toDOWNwhen a bean fails to re-initialize or rebind after a context refresh).management.health.refresh.enabled=false, consistent with the pattern already established in the Discovery Client docs.Test plan
management.health.refresh.enabled=falsedisables the indicator (verified againstRefreshEndpointAutoConfigurationwhich uses@ConditionalOnEnabledHealthIndicator("refresh"))🤖 Generated with Claude Code