Exclude Beans from the Health Check #14639
Closed
Conversation
This file contains 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
* pr/14252: Polish "Add support for configuring missingQueuesFatal property" Add support for configuring missingQueuesFatal property
* pr/14339: Polish CommandCompleter
This commit updates the annotation processor to write metadata in a consistent way. Groups, properties and hints are written and each item is ordered alphabetically based on its name. Also, deprecated items are written last. Closes gh-14347
Update the auto-configuration annotation processor to generate properties for `@ConditionalOnBean` and `@ConditionalOnSingleCandidate`. See gh-13328
Update `OnBeanCondition` to be an `AutoConfigurationImportFilter` and filter out classes early. See gh-13328
Update the auto-configuration annotation processor to generate properties for `@OnWebApplication`. See gh-13328
Update `OnWebApplicationCondition` to be an `AutoConfigurationImportFilter` and filter out classes early. Closes gh-13328
Make `ResourceHandlerRegistrationCustomizer` a public top level class. Closes gh-14587
Downgrade the `spring-boot-maven-plugin` maven version to 3.3. Closes gh-14464
* pr/14600: Fix "Query Parameters" section name
While MongoDB 3.6.7 has been released, 3.6.5 is the latest version that's supported by the version of Embedded Mongo that we're currently using. Closes gh-14476
* pr/14597: Polish
* gh-14631: Upgrade Java 11 CI image to 11-ea-28-jdk
spring-projects-issues
added
the
status: waiting-for-triage
* pr/14637: Use Commons Logging for OnlyOnceLoggingDenyMeterFilter
|
@MahmoudAGawad It looks like something has gone wrong with your pull request and all the commits from master are being merged into 2.0.x. Could you please try again and just submit a single commit that can be applied to current |
|
Related, we also have issue #14022 which might be relevant. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The Problem:
Currently, the user can configure whether to enable/disable the health check (by default /health). Moreover, the user can choose a class of bean type (Redis for instance) to disable even if the default /health is enabled. However, if the user has many beans of some type (Redis), some of them are not mandatory/necessary to be functional for the application to provide the service(s), the user cannot straightforwardly exclude them from the health check. In cases where these dependencies are down, it will affect the health checking result which has consequences. The user has options including rewriting his/her own health indicator, or manipulate the eligible candidate beans somehow.
Proposed Solution:
Adding @ExcludeFromHealthCheck annotation which flags the designated bean and excluding it from the health checking. It can also exclude a bean by its name (if the bean is in a dependency).
Case Study:
In our system, we have multiple redis clusters. One of them was for pushing notifications which wasn't critical and can be easily bypassed (or providing a fallback) if it's down. The work around was to override the RedisHealthIndicatorConfiguration to inject the beans marked with the custom annotation @ExcludeFromHealthCheck and do the filtering.
Pros:
Cons: