kayx23 commented on code in PR #10547: URL: https://github.com/apache/apisix/pull/10547#discussion_r1404672443
########## 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 +``` + +Response Example: + +```json +[ + { + "nodes": {}, + "name": "/apisix/routes/1", + "type": "http" + }, + { + "nodes": [ + { + "port": 1970, + "hostname": "127.0.0.1", + "status": "healthy", + "ip": "127.0.0.1", + "counter": { + "tcp_failure": 0, + "http_failure": 0, + "success": 0, + "timeout_failure": 0 + } + }, + { + "port": 1980, + "hostname": "127.0.0.1", + "status": "healthy", + "ip": "127.0.0.1", + "counter": { + "tcp_failure": 0, + "http_failure": 0, + "success": 0, + "timeout_failure": 0 + } + } + ], + "name": "/apisix/routes/example-hc-route", + "type": "http" + } +] +``` + +### State Diagram Review Comment: ```suggestion ### State Transition Diagram ``` -- 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]
