Add AddHealthChecks(Action<HealthCheckServiceOptions>) overload#66774
Open
KitKeen wants to merge 3 commits into
Open
Add AddHealthChecks(Action<HealthCheckServiceOptions>) overload#66774KitKeen wants to merge 3 commits into
KitKeen wants to merge 3 commits into
Conversation
Contributor
|
Thanks for your PR, @KitKeen. Someone from the team will get assigned to your PR shortly and we'll get it reviewed. |
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
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.
Fixes #8530.
Summary
services.AddHealthChecks()returns anIHealthChecksBuilder, but does not currently expose a convenient way to configureHealthCheckServiceOptions(whichDefaultHealthCheckServiceconsumes viaIOptions<HealthCheckServiceOptions>). Users today have to callservices.Configure<HealthCheckServiceOptions>(...)separately and thenservices.AddHealthChecks()— two statements instead of one, and the relationship between them is not discoverable from the API surface.This PR adds a new overload that takes a configuration delegate:
Usage:
The overload internally calls
services.Configure(configureOptions)and then delegates to the existing parameterlessAddHealthChecks(), so the idempotency guarantee and the existing service registrations are preserved. The returnedIHealthChecksBuilderremains usable for chained registrations.Changes
HealthCheckServiceCollectionExtensions.cs— new overload with full XML docs.PublicAPI.Unshipped.txt— baselined the new API.ServiceCollectionExtensionsTest.cs— added four tests:servicesthrowsArgumentNullException,configureOptionsthrowsArgumentNullException.