update circuitbreaker document - #1808
#1808Merged
Merged
update circuitbreaker document #1808
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1808 +/- ##
=======================================
Coverage 84.58% 84.58%
=======================================
Files 308 308
Lines 6799 6799
Branches 1049 1049
=======================================
Hits 5751 5751
Misses 839 839
Partials 209 209
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
martincostello
left a comment
Member
There was a problem hiding this comment.
Going through #1776 (comment) looks like just a diagram is needed to complete the suggestions.
## Defaults Align
Update the alignment of the table a bit more.
Contributor
|
@atawLee Do you need some help with the diagram? I can create one if you wish. |
Contributor
Author
Yes, I would really appreciate your help with the diagram. |
Contributor
Here it is: sequenceDiagram
autonumber
actor C as Caller
participant P as Pipeline
participant CB as CircuitBreaker
participant BDG as BreakDurationGenerator
participant D as DecoratedUserCallback
C->>P: Calls ExecuteAsync
P->>CB: Calls ExecuteCore
Note over CB: Closed state
CB->>+D: Invokes
D->>-CB: Fails
Note over CB: Moves to Open state
CB->>+BDG: Calls Generator
BDG->>-CB: Returns calculated <br/> duration
Note over CB: Break duration start
CB->>P: Propagates failure
P->>C: Propagates failure
C->>P: Calls ExecuteAsync
P->>CB: Calls ExecuteCore
CB-->>CB: Rejects request
CB->>P: Throws <br/>BrokenCircuitException
P->>C: Propagates exception
C->>P: Calls ExecuteAsync
P->>CB: Calls ExecuteCore
Note over CB: Break duration end
Note over CB: Moves to HalfOpen state
CB->>+D: Invokes
D->>-CB: Returns result
Note over CB: Moves to Closed state
CB->>P: Returns result
P->>C: Returns result
And the code: Enjoy 💪 |
Member
|
|
Co-authored-by: Martin Costello <martin@martincostello.com>
peter-csala
approved these changes
Dec 14, 2023
martincostello
approved these changes
Dec 14, 2023
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
#1776
Update documentation for the CircuitBreaker's BreakDurationGenerator
Confirm the following