update controller.md #665
Merged
update controller.md #665
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
localvar
reviewed
Jun 24, 2022
doc/reference/controllers.md
Outdated
Comment on lines
601
to
624
| The CircuitBreaker is a finite state machine with three states: `CLOSED`, `OPEN`, and `HALF_OPEN`. When the state is `CLOSED`, requests pass through the CircuitBreaker normally, state transits to `OPEN` if request failure rate or slow request rate reach a configured threshold and the CircuitBreaker short-circuiting all requests in this state. After a configured duration, state transits from `OPEN` to `HALF_OPEN`, in which a limited number of requests are permitted to pass through the CircuitBreaker while other requests are still short-circuited, and state transit to `CLOSED` or `OPEN` based on the results of the permitted requests. | ||
|
|
||
| ### mesh.MonitorCert | ||
| When `CLOSED`, the CircuitBreaker uses a sliding window to store and aggregate the result of recent requests, the window can either be `COUNT_BASED` or `TIME_BASED`. The `COUNT_BASED` window aggregates the last N requests and the `TIME_BASED` window aggregates requests in the last N seconds, where N is the window size. | ||
|
|
||
| Below is an example configuration with both `COUNT_BASED` and `TIME_BASED` policies. Policy `circuit-breaker-example-count` short-circuits requests if more than half of recent requests failed. | ||
|
|
||
| Policy `circuit-breaker-example-time` short-circuits requests if more than 60% of recent requests failed. | ||
|
|
||
| > failed means that backend filter returns non-empty results. | ||
|
|
||
| ```yaml | ||
| kind: CircuitBreaker | ||
| name: circuit-breaker-example-count | ||
| slidingWindowType: COUNT_BASED | ||
| failureRateThreshold: 50 | ||
| slidingWindowSize: 100 | ||
|
|
||
| --- | ||
| kind: CircuitBreaker | ||
| name: circuit-breaker-example-time | ||
| slidingWindowType: TIME_BASED | ||
| failureRateThreshold: 60 | ||
| slidingWindowSize: 100 | ||
| ``` |
There was a problem hiding this comment.
please refer https://github.com/megaease/easegress/blob/663a08344cc64fe6194c3fbe454c912e518a5a3a/doc/cookbook/resilience.md#circuit-break to update this part, and please make sure the kind should be CircuitBreak instead of CircuitBreaker.
Co-authored-by: Bomin Zhang <[email protected]>
Co-authored-by: Bomin Zhang <[email protected]>
Co-authored-by: Bomin Zhang <[email protected]>
Co-authored-by: Bomin Zhang <[email protected]>
Co-authored-by: Bomin Zhang <[email protected]>
Co-authored-by: Bomin Zhang <[email protected]>
Co-authored-by: Bomin Zhang <[email protected]>
Co-authored-by: Bomin Zhang <[email protected]>
Co-authored-by: Bomin Zhang <[email protected]>
Codecov Report
@@ Coverage Diff @@
## pipeline #665 +/- ##
===========================================
Coverage ? 78.70%
===========================================
Files ? 93
Lines ? 10098
Branches ? 0
===========================================
Hits ? 7948
Misses ? 1681
Partials ? 469 Continue to review full report at Codecov.
|
localvar
approved these changes
Jun 24, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.