[GraphQL][cherry-pick #18277] Gql cherry pick health endpoint into 2024.4 release #18399
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.
Description
Adds a
checkpoint_timestamp_ms
to the watermark task and uses it in a new health check endpoint function. The health endpoint checks for two thingsmax_checkpoint_lag_ms
or a default value, and it returns code 504, GATEWAY TIMEOUT in that case.How to query this endpoint:
curl -X GET "http://127.0.0.1:8000/health" -i
Set the check for max checkpoint time lag to 10s. If it returns 503, then the checkpoint is behind.
curl -X GET "http://127.0.0.1:8000/health?max_checkpoint_lag_ms=10000" -i
Test plan
Added a new test.
cargo nextest run --features pg_integration -- test_health_check
Release notes
Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.