spacewander commented on a change in pull request #5117:
URL: https://github.com/apache/apisix/pull/5117#discussion_r715253476
##########
File path: docs/en/latest/health-check.md
##########
@@ -35,7 +34,34 @@ There won't be any health check if an upstream is configured
but isn't in used.
it whether this unique node is healthy or not.
* Active health check is required so that the unhealthy node can recover.
-The following is an example of health check:
+### Configuration instructions
+
+| Configuration item | Configuration type
| Value type | Value option | Defaults
| Description
|
+| ----------------------------------------------- |
------------------------------- | ---------- | -------------------- |
---------------------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------------------------------------------
|
+| upstream.checks.active.type | Active check
| string | `http` `https` `tcp` | http
| The type of active
check.
|
+| upstream.checks.active.timeout | Active check
| integer | | 1
| The timeout period
of the active check (unit: second).
|
+| upstream.checks.active.concurrency | Active check
| integer | | 10
| The number of
targets to be checked at the same time during the active check.
|
+| upstream.checks.active.http_path | Active check
| string | | /
| The HTTP request
path that is actively checked.
|
+| upstream.checks.active.host | Active check
| string | | ${upstream.node.host}
| The hostname of the
HTTP request actively checked.
|
+| upstream.checks.active.port | Active check
| integer | `1` to `65535` | ${upstream.node.port}
| The host port of the
HTTP request that is actively checked.
|
+| upstream.checks.active.https_verify_certificate | Active check
| boolean | | true
| Active check whether
to check the SSL certificate of the remote host when HTTPS type checking is
used. |
+| upstream.checks.active.req_headers | Active check
| array | | []
| Active check When
using HTTP or HTTPS type checking, set additional request header information.
|
+| upstream.checks.active.healthy.interval | Active check (healthy
node) | integer | `>= 1` | 1
| Active check
(healthy node) check interval (unit: second)
|
+| upstream.checks.active.healthy.http_statuses | Active check (healthy
node) | array | `200` to `599` | [200, 302]
| Active check
(healthy node) HTTP or HTTPS type check, the HTTP status code of the healthy
node. |
+| upstream.checks.active.healthy.successes | Active check (healthy
node) | integer | `1` to `254` | 2
| Active check
(healthy node) determine the number of times a node is healthy.
|
+| upstream.checks.active.unhealthy.interval | Active check (unhealthy
node) | integer | `>= 1` | 1
| Active check
(unhealthy node) check interval (unit: second)
|
+| upstream.checks.active.unhealthy.http_statuses | Active check (unhealthy
node) | array | `200` to `599` | [429, 404, 500, 501, 502, 503,
504, 505] | Active check
(unhealthy node) HTTP or HTTPS type check, the HTTP status code of the
non-healthy node. |
+| upstream.checks.active.unhealthy.http_failures | Active check (unhealthy
node) | integer | `1` to `254` | 5
| Active check
(unhealthy node) HTTP or HTTPS type check, determine the number of times that
the node is not healthy. |
+| upstream.checks.active.unhealthy.tcp_failures | Active check (unhealthy
node) | integer | `1` to `254` | 2
| Active check
(unhealthy node) TCP type check, determine the number of times that the node is
not healthy. |
+| upstream.checks.active.unhealthy.timeouts | Active check (unhealthy
node) | integer | `1` to `254` | 3
| Active check
(unhealthy node) to determine the number of timeouts for unhealthy nodes.
|
+| upstream.checks.passive.healthy.http_statuses | Passive check (healthy
node) | array | `200` to `599` | [200, 201, 202, 203, 204, 205,
206, 207,208, 226, 300, 301, 302, 303, 304, 305,306, 307, 308] | Passive check
(healthy node) HTTP or HTTPS type check, the HTTP status code of the healthy
node. |
Review comment:
```suggestion
| upstream.checks.passive.healthy.http_statuses | Passive check (healthy
node) | array | `200` to `599` | [200, 201, 202, 203, 204, 205,
206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308] | Passive
check (healthy node) HTTP or HTTPS type check, the HTTP status code of the
healthy node. |
```
--
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]
