[Do not merge] EDU-3626: Add docs for Nexus circuit breaker #3220
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
rodrigozhou
commented
Nov 26, 2024
Comment on lines
149
to
158
| ### Circuit Breaker {#circuit-breaker} | ||
|
|
||
| The circuit breaker kicks in when requests fail with a [retryable error](https://github.com/temporalio/temporal/blob/13d6cd8cf7a4ba0c4660cf98f672bbd645dca3e7/components/nexusoperations/executors.go#L659) | ||
| consecutively as it might indicate that the destination (eg: Nexus service to start operation, or | ||
| the caller for callback request) is down or unable to process the request. The default behavior of | ||
| the circuit breaker is to open after 5 consecutive failed requests. Once in open state, Nexus taskk | ||
| will fail early and requests won't be sent to destination. After a minute in open state, it will | ||
| change to half-open state, which will allow only 1 request to be made. If the request is successful, | ||
| then the circuit breaker changes its state to closed, and allows all requests to pass through. | ||
|
|
There was a problem hiding this comment.
This is the only change I made, all other changes was yarn build.
bergundy
reviewed
Nov 27, 2024
fairlydurable
changed the title
| @@ -336,7 +335,7 @@ const workerOptions = { | |||
| tuner: { | |||
| tunerOptions: resourceBasedTunerOptions, | |||
| }, | |||
| } | |||
| }; | |||
There was a problem hiding this comment.
nit. No space between brace and next comment?
There was a problem hiding this comment.
What did you mean? Currently, there are no spaces, you want me to add?
There was a problem hiding this comment.
It's just a code style nit. Feel free to ignore.
|
@prasek This has you listed as a reviewer. I'm going to unblock the ticket. @rodrigozhou Please let me know when you're ready to merge. |
fairlydurable
approved these changes
Dec 5, 2024
There was a problem hiding this comment.
Technical and style issues addressed. Giving @prasek to have a pass if needed.
Unblocking.
fairlydurable
added
the
blocked-on-release
fairlydurable
changed the title
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.
What does this PR do?
Add docs for Nexus circuit breaker
Notes to reviewers