dotnet/aspnetcore

services.AddHealthChecks missing overload that takes delegate for configuring HealthChecksOptions

Closed

#8,530 opened on Mar 14, 2019

View on GitHubContributor guide
 (7 comments) (4 reactions) (0 assignees)C# (10,653 forks)batch import
affected-very-fewarea-healthchecksenhancementgood first issuehelp wantedseverity-minor

Repository metrics

Stars
 (37,933 stars)
PR merge metrics
 (Avg merge 16d 9h) (258 merged PRs in 30d)

Description

We need to add the overload to Health Checks to enable passing an options configuration delegate when adding Health Checks to services, e.g.:

services.AddHealthChecks(options =>
{
    options.AllowCachingResponses = true;
}).AddCheck<MyHealthCheck>()

@rynowak @glennc

Contributor guide

Research direction
The issue requests adding an overload to the AddHealthChecks extension method. Start by locating the existing AddHealthChecks method in the HealthChecks source code, likely in the Microsoft.Extensions.DependencyInjection namespace. Review the current implementation and the HealthChecksOptions class to understand the pattern. Then implement a new overload that accepts an Action<HealthChecksOptions> delegate. Ensure the new method follows the existing pattern and test accordingly. Also check the issue comments for any additional guidance.
Tech stack
csharp
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#ASP.NET CoreExtension methods
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65