circuit-breaker: An implementation of the "circuit breaker" pattern to disable repeated calls to a failing system

[ bsd3, library, program, system ] [ Propose Tags ]

Please see the README on GitHub at https://github.com/ChrisCoffey/circuit-breaker#readme


[Skip to Readme]
Versions [faq] 0.1.0.0
Change log ChangeLog.md
Dependencies base (>=4.7 && <5), circuit-breaker, mtl, random, text, time, transformers, unliftio, unliftio-core, unordered-containers [details]
License BSD-3-Clause
Copyright 2019 Chris Coffey
Author Chris Coffey
Maintainer chris@foldl.io
Category System
Home page https://github.com/ChrisCoffey/circuit-breaker#readme
Bug tracker https://github.com/ChrisCoffey/circuit-breaker/issues
Source repo head: git clone https://github.com/ChrisCoffey/circuit-breaker
Uploaded by ChrisCoffey at Sun Mar 24 22:19:04 UTC 2019
Distributions NixOS:0.1.0.0
Executables circuit-breaker-exe
Downloads 173 total (17 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2019-03-24 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for circuit-breaker-0.1.0.0

[back to package description]

circuit-breaker

Circuit breakers are an error handling machine inspired by the circuit breakers used in electrical systems. Just like their namesake, software circuit breakers prevent pushing traffic through a failing component until it has recovered.

As of the current version, all CircuitBreakers use a "leaky bucket" approach to backoffs. In the definition of a circuit breaker, the first Natural argument is the number of milliseconds that need to pass before an error is expunged. Coupled with an error threshold argument, this provides a surprising amount of flexibility for cirucit breakers in the wild, although you'll want to monitor and tune them over time.

Using a circuit breaker

The following short example illustrates how to define a circuit breaker & use it.

testBreaker :: CircuitBreaker "Test" 1000 4
testBreaker = undefined

main :: IO ()
main = do
    -- Initializes the empty storage for all circuit breakers
    cbConf <- initialBreakerState
    -- Perform a bunch of "work". Because we have a 50% failure rate and trigger the breaker after four
    -- errors, this will cause the breaker to disable additional calls.
    forM_ [1..30] $ const . noteError . flip runReaderT cbConf $ withBreaker testBreaker computation

    -- simulating a backoff long enough to decrement the accumulated errors.
    threadDelay 5000000

    noteError . flip runReaderT cbConf $ withBreaker testBreaker computation
    where
        noteError action = print =<< catchAny action (const $ pure (Left Failed))



-- | This computation fails 50% of the time
computation :: ReaderT CircuitBreakerConf IO Int
computation = do
    shouldFail <- liftIO randomIO
    when shouldFail $ error "Failed"
    pure 42

The first thing to notice is that the CircuitBreaker definition exists entirely at the type level. This guarantees that the definition of a particular CircuitBreaker can't somehow change at runtime.

All calls to withBreaker require a CircuitBreakerConf to be present in a reader environment. initialBreakerState simply initializes an empty CircuitBreakerConf to save you the trouble of creating one yourself.

Contributing

PRs and issues are welcome! Please let me know what you think could be improved or submit the patch yourself.

License

MIT