Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update circuitbreaker.md #1524

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/main/paradox/common/circuitbreaker.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ The Apache Pekko library provides an implementation of a circuit breaker called

![circuit-breaker-states.png](../images/circuit-breaker-states.png)

## Challenges
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution. I must admit that I don't think this new paragraph adds anything. The text is not specific to Pekko. I'm not against updating the docs but I'd prefer to see high level info about the Circuit Breaker pattern appear in external docs and we can link to those as a 'Suggested Reading' section.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for feedback. Sounds good but can you please suggest some external docs where I can make this change? Because I'm not aware of any authoritative and editable docs that explains circuit breaker. Many specific-technology pages explain this pattern but don't tell about its challenge. So editing pages like this are my effort to address this issue.

FYI, I've already added this to Wikipedia page and soon I'll make PR to Azure's


Circuit breakers can misinterpret a partial failure as total system failure and inadvertently bring down the entire system. In particular, sharded systems and cell-based architectures are vulnerable to this issue. A workaround is that the server indicates to the client which specific part is overloaded and the client uses a corresponding mini circuit breaker. However, this workaround can be complex and expensive.

## Examples

### Initialization
Expand Down