jerryshao opened a new pull request, #11261:
URL: https://github.com/apache/gravitino/pull/11261

   ### What changes were proposed in this pull request?
   
   Add user-facing documentation for the health check REST endpoints introduced 
in #10840, #10847, and #11102.
   
   - **`docs/gravitino-server-config.md`**: New `### Health check endpoints` 
section (after Metrics configuration) covering `GET /api/health/live`, `GET 
/api/health/ready`, `GET /api/health`, the root-level GTM aliases (`/health`, 
`/health/live`, `/health/ready`, `/health.html`), the 
`gravitino.server.health.entityStore.probeTimeoutMs` configuration property, 
and UP/DOWN JSON response examples.
   - **`docs/iceberg-rest-service.md`**: New `### Health check endpoints` 
section (after Misc configurations) covering `GET /iceberg/health/live`, `GET 
/iceberg/health/ready`, `GET /iceberg/health`, the same root-level GTM aliases 
forwarding to `/iceberg/health*`, and UP/DOWN JSON response examples.
   
   ### Why are the changes needed?
   
   The health endpoints were implemented but lacked user-facing documentation, 
making it difficult for operators deploying Gravitino in containerized or 
enterprise environments to discover and configure the probe endpoints.
   
   Fix: #10856
   
   ### Does this PR introduce _any_ user-facing change?
   
   No code changes. Documentation only.
   
   ### How was this patch tested?
   
   Documentation change only; no test required.
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to