Overview

Circuit Breaker wraps a protected function call in a circuit breaker object, which monitors for failures. Once the failures reach a certain threshold, the circuit breaker trips, and all further calls to the circuit breaker return with an error, without the protected call being made at all.

Documentation

Description

Circuit Breaker wraps a protected function call in a circuit breaker object, which monitors for failures. Once the failures reach a certain threshold, the circuit breaker trips, and all further calls to the circuit breaker return with an error, without the protected call being made at all. This is to make sure that the consumed integration is not overloaded when the service is unreachable.

Typical usage scenario

The best way to get started is to look at an example. An example can be found in the example folder in the module. It contains a microflow with Call REST action.

You can use the example REST_API microflow by following these steps:

1. Moving REST_API microflow to a custom module
2. Including it in your project
3. Assigning relevant module roles to the microflow

Limitations

• This module currently does not support a multi-instance setup.
• This module is not thread-safe

Dependencies

• Studio Pro 8.12.5 or higher (Mendix 9 compatible)

Configuration

1. Add the module to your project
2. Assign the module roles to relevant user roles
3. Drag & drop the java actions to the microflow
4. [Optional] You can include the pages and the snippet in OverviewPages folder in your project and you can configure the circuit breaker settings in runtime.