健康检查

Upstream 的健康检查

APISIX 的健康检查使用lua-resty-healthcheck实现,你可以在 upstream 中使用它。

注意:

  • 只有在 upstream 被请求时才会开始健康检查。 如果一个 upstream 被配置但没有被请求,那么就不会有健康检查。
  • 如果没有健康的节点,那么请求会继续发送给上游。
  • 如果 upstream 中只有一个节点,就不会有健康检查。 因为该唯一节点无论是否健康,请求都会发送给上游,
  • 主动健康检查是必须的,这样不健康的节点才会恢复。

下面是一个检查检查的例子:

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "uri": "/index.html",
  4. "plugins": {
  5. "limit-count": {
  6. "count": 2,
  7. "time_window": 60,
  8. "rejected_code": 503,
  9. "key": "remote_addr"
  10. }
  11. },
  12. "upstream": {
  13. "nodes": {
  14. "127.0.0.1:1980": 1,
  15. "127.0.0.1:1970": 1
  16. },
  17. "type": "roundrobin",
  18. "retries": 2,
  19. "checks": {
  20. "active": {
  21. "timeout": 5,
  22. "http_path": "/status",
  23. "host": "foo.com",
  24. "healthy": {
  25. "interval": 2,
  26. "successes": 1
  27. },
  28. "unhealthy": {
  29. "interval": 1,
  30. "http_failures": 2
  31. },
  32. "req_headers": ["User-Agent: curl/7.29.0"]
  33. },
  34. "passive": {
  35. "healthy": {
  36. "http_statuses": [200, 201],
  37. "successes": 3
  38. },
  39. "unhealthy": {
  40. "http_statuses": [500],
  41. "http_failures": 3,
  42. "tcp_failures": 3
  43. }
  44. }
  45. }
  46. }
  47. }'

监控检查的配置内容在checks中,checks包含两个类型:activepassive,详情如下

  • active: 要启动主动健康检查,需要在 upstream 配置中的 checks.active 添加如下配置项。

    • active.timeout: 主动健康检查 socket 超时时间(秒为单位),支持小数点。比如 1.01 代表 1010 毫秒,2 代表 2000 毫秒。

    • active.http_path: 用于发现 upstream 节点健康可用的 HTTP GET 请求路径。

    • active.host: 用于发现 upstream 节点健康可用的 HTTP 请求主机名。

    • active.port: 用于发现 upstream 节点健康可用的自定义主机端口(可选),配置此项会覆盖 upstream 节点中的端口。

    healthy的阀值字段:

    • active.healthy.interval: 健康的目标节点的健康检查间隔时间(以秒为单位),最小值为 1。
    • active.healthy.successes: 确定目标是否健康的成功次数,最小值为 1。

    unhealthy的阀值字段:

    • active.unhealthy.interval: 针对不健康目标节点的健康检查之间的间隔(以秒为单位),最小值为 1。
    • active.unhealthy.http_failures: 确定目标节点不健康的 http 请求失败次数,最小值为 1。
    • active.req_headers: 其他请求标头。数组格式,可以填写多个标题。
  • passive: 要启用被动健康检查,需要在 upstream 配置中的 checks.passive 添加如下配置项。

    healthy的阀值字段:

    • passive.healthy.http_statuses: 如果当前 HTTP 响应状态码是其中任何一个,则将 upstream 节点设置为 healthy 状态。否则,请忽略此请求。
    • passive.healthy.successes: 如果 upstream 节点被检测成功(由 passive.healthy.http_statuses 定义)的次数超过 successes 次,则将该节点设置为 healthy 状态。

    unhealthy的阀值字段:

    • passive.unhealthy.http_statuses: 如果当前 HTTP 响应状态码是其中任何一个,则将 upstream 节点设置为 unhealthy 状态。否则,请忽略此请求。
    • passive.unhealthy.tcp_failures: 如果 TCP 通讯失败次数超过 tcp_failures 次,则将 upstream 节点设置为 unhealthy 状态。
    • passive.unhealthy.timeouts: 如果被动健康检查超时次数超过 timeouts 次,则将 upstream 节点设置为 unhealthy 状态。
    • passive.unhealthy.http_failures: 如果被动健康检查的 HTTP 请求失败(由 passive.unhealthy.http_statuses 定义)的次数超过 http_failures次,则将 upstream 节点设置为 unhealthy 状态。

健康检查信息可以通过 控制接口 中的 GET /v1/healthcheck 接口得到。