add health check endpoint to signature-aggregator #442
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
tested by putting a 30 second sleep into the signature-aggregator e2e test and
then while it was sleeping did:
```
$ curl localhost:8082/health
{"status":"up","details":{"signature-aggregator":{"status":"up","timestamp":"2024-08-20T01:23:14.351599017Z"}}}
```
feuGeneA
requested review from
iansuvak,
geoff-vball,
minghinmatthewlam,
bernard-avalabs,
michaelkaplan13 and
cam-schultz
geoff-vball
approved these changes
Aug 20, 2024
feuGeneA
commented
Aug 20, 2024
iansuvak
approved these changes
Aug 20, 2024
cam-schultz
reviewed
Aug 20, 2024
| healthChecker := health.NewChecker( | ||
| health.WithCheck(health.Check{ | ||
| Name: "signature-aggregator", | ||
| Check: func(context.Context) error { return nil }, |
There was a problem hiding this comment.
Looks like this is a no-op for now. Can you create a ticket and/or add todo comments here to make this health check meaningful?
There was a problem hiding this comment.
I raised an issue here: #447
But, note, this actually already is meaningful, in that the http.ListenAndServe() call made in the aggregator includes both the health check path and also the signature request path, so when this health check starts responding with "healthy", that's an indication that all of the paths served by that ListenAndServe() call are ready, so it tells us that the service is ready to handle signature requests.
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.
Why this should be merged
fixes #424
How this was tested
by putting a 30 second sleep into the signature-aggregator e2e test and then while it was sleeping did: