kayx23 commented on code in PR #10547: URL: https://github.com/apache/apisix/pull/10547#discussion_r1404669369
########## docs/en/latest/tutorials/health-check.md: ########## @@ -161,3 +161,72 @@ The health check status can be fetched via `GET /v1/healthcheck` in [Control API curl http://127.0.0.1:9090/v1/healthcheck/upstreams/healthycheck -s | jq . ``` + +## Health Check Information + +APISIX provides comprehensive health check information, with particular emphasis on the `status` and `counter` parameters for effective health monitoring. In the APISIX context, nodes exhibit four states: `healthy`, `unhealthy`, `mostly_unhealthy`, and `mostly_healthy`. The transition of a node's state depends on the success or failure of the current health check, along with the recording of four key metrics in the `counter`: `tcp_failure`, `http_failure`, `success`, and `timeout_failure`. Review Comment: I suggest we _explicitly_ explain `mostly_healthy` and `mostly_unhealthy` as well. For example, `mostly_healthy` status means the current node status is healthy, but APISIX starts to receive unhealthy indications during health checks. I understand this concept is somewhat conveyed in the state transition diagram. However, I find it a bit easier to understand if you explain it up front as well. What do you guys think? @luoluoyuyu @monkeyDluffy6017 ########## docs/en/latest/tutorials/health-check.md: ########## @@ -161,3 +161,72 @@ The health check status can be fetched via `GET /v1/healthcheck` in [Control API curl http://127.0.0.1:9090/v1/healthcheck/upstreams/healthycheck -s | jq . ``` + +## Health Check Information + +APISIX provides comprehensive health check information, with particular emphasis on the `status` and `counter` parameters for effective health monitoring. In the APISIX context, nodes exhibit four states: `healthy`, `unhealthy`, `mostly_unhealthy`, and `mostly_healthy`. The transition of a node's state depends on the success or failure of the current health check, along with the recording of four key metrics in the `counter`: `tcp_failure`, `http_failure`, `success`, and `timeout_failure`. + +To retrieve health check information, you can use the following curl command: + +```shell +curl -X GET http://your_apisix_server/your_health_check_endpoint Review Comment: This can stay consistent with the Chinese doc. Reason: the `/v1/healthcheck` endpoint is exposed by Control API and fixed. ```suggestion curl -i http://127.0.0.1:9090/v1/healthcheck ``` -- 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]
