You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/07/18 01:10:01 UTC

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

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


##########
docs/en/latest/plugins/api-breaker.md:
##########
@@ -46,7 +46,7 @@ In an unhealthy state, if the Upstream service responds with a status code from
 | break_response_headers  | array[object]  | False    |         | [{"key":"header_name","value":"can contain Nginx $var"}] | Headers of the response message to return when Upstream is unhealthy. Can only be configured when the `break_response_body` attribute is configured. The values can contain APISIX variables. For example, we can use `{"key":"X-Client-Addr","value":"$remote_addr:$remote_port"}`. |
 | max_breaker_sec         | integer        | False    | 300     | >=3             | Maximum time in seconds for circuit breaking.                                                                                                                                                                                                |
 | unhealthy.http_statuses | array[integer] | False    | [500]   | [500, ..., 599] | Status codes of Upstream to be considered unhealthy.                                                                                                                                                                                         |
-| unhealthy.failures      | integer        | False    | 3       | >=1             | Number of consecutive failures for the Upstream service to be considered unhealthy.                                                                                                                                                          |
+| unhealthy.failures      | integer        | False    | 3       | >=1             | Number of failures for the Upstream service to be considered unhealthy,which only takes effect if the number of consecutive success requests between failed requests does not reach `healthy.successes`.                                                                                                                                                          |

Review Comment:
   The description is confusing. Maybe we don't need to highlight it.
   
   @tzssangglass What's your opinion?



-- 
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