feat: Add separate liveness and readiness checks#5151
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ |
Contributor
Docker builds report
|
Contributor
|
Uffizzi Preview |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5151 +/- ##
=======================================
Coverage 97.46% 97.47%
=======================================
Files 1224 1224
Lines 42545 42567 +22
=======================================
+ Hits 41466 41491 +25
+ Misses 1079 1076 -3 ☔ View full report in Codecov by Sentry. |
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
2 participants
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.
This PR adds separate liveness and readiness checks, to be added later in the Helm charts. The existing
/healthendpoint is maintained with no changes for backwards compatibility.The liveness check is the same as calling
/version, which has no external dependencies. It does check that the filesystem is readable, since the version data is read from the filesystem. This is just testing that the API can respond to requests.The readiness check is the same as the current
/healthendpoint, which checks that all migrations have been applied, and the database is available. We add a separate/health/readinessendpoint to make this obvious.We also modify the
api/scripts/healthcheck.pyscript, which is used by the default Docker Compose setup. Docker Compose health checks should effectively be liveness and not readiness health checks.Tested manually by making requests to all the endpoints, and confirming there are no warnings about URL namespaces.