Skip to content
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

Update /node/health endpoint to ease integration with probe systems #147

Closed
Magicking opened this issue May 23, 2021 · 0 comments · Fixed by #251
Closed

Update /node/health endpoint to ease integration with probe systems #147

Magicking opened this issue May 23, 2021 · 0 comments · Fixed by #251

Comments

@Magicking
Copy link
Contributor

Magicking commented May 23, 2021

Problem
Somes probe systems uses HTTP status code as yes(200-2XX)/no(503) rather than yes(200)/maybe(206)/no(503), requiring complex configuration for integration (e.g: Kubernetes probes, shell scripts, ...).

To help those systems a non-breaking update of the API spec can ease the integration, adding an optional integer query parameter syncing_status to the getHealth endpoint, modifying the return status code of the maybe from 206 to the value of syncing_status.

A proposition of this update is currently implemented in Teku.

Actual behavior:
An endpoint answering:

  • 200 when fully functional and synced
  • 206 when syncing
  • 503 when the service is not functional

Desired behavior:
An endpoint behaving this way:

  • 200 when fully functional
  • syncing_status (e.g: 200, 206(default), 503 or XXX) when syncing
  • 503 when the service is not fully functional
rolfyone added a commit to rolfyone/beacon-APIs that referenced this issue Oct 26, 2022
When specified, the server will return the value in the query parameter instead of 206, if the server is syncing.

fixes ethereum#147
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant