To set up a circuit breaker on a path for your API, add a new Endpoint in the Endpoint Designer section of your API and then select the Circuit Breaker plugin:
Once the plugin is active, you can set up the various configurations options for the breaker in the drawer by clicking on it:
- Trigger threshold percentage: The percentage of requests that can error before the breaker is tripped, this must be a value between 0.0 and 1.0.
- Sample size (requests): The number of samples to take for a circuit breaker window.
- Return to service in (s): The cool-down period of the breaker to return to service (seconds).