4.x Add a new addCheck variant allowing the caller to set the health check name; add tests; revise doc
#7994
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
…k name; add tests; revise doc Signed-off-by: Tim Quinn <tim.quinn@oracle.com>
oracle-contributor-agreement
bot
added
the
OCA Verified
tjquinno
changed the title
addCheck variant allowing the caller to set the health check name; add tests; revise doc
tjquinno
changed the title
addCheck variant allowing the caller to set the health check name; add tests; revise docaddCheck variant allowing the caller to set the health check name; add tests; revise doc
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.
Description
Resolves #7827
As Tomas suggested in the issue comments, this PR adds a variant to the
HealthObserverbuilder that accepts aSupplier<HealthCheckResult>, a health check type, and (this is the new part) a name for the added health check.(The original code provided no way to assign a name to a health check that was added by using a lambda or method reference for the health check response.)
Documentation
Doc update included in the PR.
I revised the doc slightly so the example code uses a variable of type
Supplier<HealthCheckResponse>instead ofHealthCheckso the doc could show the use of the new method. IMO this is a better pattern to illustrate than creating a check without an explicit name which yields the output I showed in the issue in which the generated name is shown as something like"name": "Main$$Lambda/0x00000001320ac800".The revised doc shows the code explicitly setting the name when invoking
addCheckand the corresponding clearer output.