mt-olympus/cerberus

This package is abandoned and no longer maintained. The author suggests using the los/cerberus package instead.

Circuit Breaker pattern implementation in PHP

1.1.0 2016-07-22 14:42 UTC

Requires

• php: ^5.6 || ^7.0
• zendframework/zend-cache: ^2.7
• zendframework/zend-servicemanager: ^2.7 || ^3.0
• zendframework/zend-stdlib: ^2.7 || ^3.0

Requires (Dev)

• phpunit/phpunit: ^5.0
• satooshi/php-coveralls: ~0.6
• squizlabs/php_codesniffer: ^2.3

MIT

• Leandro Silva

README

Introduction

This is a Circuit Breaker pattern implementation in PHP.

This library helps you to handle external services timeouts and outages.

It detects service failures and adapts itself.

You can combine this library with Metis to have a realiable Load Balance service.

Requirements

• PHP >= 5.5
• Zend Cache

Instalation

composer require mt-olympus/cerberus:~1.0

Configuration

You can manually create a Cerberus instance or use a Factory

Factory

If you use a Container Interopt campatible project, you can define a factory:

'factories' => [
    Cerberus\Cerberus::class => Cerberus\Factory::class
],

and copy the configuration file config/cerberus.global.php.dist to your config/autoload/cerberus.global.php and change to your needs.

return [
    'cerberus' => [
        'max_failues' => 5,
        'timeout' => 60,
        'storage' => [
            'adapter' => [
                'name' => 'filesystem',
                'options' => [
                    'cache_dir' => 'data/cache',
                    'namespace' => 'my_project'
                ]
            ],
            'plugins' => [
                // Don't throw exceptions on cache errors
                'exception_handler' => [
                    'throw_exceptions' => false
                ]
            ]
        ]
    ]
];

The maxFailure parameter is the number of failures after which the circuit is opened and the service becomes not available.

When the timeout is reached, the circuit becomes half opened and one attempt is possible and the status is updated.

The storage key is a zend-cache configuration. You can check the official documentation.

The namespace key inside the storage is important. It defines de default namespace for Cerberus cache capabilities. If you choose to call Cerberus methods with service name (see Usage bellow), you can ommit this as it will be ignored.

Manually

You can create a Cerberus instance manually:

$storage = StorageFactory::factory($storageConfig);
$cerberus = new Cerberus($storage, 5, 60);

The $storageConfig is the zend-cache configuration as above.

Usage

The usage is simple. Each time you will access a remote resource (like an Web Service), check for its availability and report its success or failure:

if ($cerberus->isAvailable()) {
    try {
        $http->makeRequest();
        $cerberus->reportSuccess();
    } catch (\Exception $ex) {
        $cerberus->reportFailure();
    }
}

You can use Cerberus to control more than one service. In this scenario, use the methods passing a service name:

if ($cerberus->isAvailable('service-one')) {
    try {
        $http->makeRequest();
        $cerberus->reportSuccess('service-one');
    } catch (\Exception $ex) {
        $cerberus->reportFailure('service-one');
    }
}

if ($cerberus->isAvailable('service-two')) {
    try {
        $http->makeRequest();
        $cerberus->reportSuccess('service-two');
    } catch (\Exception $ex) {
        $cerberus->reportFailure('service-two');
    }
}