feat: default /livez /healthz /readyz health endpoints#114
Merged
Conversation
No built-in health/readiness/liveness probes meant every team rolled their own. Serve GET /livez, /healthz, /readyz before the session + middleware chain so a frequent orchestrator probe never mints a session or emits an access log. /livez and /healthz report 200 while the process is up. /readyz reports 503 once Shutdown begins draining (a new `draining` flag set at the top of Shutdown) so traffic drains away from a departing pod while liveness stays green and the pod isn't force-killed mid-drain. WithoutHealthEndpoints() opts out when the app needs to own those paths.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Critic panel finding #8 (major; ops). Via shipped no health/readiness/liveness probes, so every team rolled their own.
Change
Serve
GET /livez,/healthz,/readyzbefore the session + middleware chain, so a frequent orchestrator probe never mints a session or emits an access-log line./livez+/healthz→ 200 while the process is up./readyz→ 503 onceShutdownbegins draining (newdrainingflag set at the top ofShutdown), so traffic drains away from a departing pod while liveness stays green (no force-kill mid-drain).WithoutHealthEndpoints()opts out when the app needs to own those paths.Tests
Full
ci-check.shgreen.