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

[Improvement] Liveness check and health check #6527

Open
youngyjd opened this issue Feb 26, 2025 · 4 comments
Open

[Improvement] Liveness check and health check #6527

youngyjd opened this issue Feb 26, 2025 · 4 comments
Labels
improvement Improvements on everything

Comments

@youngyjd
Copy link

youngyjd commented Feb 26, 2025

What would you like to be improved?

In an ideal environment, we should have 2 type of checks:

  1. Liveness check: to determine if a container has started or not
  2. Readiness check: to determine if the container is ready to accept network traffic.

A real example - if db has not been init yet while we deploy the service, the liveness check should pass while the readiness check should fail.

Currently Gravitino has the api/version endpoint that is more suitable for liveness check. Is there an endpoint for readiness check?

How should we improve?

No response

@youngyjd youngyjd added the improvement Improvements on everything label Feb 26, 2025
@jerqi
Copy link
Contributor

jerqi commented Feb 26, 2025

You can also use API /configs. The API won't need authentication.

@tengqm
Copy link
Contributor

tengqm commented Feb 26, 2025

As stated in the issue description, readiness check is expected to indicate that the service can serve requests. So I don't think /configs is a proper endpoint for this purpose. If needed, we may add a /readyz endpoint for this purpose.

@jerqi
Copy link
Contributor

jerqi commented Feb 26, 2025

As stated in the issue description, readiness check is expected to indicate that the service can serve requests. So I don't think /configs is a proper endpoint for this purpose. If needed, we may add a /readyz endpoint for this purpose.

Sorry for my confusing words. I want to say that configs can be used for liveness check.

@mchades
Copy link
Contributor

mchades commented Feb 26, 2025

How about using the testConnection endpoint: https://gravitino.apache.org/docs/0.8.0-incubating/api/rest/test-connection

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improvements on everything
Projects
None yet
Development

No branches or pull requests

4 participants