indexer-service: Add /subgraphs/health/:deployment route #348
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
This route handles only GET requests. It returns an HTTP 200 response if the deployment in question has not failed and is caught up to the chain head. Otherwise, a 500 is returned with different error messages depending on what is wrong. This can be used to check the health of specific subgraph deployments in environments where the indexing status API is too complicated and simple, URL-based health checks are the only option (e.g. Cloudflare load balancers, k8s readiness probes, status pages).
promaty
reviewed
Jan 10, 2022
| // Check whether the subgraph is caught up with the chain head | ||
| if ( | ||
| latestBlock?.number === headBlock?.number && | ||
| latestBlock?.hash === headBlock?.hash |
There was a problem hiding this comment.
I think this should be headBlock.number - latestBlock?.number < 5 or something because it doesn't execute instantly
hopeyen
reviewed
Jan 11, 2022
Contributor
hopeyen
left a comment
hopeyen
left a comment
There was a problem hiding this comment.
agree with promaty that a slight lag should still be healthy, otherwise looks pretty good!
This accounts for potential delay in processing blocks.
Contributor
Author
promaty
approved these changes
Jan 19, 2022
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.
This route handles only GET requests. It returns an HTTP 200 response if the deployment in question has not failed and is caught up to the chain head. Otherwise, a 500 is returned with different error messages depending on what is wrong.
This can be used to check the health of specific subgraph deployments in environments where the indexing status API is too complicated and simple, URL-based health checks are the only option (e.g. Cloudflare load balancers, k8s readiness probes, status pages).