apache / apache/gravitino

[Improvement] Liveness check and health check

Open
#6,527 6 comments 2 reactions 0 assignees View on GitHub
improvement
Dominant language
Java
Stars
3.2k
Forks
935
Avg merge
1d 16h
Merged PRs (30d)
298

Description

### 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_

Contributor guide

Open the contributing guide

Research direction

Start with the existing api/version endpoint and trace how service startup and database initialization are exposed. Determine the readiness behavior needed for a container that has started but cannot yet accept network traffic, then document or test the endpoint behavior so liveness and readiness are distinguishable.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.