Run an execute, count concurrency or failures. If limits are exceeded then run a fallback
execute
Table 1. Supported parameters
| Parameter |
Required |
Data type |
Details |
| breakConditions |
Yes |
object |
Specify conditions how the circuit breaks |
| execute |
Yes |
array |
Execute to specify the behavior when the circuit is closed |
| fallbackExecute |
Yes |
array |
Execute to specify the default behavior when the circuit is open. Same as
execute. |
| preventHalfOpen |
No |
boolean |
Specify if half open state should be prevented |
| recoveryDuration |
No |
integer |
Seconds to wait before recovering from Open state. If half open is specified duration is
split in half each transition. Value must be greater or equal to 1.0 and lesser or
equal to 86400.0. |
Table 2. Options for
breakConditions
| Parameter |
Required |
Data type |
Details |
| reportedFailures |
Yes |
object |
Count failures reactively |
| reportedFailuresAndConcurrency |
Yes |
object |
Count failures reactively and Count concurrency proactively |
| concurrency |
Yes |
object |
Count concurrency proactively |
Table 3. Nested properties inside
reportedFailures
| Parameter |
Required |
Data type |
Details |
| failureCount |
Yes |
integer |
Max failures reported before breaking the circuit. Value must be greater or equal to
1.0. |
| failureDuration |
Yes |
integer |
Rolling window of seconds to monitor the count. Value must be greater or equal to
1.0. |
Table 4. Nested properties inside
reportedFailuresAndConcurrency
| Parameter |
Required |
Data type |
Details |
| failureCount |
Yes |
integer |
Max failures reported before breaking the circuit. Value must be greater or equal to
1.0. |
| failureDuration |
Yes |
integer |
Rolling window of seconds to monitor the count. Value must be greater or equal to
1.0. |
| maxConcurrentRequests |
Yes |
integer |
Max concurrent requests before breaking the circuit. Value must be greater or equal to
1.0. |
Table 5. Nested properties inside
concurrency
| Parameter |
Required |
Data type |
Details |
| maxConcurrentRequests |
Yes |
integer |
Max concurrent requests before breaking the circuit. Value must be greater or equal to
1.0. |