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.

Sign up for GitHub

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

Jump to bottom

[Docs] Make quick start samples consistent #1735

Merged
merged 6 commits into from
Oct 28, 2023
Merged

[Docs] Make quick start samples consistent #1735

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
321abac
Update first part of main readme
peter-csala Oct 27, 2023
76d6837
Make the reactive samples consistent
peter-csala Oct 27, 2023
9866f68
Make the proactive samples consistent
peter-csala Oct 27, 2023
513751d
Split options declaration from its usage
peter-csala Oct 27, 2023
fa770f5
Update code samples
peter-csala Oct 27, 2023
e4214e2
Apply suggestions from code review
peter-csala Oct 27, 2023
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
Prev Previous commit
Apply suggestions from code review 
Co-authored-by: Martin Costello <[email protected]>
  • Loading branch information
@peter-csala @martincostello
peter-csala and martincostello committed Oct 27, 2023
commit e4214e25e3a1aae1ff76e5a90360bacf98cfb392
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Polly categorizes resilience strategies into two main groups:
These strategies handle specific exceptions that are thrown, or results that are returned, by the callbacks executed through the strategy.

| Strategy | Premise | AKA | Mitigation |
| ------------- | ------------- |:-------------: |------------- |
| ------------- | ------------- | -------------- | ------------ |
|[**Retry** family](#retry) |Many faults are transient and may self-correct after a short delay.| *Maybe it's just a blip* | Allows configuring automatic retries. |
|[**Circuit-breaker** family](#circuit-breaker)|When a system is seriously struggling, failing fast is better than making users/callers wait. <br/><br/>Protecting a faulting system from overload can help it recover. | *Stop doing it if it hurts* <br/><br/>*Give that system a break* | Breaks the circuit (blocks executions) for a period, when faults exceed some pre-configured threshold. |
|[**Fallback**](#fallback)|Things will still fail - plan what you will do when that happens.| *Degrade gracefully* |Defines an alternative value to be returned (or action to be executed) on failure. |
Expand All @@ -114,7 +114,7 @@ These strategies handle specific exceptions that are thrown, or results that are
Unlike reactive strategies, proactive strategies do not focus on handling errors by the callbacks might throw or return. They can make pro-active decisions to cancel or reject the execution of callbacks.

| Strategy | Premise | AKA | Prevention |
|-------------| ------------- |:-------------: |------------- |
| ----------- | ------------- | -------------- | ------------ |
|[**Timeout**](#timeout)|Beyond a certain wait, a success result is unlikely.| *Don't wait forever* |Guarantees the caller won't have to wait beyond the timeout. |
|[**Rate Limiter**](#rate-limiter)|Limiting the rate a system handles requests is another way to control load. <br/> <br/> This can apply to the way your system accepts incoming calls, and/or to the way you call downstream services. | *Slow down a bit, will you?* |Constrains executions to not exceed a certain rate. |

Expand Down