Laravel Circuit Breaker
A straightforward implementation of the Circuit Breaker pattern for Laravel Framework 9 (using Memcached).
Installation
You can install the package via composer:
composer require leonardovee/laravel-circuit-breaker
You can publish the config file with:
php artisan vendor:publish --tag="circuit-breaker-config"
This is the contents of the published config file:
return [
'memcached-server' => [
'host' => '127.0.0.1',
'port' => 11211
],
'circuit-breaker' => [
'failure-threshold' => 5,
'half-open-timeout' => 5,
'timeout' => 10
]
];
Usage
use LeonardoVee\CircuitBreaker\CircuitBreaker;
try {
/** Make the request to your service */
Http::get('https://my-service.com');
/** Register a success on the circuit breaker */
CircuitBreaker::setSuccess(circuitName: 'https://my-service.com');
} catch (Throwable $throwable) {
/** Register a failure on the circuit breaker */
CircuitBreaker::setFailure(circuitName: 'https://my-service.com');
}
/** Use to verify if the circuit is closed or open */
if (CircuitBreaker::isAvailable(circuitName: 'https://my-service.com')) {
/** Do stuff */
}
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.