Consider changing HealthStatus

[rynowak]

I'm still not totally happy with the design of health status. We should review this again and see if it's meeting all of our goals.

Design points:

• app developers want to control the status reported from health checks they didn't author
• health check library authors generally will report healthy or unhealthy
• user-authored health checks often use degraded
• I'm still really unhappy with Failed and what it does

#479 (comment)

[yelakhal]

Hi @rynowak ,

Thank you for your efforts. We really need this kind of check.

We are implementing a healthCheck in our services and we will certainly replace it with the official .Net Core healthCheck but we have a need to customize the return json object.

Is should be useful to have a second Func parameter in which we can return a response based on the CompositeHealthCheckResult.
Something like:

.UseHealthChecks("/HealthCheck", cr =>
            {
                var healthCheckResults = cr.Results.Where(r => r.Value is IHealthCheckResult);
                return new
                {
                    status = cr.CheckStatus.ToString(),
                    details = healthCheckResults.Select(r => new { scope = r.Key, message = r.Value.Description, status = r.Value.CheckStatus.ToString() })
                };
            });

[steveoh]

@youssefNettuno I think you can do at least part of that with a HealthCheck ResponseWriter

[rynowak]

@unaizorrilla - do you have any concerns if we go back to individual health checks returning healthy/degraded/unhealthy? I still want to retain a way for the app author to specify what the health check should return. I'll have a proposal soon.

[unaizorrilla]

Hi @rynowak - nope, let me known when you have the proposal.

[rynowak]

Done!

[steveoh]

What's the new proposal or solution? Is it doc'd or what's the store?

[rynowak]

Oops sorry the PR didn't get linked here: #520

It's pretty similar to what you saw in preview2. For an app author, return whatever status you want in custom checks.

The guidance for libraries is to use context.Registration.FailureStatus to respect what the user configurated.

[alexsandro-xpt]

+1