Skip to content

ksaveras/circuit-breaker-bundle

Repository files navigation

Circuit Breaker Symfony Bundle

Travis (.org) branch Code Climate maintainability GitHub

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require ksaveras/circuit-breaker-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require ksaveras/circuit-breaker-bundle

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    Ksaveras\CircuitBreakerBundle\KsaverasCircuitBreakerBundle::class => ['all' => true],
];

Configuration

# config/packages/circuit_breaker.yaml
ksaveras_circuit_breaker:
    circuit_breakers:
        cb_name:
            storage: 'cache'
            failure_threshold: 3
            retry_policy:
                exponential:
                    reset_timeout: 60
                    maximum_timeout: 86400

    storage:
        in_memory: ~
        cache: 'pool_service_id'
        my_storage: '@storage_service'