Refactor health status to separate status from reason #3421
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
Previously, BackendHealthStatus conflated WHAT the status is with WHY the backend is in that state. For example, BackendUnauthenticated was both a status value and a reason, making it unclear whether a backend was unavailable due to authentication issues or other causes. This improves observability by providing clear separation between the backend's availability state and the underlying cause of that state. Related-to: #3147 This change introduces BackendHealthReason to explicitly capture WHY a backend is in its current state, while BackendHealthStatus describes WHAT the state is (healthy, degraded, unhealthy, unknown).
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3421 +/- ##
==========================================
+ Coverage 64.75% 64.87% +0.11%
==========================================
Files 382 383 +1
Lines 37187 37224 +37
==========================================
+ Hits 24082 24148 +66
+ Misses 11221 11189 -32
- Partials 1884 1887 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Author
|
i will implement later when we add more integration with k8s as well |
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.
Previously, BackendHealthStatus conflated WHAT the status is with WHY the backend is in that state. For example, BackendUnauthenticated was both a status value and a reason, making it unclear whether a backend was unavailable due to authentication issues or other causes.
This improves observability by providing clear separation between the backend's availability state and the underlying cause of that state.
Related-to: #3147
This change introduces BackendHealthReason to explicitly capture WHY a backend is in its current state, while BackendHealthStatus describes WHAT the state is (healthy, degraded, unhealthy, unknown).