Add /healthcheck endpoint that doesn't collect PDU data #6
Conversation
This file contains 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
|
Thank you for the PR! This looks good and after some tests on our setup it seems to run without issues. There are two points I'd like you to address before I merge this PR:
|
When the exporter is deployed in a system that healthchecks running processes, such as Kubernetes, it's useful to have a healthcheck endpoint that can return quickly which still catching errors where eg the web server is hanging. This basic /healthcheck endpoint returns a 200 and a short message, avoiding the call to `collect` which would normally gather all of the PDU data and can be slow to return. All other endpoints will still return the PDU data in Prometheus format. Closes psyinfra#5.
tomelliff
force-pushed
the
telliffoshea/provide-healthcheck-endpoint
branch
from
9c826a2 to
774e0b0
Compare
|
Ah, sorry, just realised I didn't hit comment on this when I added the changes. I think that's right now although running the tests locally was failing for me so was just going to rely on the CI here unless it fails again. |
|
I approved the CI run. :-) |
|
Nice work @tomelliff! I'll merge the PR now. |
|
Thanks for the patch! |
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.
When the exporter is deployed in a system that healthchecks running processes, such as Kubernetes, it's useful to have a healthcheck endpoint that can return quickly which still catching errors where eg the web server is hanging.
This basic /healthcheck endpoint returns a 200 and a short message, avoiding the call to
collectwhich would normally gather all of the PDU data and can be slow to return. All other endpoints will still return the PDU data in Prometheus format.Closes #5.