Download the PHP package gabrielanhaia/php-circuit-breaker without Composer
On this page you can find all versions of the php package gabrielanhaia/php-circuit-breaker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gabrielanhaia/php-circuit-breaker
More information about gabrielanhaia/php-circuit-breaker
Files in gabrielanhaia/php-circuit-breaker
Package php-circuit-breaker
Short Description Circuit breaker for microservices developed in PHP.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php-circuit-breaker
PHP Circuit Breaker
Resiliency pattern for PHP microservices. This library implements a circuit breaker using Redis for state tracking. It protects your services from cascading failures by stopping calls to unhealthy dependencies and gradually allowing traffic as they recover.
Learn more about circuit breakers: https://martinfowler.com/bliki/CircuitBreaker.html
Features
- Simple API:
canPass,succeed,failed - Redis-backed state with configurable windows/timeouts
- Pluggable alert hook to notify when circuits open
- PHP 8.1+ native enum for states in v2
Versions
- 2.x (current): PHP 8.1+, native enums, PHPUnit 10, GitHub Actions
- 1.x (legacy): PHP 7.4+/8.0+, uses
eloquent/enumerationand Travis CI
See CHANGELOG for details and migration notes.
Requirements
- PHP 8.1+
- Redis server
ext-redisPHP extension
Install
- v2 (recommended):
composer require gabrielanhaia/php-circuit-breaker:^2.0 - v1 (legacy):
composer require gabrielanhaia/php-circuit-breaker:^1.0
Quick Start
Configuration
exceptions_on(bool): throw when circuit is open (default: false)time_window(int): seconds to track failures (default: 20)time_out_open(int): seconds to keep circuit open (default: 30)time_out_half_open(int): additional seconds before half-open closes (default: 20)total_failures(int): failures within window to open (default: 5)
Circuit State
In v2+, states are represented with a native enum: GabrielAnhaia\PhpCircuitBreaker\CircuitStateEnum with cases OPEN, CLOSED, HALF_OPEN.
You don’t normally need to consume this directly unless you’re writing custom adapters.
Alerts
Implement GabrielAnhaia\PhpCircuitBreaker\Contract\Alert and pass it to CircuitBreaker to receive callbacks when a circuit opens.
Redis Keys
Keys are namespaced per service:
circuit_breaker:{SERVICE}:opencircuit_breaker:{SERVICE}:half_opencircuit_breaker:{SERVICE}:total_failures:*
Migration (1.x → 2.x)
Breaking changes:
- Replace
CircuitState::OPEN()style calls with native enum values if referenced in your code, e.g.CircuitStateEnum::OPEN. CircuitBreakerAdapter::getState(string): CircuitStateEnumnow returns the native enum.
Otherwise, CircuitBreaker public API is unchanged.
Development
- Run tests:
vendor/bin/phpunit --configuration phpunit.xml - GitHub Actions runs on PHP 8.1–8.4
License
MIT
Created by: Gabriel Anhaia — https://www.linkedin.com/in/gabrielanhaia
All versions of php-circuit-breaker with dependencies
ext-redis Version *