-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add initial healthcheck endpoint (ampd) #14
Conversation
6e76637
to
14a53b4
Compare
ampd/src/health_check.rs
Outdated
.change_context(HealthCheckError::Error(format!( | ||
"Failed binding to addr: {}", | ||
bind_addr | ||
)))?, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Normally i do not like to use new()
for doing things like binding sockets. Initially i consider this approach doable taking into account how the rest of the codebase interacts with this server.
14a53b4
to
c1c2795
Compare
Manual testingIn order to provide certain confidence the healthcheck endpoint is not disturbing other components, the
|
be8095a
to
198838a
Compare
…ld (axelarnetwork#336) * feat(minor-multisig-prover)!: allow dynamic update of signing threshold
0933b08
to
b683961
Compare
* implement trait for evm message id
* cleanup tests * renamed function
… the new value directly Co-authored-by: tilacog <[email protected]>
Co-authored-by: tilacog <[email protected]>
Use enum variant and make all errors transparent to application.
d8f8e64
to
a541b94
Compare
The work of this PR is being upstreamed at axelarnetwork#344 . We are waiting for feedback there. Closing this one. |
Description
At Eiger we are working on the Axelar Solana implementation. During this work, we realised
ampd
doesn't have a defined way to check theliveness
of the process from an external perspective. This is specially useful when deploying workloads in i.e Kubernetes, as the cluster can query the process in order to check if its alive or not.This is a PR proposal for adding an
HTTP
/status
endpoint to theampd
process, that can be used by external systems to determine theliveness
of the process.Closes #12
Todos
Steps to Test
Manual
ampd
server.Unit tests
Expected Behaviour
Once
ampd
starts its activity, an HTTP request to the/status
endpoint should return a200 OK
response in json format:{ ok: true }
Other Notes
This is just a dummy HTTP health check endpoint that only provides a probe of liveness of the process. It doesn't query any subsystem in order to check their internal health. In a future, such option could be revisited.