Allow modifying HealthCheckRegistration using IHealthChecksBuilder

[weichch]

Is your feature request related to a problem? Please describe.

In our project, I'm providing a set of default health checks in a base library. The health checks come with a set of default values set to their HealthCheckRegistration objects that I want the consumer applications/libraries need to be able to override.

HealthCheckRegistration is mutable which fits my purpose, however there is no way out of the box for me to access the HealthCheckRegistrations from health check APIs such as IHealthChecksBuilder.

After checking the source code, I found the registrations are added to HealthCheckServiceOptions which is only accessible via services.Configure<HealthCheckServiceOptions> method. So to alter the registrations I will need to do:

// In my base library
services.AddHealthChecks()
    .AddCheck<TestHealthCheck1>("test1", tags: new[] {"tag"});
    .AddCheck<TestHealthCheck2>("test2", tags: new[] {"tag"});

// In consumer application
services.Configure<HealthCheckServiceOptions>(options =>
{
    var registrations = options.Registrations.FindTargetHealthChecksByTag("tag");
   // Configure all registrations with specified tag
});

This works but not looks ideal as this workaround isn't documented, as well as it defeats the purpose of using IHealthChecksBuilder to manage registrations.

Describe the solution you'd like

I'd like to add some extension methods to IHealthChecksBuilder to allow modifying HealthCheckRegistrations like:

/// <summary>
/// Configures existing health check with the specified name.
/// </summary>
public static IHealthChecksBuilder ConfigureCheck(
    this IHealthChecksBuilder builder,
    string name,
    Action<HealthCheckRegistration> configure)
{
}

 /// <summary>
/// Configures all existing health checks that match the the specified criteria.
/// </summary>
public static IHealthChecksBuilder ConfigureCheck(
    this IHealthChecksBuilder builder,
    Predicate<HealthCheckRegistration> predicate,
    Action<HealthCheckRegistration> configure)
{
}

And the usage looks like:

services.AddHealthChecks().ConfigureCheck(
    registration => registration.Tags.Contains("tag"),
    registration => registration.Timeout = timeout);

Additional context

I already have those extension methods in our code, and extracted them to my own fork weichch#1.

Thank you for contacting us. Due to a lack of activity on this discussion issue we're closing it in an effort to keep our backlog clean. If you believe there is a concern related to the ASP.NET Core framework, which hasn't been addressed yet, please file a new issue.

This issue will be locked after 30 more days of inactivity. If you still wish to discuss this subject after then, please create a new issue!