[GitHub] [apisix] SylviaBABY commented on a diff in pull request #7479: docs:fix unhealthy.failures attribute description of api-breaker plugin

[GitBox <gi...@apache.org>]

SylviaBABY commented on code in PR #7479:
URL: https://github.com/apache/apisix/pull/7479#discussion_r922927091


##########
docs/zh/latest/plugins/api-breaker.md:
##########
@@ -48,14 +48,14 @@ title: api-breaker
 | break_response_headers  | array[object]  | 可选   | 无         | [{"key":"header_name","value":"can contain Nginx $var"}] | 不健康返回报文头，这里可以设置多个。该字段仅在 `break_response_body` 被配置时生效。这个值能够以 `$var` 的格式包含 APISIX 变量，比如 `{"key":"X-Client-Addr","value":"$remote_addr:$remote_port"}`。 |
 | max_breaker_sec         | integer        | 可选   | 300        | >=3             | 最大熔断持续时间                 |
 | unhealthy.http_statuses | array[integer] | 可选   | {500}      | [500, ..., 599] | 不健康时候的状态码               |
-| unhealthy.failures      | integer        | 可选   | 3          | >=1             | 触发不健康状态的连续错误请求次数 |
+| unhealthy.failures      | integer        | 可选   | 3          | >=1             | 触发不健康状态的异常请求次数，并且异常请求间连续正常请求未达到触发健康状态的次数 |
 | healthy.http_statuses   | array[integer] | 可选   | {200}      | [200, ..., 499] | 健康时候的状态码                 |
 | healthy.successes       | integer        | 可选   | 3          | >=1             | 触发健康状态的连续正常请求次数   |
 
 ## 启用方式
 
 这是一个示例，在指定的路由上启用 `api-breaker` 插件。
-应答 500 或 503 连续 3 次，触发熔断。应答 200 连续 1 次，恢复健康。
+应答 500 或 503 3 次且异常请求间应答 200 未达到1次，触发熔断。应答 200 连续 1 次，恢复健康。

Review Comment:
   ```suggestion
   应答 500 或 503 的次数达到 3 且异常请求间应答 200 未达到 1 次，触发熔断。应答 200 连续 1 次，恢复健康。
   ```



##########
docs/zh/latest/plugins/api-breaker.md:
##########
@@ -85,7 +85,7 @@ curl "http://127.0.0.1:9080/apisix/admin/routes/1" -H 'X-API-KEY: edd1c9f034335f
 
 ## 测试插件
 
-使用上游的配置，如果你的上流服务返回 500，连续 3 次。客户端将会收到 502（break_response_code）应答。
+使用上游的配置，如果你的上流服务返回 500 3 次且异常请求间返回 200 未达到1次。客户端将会收到 502（break_response_code）应答。

Review Comment:
   ```suggestion
   使用上游的配置，如果你的上流服务返回 500 次数达到 3 且异常请求间返回 200 未达到 1 次。客户端将会收到 502（break_response_code）应答。
   ```



-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org