lemonde/php-circuit-breaker-bundle

Circuit breaker to symfony

php-circuit-breaker-bundle

, _(*1)

Description

Everything is MIT licensed and unsupported unless otherwise stated. Use at your own risk., _(*2)

Implement circuit breaker pattern see here http://martinfowler.com/bliki/CircuitBreaker.html., _(*3)

You can find explanation in french here https://medium.com/eleven-labs/le-circuit-breaker-k%C3%A9sako-4763e13a4a03, _(*4)

How to install ?

Requirements

• >=PHP 7
• use LoggerInterface
• use CacheInterface

composer require lemonde/php-circuit-breaker-bundle:lastest

Add in your AppKernel.php, _(*5)

public function registerBundles()
    {
        $bundles = [
            ....
            new CircuitBreakerBundle\CircuitBreakerBundle(),
        ];

        return $bundles;
    }

Add in your config.yml, _(*6)

circuit_breaker:
    # Number fail possible in circuit breaker
    threshold: 5
    # Time in seconds resend call after circuit breaker is open
    timeout: 20

And add config to CacheInterface in your config.yml, _(*7)

framework:
    cache:
        app: cache.adapter.filesystem

How to use ?

Before your service's call, _(*8)

if ($this->get('circuit.breaker')->isOpen('your-service')) {
    // If service is down
}

You need to send status on service to each call, _(*9)

// $status is bool
$this->get('dispatcher')->dispatch('circuit.breaker', new CircuitBreakerEvent('your-service', $status));

How to contribute ?

You can add issue, and create pull request. https://github.com/lemonde/php-circuit-breaker-bundle/blob/master/.github/CONTRIBUTING.md, _(*10)