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

Document or specify how a service could implement a health check #58

Open
susheel opened this issue Jan 22, 2020 · 3 comments
Open

Document or specify how a service could implement a health check #58

susheel opened this issue Jan 22, 2020 · 3 comments
Labels
feature New feature or request
Milestone

Comments

@susheel
Copy link

susheel commented Jan 22, 2020

Document or specify how a service could implement a health check (/healthz) which is especially important for ephemeral services and for service registries to rank services

@arendon
Copy link

arendon commented Jan 22, 2020

I would propose that we separate concerns. The info endpoint may provide information of where the health endpoint may be called. The health endpoint may be an additional part of a spec for generating a network of integrate-able endpoints.

@susheel
Copy link
Author

susheel commented Jan 22, 2020

+1 Agree.

I think the spec could have an additional object that provides a number of probes if available:

{
  ...
  "probes": {
    "health": "/healthz",
    "metrics": "/metrics"
  }
  ...
}

This would be especially important for integration with the service registry

@jrambla
Copy link

jrambla commented Jan 23, 2020

In the ELIXIR Services Network specification we left that part for the next iteration, however, we designed it in a way that 1) the service should be able to answer autonomously, but granted registries can requests the stats, thus having a more comprehensive view of the network, and provide requesting services with a more useful and efficient view of what is in the network.
Practical example: You are a Beacon Aggregator (BA) service (a Beacon Network, old nomenclature), you request the corresponding Service Registry (SR) about the Beacons in the network in order to query them. The SR can simply provide a list of Beacons or complement that with the information about which ones are up or down, e.g.

@mcupak mcupak added the feature New feature or request label Jan 30, 2020
@mcupak mcupak modified the milestones: 1.0.0, 1.1.0 Jan 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants