Circuit Breaker

The Circuit Breaker pattern is inspired by the real-world electrical circuit breaker, which is used to detect excessive current draw and fail fast to protect electrical equipment. The software-based circuit breaker works on the same notion, by encapsulating the operation and monitoring it for failures. The Circuit Breaker pattern operates in three states, as illustrated in the following figure:

image

The states are as follows:

  • Closed — When operating successfully.

  • Open — When failure is detected and the breaker opens to short-circuit and fail fast. In this state, the circuit breaker avoids invoking the protected operation and avoids putting additional load on the struggling service.

  • Half Open — After a short period in the open state, an operation is attempted to see whether it can complete successfully, and depending on the outcome, it will transfer to either open or closed state.

The Circuit Breaker EIP supports 4 options which are listed below:

Name Description Default Type

hystrixConfiguration

Configures the circuit breaker to use Hystrix with the given configuration.

HystrixConfigurationDefinition

resilience4jConfiguration

Configures the circuit breaker to use Resilience4j with the given configuration.

Resilience4jConfigurationDefinition

faultToleranceConfiguration

Configures the circuit breaker to use MicroProfile Fault Tolerance with the given configuration.

FaultToleranceConfigurationDefinition

configurationRef

Refers to a circuit breaker configuration (such as hystrix, resillience4j, or microprofile-fault-tolerance) to use for configuring the circuit breaker EIP.

String

Example

Below is an example route showing a circuit breaker endpoint that protects against slow operation by falling back to the in-lined fallback route. By default the timeout request is just 1000ms so the HTTP endpoint has to be fairly quick to succeed.

from("direct:start")
    .circuitBreaker()
        .to("http://fooservice.com/slow")
    .onFallback()
        .transform().constant("Fallback message")
    .end()
    .to("mock:result");

And in XML DSL:

<camelContext xmlns="http://camel.apache.org/schema/spring">
  <route>
    <from uri="direct:start"/>
    <circuitBreaker>
      <to uri="http://fooservice.com/slow"/>
      <onFallback>
        <transform>
          <constant>Fallback message</constant>
        </transform>
      </onFallback>
    </circuitBreaker>
    <to uri="mock:result"/>
  </route>
</camelContext>

CircuitBreaker Implementations

Camel provides three implementations of this pattern:

  • Hystrix - Deprecated: Using the Netflix Hystrix implementation

  • Resilience4j - Using the Resilience4j implementation

  • Fault Tolerance - Using the MicroProfile Fault Tolerance implementation

Back to top