feat: Add health check #2247
Merged
feat: Add health check #2247
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds a health-check plugin and endpoint for monitoring pod status in Kubernetes. It introduces new dependencies for health checks, updates URL routing to include health endpoints, and configures health-check subsets in the settings.
- Added django-health-check and related packages in pyproject.toml.
- Updated main/urls.py to include the health endpoint.
- Configured health-check subsets in main/settings.py for startup, liveness, readiness, and full checks.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| pyproject.toml | Updated dependencies with additions and removals to support health checks. |
| main/urls.py | Added a new route for health check endpoints and updated static file routing. |
| main/settings.py | Integrated new health-check apps and defined a detailed configuration for health check subsets. |
Comments suppressed due to low confidence (1)
pyproject.toml:27
- It appears that the Django dependency is being both added and removed. Please verify that Django is declared only once to avoid potential version conflicts.
-Django = "4.2.21"
blarghmatey
force-pushed
the
add_healthcheck
branch
3 times, most recently
from
46d9a77 to
000570c
Compare
blarghmatey
added a commit
to mitodl/ol-infrastructure
that referenced
this pull request
May 12, 2025
We currently experience temporary 502s from the applications while they are doing a deployment rollout. This adds startup, readiness, and liveness checks to the pods to ensure that they are ready to serve traffic before they get incorporated into their corresponding service. This depends on upstream changes in the applications in PRS: - mitodl/mit-learn#2247 - mitodl/mitxonline#2652
blarghmatey
force-pushed
the
add_healthcheck
branch
2 times, most recently
from
8df938c to
a906f29
Compare
shanbady
approved these changes
May 14, 2025
blarghmatey
force-pushed
the
add_healthcheck
branch
2 times, most recently
from
ceab62f to
7c36893
Compare
In order to effectively manage Kubernetes applications we want to have startup, liveness, and readiness checks. This adds a package for exposing healthchecks that include information about the runtime status of the application.
blarghmatey
force-pushed
the
add_healthcheck
branch
from
7c36893 to
5df4129
Compare
2 tasks
blarghmatey
added a commit
to mitodl/ol-infrastructure
that referenced
this pull request
May 16, 2025
We currently experience temporary 502s from the applications while they are doing a deployment rollout. This adds startup, readiness, and liveness checks to the pods to ensure that they are ready to serve traffic before they get incorporated into their corresponding service. This depends on upstream changes in the applications in PRS: - mitodl/mit-learn#2247 - mitodl/mitxonline#2652
blarghmatey
added a commit
to mitodl/ol-infrastructure
that referenced
this pull request
May 16, 2025
We currently experience temporary 502s from the applications while they are doing a deployment rollout. This adds startup, readiness, and liveness checks to the pods to ensure that they are ready to serve traffic before they get incorporated into their corresponding service. This depends on upstream changes in the applications in PRS: - mitodl/mit-learn#2247 - mitodl/mitxonline#2652
blarghmatey
added a commit
to mitodl/ol-infrastructure
that referenced
this pull request
May 16, 2025
We currently experience temporary 502s from the applications while they are doing a deployment rollout. This adds startup, readiness, and liveness checks to the pods to ensure that they are ready to serve traffic before they get incorporated into their corresponding service. This depends on upstream changes in the applications in PRS: - mitodl/mit-learn#2247 - mitodl/mitxonline#2652
This was referenced May 16, 2025
Closed
Closed
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What are the relevant tickets?
N/A
Description (What does it do?)
Adds a health-check plugin and endpoint for monitoring pod status in Kubernetes
Screenshots (if appropriate):
How can this be tested?
Ensure that the
/health/,/health/liveness/,/health/startup/,/health/full/, and/health/readiness/endpoints return successfully in a running instance.Additional Context
In order to effectively manage Kubernetes applications we want to have startup, liveness, and readiness checks. This adds a package for exposing healthchecks that include information about the runtime status of the application.