jerryshao commented on code in PR #12402: URL: https://github.com/apache/gravitino/pull/12402#discussion_r3747541578
########## docs/health-and-readiness.md: ########## @@ -0,0 +1,134 @@ +--- +title: "Health and readiness" +slug: /health-and-readiness +keywords: + - health + - readiness + - liveness + - monitoring +license: "This software is licensed under the Apache License version 2." +--- + +Gravitino exposes separate liveness and readiness endpoints so that a caller can tell "restart this +process" apart from "send traffic somewhere else." Liveness answers whether the server can respond +at all. Readiness answers whether it can reach the entity store and therefore do useful work. + +The endpoints follow MicroProfile Health semantics. A healthy check returns 200 and an unhealthy one +returns 503, both with a JSON body naming the individual checks that ran. + +## Quick Start + +**1. Check liveness.** This returns 200 whenever an HTTP thread is able to answer. + +```shell +GRAVITINO_URL=http://localhost:8090 Review Comment: Shall we also mention the IRC and Lance Rest endpoints here? -- 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]
