Conversation
Small typo
@dotnet-policy-service agree |
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the health check endpoint URLs from /healthz to /healthy throughout the documentation. However, there is a critical inconsistency between the updated documentation text and the referenced code examples.
Key Issues:
- Documentation text has been updated to reference
/healthyendpoints - Referenced code snippets still use
/healthzendpoints - This creates a mismatch where examples don't match their descriptions
| Register health check services with <xref:Microsoft.Extensions.DependencyInjection.HealthCheckServiceCollectionExtensions.AddHealthChecks%2A> in `Program.cs`. Create a health check endpoint by calling <xref:Microsoft.AspNetCore.Builder.HealthCheckEndpointRouteBuilderExtensions.MapHealthChecks%2A>. | ||
|
|
||
| The following example creates a health check endpoint at `/healthz`: | ||
| The following example creates a health check endpoint at `/healthy`: |
There was a problem hiding this comment.
The documentation now states that the example "creates a health check endpoint at /healthy", but the referenced code snippet (id="snippet_MapHealthChecksComplete") actually uses /healthz as the endpoint path. This creates an inconsistency where the documentation doesn't match the code example it references.
Either:
- Update the code snippet to use
/healthyinstead of/healthz, or - Change the documentation text back to reference
/healthzto match the actual code.
| The following example creates a health check endpoint at `/healthy`: | |
| The following example creates a health check endpoint at `/healthz`: |
| * `/healthy/ready` for the readiness check. The readiness check filters health checks to those tagged with `ready`. | ||
| * `/healthy/live` for the liveness check. The liveness check filters out all health checks by returning `false` in the <xref:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions.Predicate%2A?displayProperty=nameWithType> delegate. For more information on filtering health checks, see [Filter health checks](#filter-health-checks) in this article. |
There was a problem hiding this comment.
The documentation now references /healthy/ready and /healthy/live endpoints, but the referenced code snippet (id="snippet_MapHealthChecksReadinessLiveness") still uses /healthz/ready and /healthz/live. This creates an inconsistency where the documentation doesn't match the code example it references.
Either:
- Update the code snippet to use
/healthy/readyand/healthy/live, or - Change the documentation text back to reference
/healthz/readyand/healthz/liveto match the actual code.
| * `/healthy/live` for the liveness check. The liveness check filters out all health checks by returning `false` in the <xref:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions.Predicate%2A?displayProperty=nameWithType> delegate. For more information on filtering health checks, see [Filter health checks](#filter-health-checks) in this article. | ||
|
|
||
| Before the startup task completes, the `/healthz/ready` endpoint reports an `Unhealthy` status. Once the startup task completes, this endpoint reports a `Healthy` status. The `/healthz/live` endpoint excludes all checks and reports a `Healthy` status for all calls. | ||
| Before the startup task completes, the `/healthy/ready` endpoint reports an `Unhealthy` status. Once the startup task completes, this endpoint reports a `Healthy` status. The `/healthy/live` endpoint excludes all checks and reports a `Healthy` status for all calls. |
There was a problem hiding this comment.
The documentation references /healthy/ready and /healthy/live endpoints, but the referenced code snippet (id="snippet_MapHealthChecksReadinessLiveness") still uses /healthz/ready and /healthz/live. This creates an inconsistency where the documentation doesn't match the code example it references.
Either:
- Update the code snippet to use
/healthy/readyand/healthy/live, or - Change the documentation text back to reference
/healthz/readyand/healthz/liveto match the actual code.
|
Hello @mahmoud-syr ... Thanks for the PR, but this doesn't cover all occurrences. There are four other articles that have "healthz" language, and there are perhaps six sample apps that use "healthz." It looks like "healthz" was used everywhere. Search the whole repo (markdown and This article maps to Tom, so I'll ping him to manage the updates. I recommend waiting to apply further changes until he has a chance to look at this. |
tdykstra
left a comment
There was a problem hiding this comment.
I recommend we go in the opposite direction and standardize on healthz. See, for example, this Stack Overflow Q and A.
Small typo there is a z instead of y in
healthycaused probably by German keyboard 😁Internal previews