Rename the health check endpoint to /healthz #467
Conversation
|
After this poll, I'm sure everyone will change this endpoint 😄 |
|
As I discussed w/ David, I'm team |
|
+1 for healthz given the broader cloud native ecosystem is invested in this convention. |
| @@ -100,7 +100,7 @@ public static WebApplication MapDefaultEndpoints(this WebApplication app) | |||
| // app.MapPrometheusScrapingEndpoint(); | |||
|
|
|||
| // All health checks must pass for app to be considered ready to accept traffic after starting | |||
| app.MapHealthChecks("/readiness"); | |||
| app.MapHealthChecks("/healthz"); | |||
There was a problem hiding this comment.
| app.MapHealthChecks("/healthz"); | |
| app.MapHealthChecks("/healthy"); |
| @@ -100,7 +100,7 @@ public static WebApplication MapDefaultEndpoints(this WebApplication app) | |||
| // app.MapPrometheusScrapingEndpoint(); | |||
|
|
|||
| // All health checks must pass for app to be considered ready to accept traffic after starting | |||
| app.MapHealthChecks("/readiness"); | |||
| app.MapHealthChecks("/healthz"); | |||
There was a problem hiding this comment.
| app.MapHealthChecks("/healthz"); | |
| app.MapHealthChecks("/healthy"); |
| @@ -100,7 +100,7 @@ public static WebApplication MapDefaultEndpoints(this WebApplication app) | |||
| // app.MapPrometheusScrapingEndpoint(); | |||
|
|
|||
| // All health checks must pass for app to be considered ready to accept traffic after starting | |||
| app.MapHealthChecks("/readiness"); | |||
| app.MapHealthChecks("/healthz"); | |||
There was a problem hiding this comment.
| app.MapHealthChecks("/healthz"); | |
| app.MapHealthChecks("/healthy"); |
|
@davidfowl are we doing this for preview.1 still? |
|
Yep, I will go with /health and /alive |
Why not /healthy? It's more aligned with /alive if that's a preference, but /health feels disjointed from /alive. If you're healthy, you're alive, but they're not dually synonymous. You could be alive, but unwell... Whereas, /health could be anything, what does this actually report? It is a bit, or some status object? Is it an When you say "and", are you using both, as in multiple routes that resolve with the same check? Just curious about this naming convention. I agree with @brendandburns on this one, but still a bit conflicted. |
|
/health does a deep health check and checks all dependencies. It'll eventually also return detailed health status (it'll return a single result today, healthy, unhealthy, degraded) |
davidfowl
force-pushed
the
davidfowl/healthz
branch
from
26bf1be
to
2a4b51c
Compare
|
/backport to release/8.0-preview1 |
|
Started backporting to release/8.0-preview1: https://github.com/dotnet/aspire/actions/runs/6737243070 |
|
@davidfowl backporting to release/8.0-preview1 failed, the patch most likely resulted in conflicts: $ git am --3way --ignore-whitespace --keep-non-patch changes.patch
Patch format detection failed.
Error: The process '/usr/bin/git' failed with exit code 128Please backport manually! |
|
@davidfowl an error occurred while backporting to release/8.0-preview1, please check the run log for details! Error: git am failed, most likely due to a merge conflict. |
danmoseley
added
the
area-app-model
Fixes #447