python-circuit

Simple implementation of the Circuit Breaker pattern


License
Apache-2.0
Install
pip install python-circuit==0.1.9

Documentation

Build Status

A circuit breaker according to the logic outline in Michael T. Nygard's great book Release It!.

Read: http://en.wikipedia.org/wiki/Circuit_breaker_design_pattern

The circuit breaker monitors communication with a remote peer and in the case of a high error rate may break the circuit and not allow further communication for a short period. After a while the breaker will let through a single request to probe to see if the peer feels better. If it does, it will close the circuit and allow requests once again. If not, it will open the circuit again.

A CircuitBreakerSet can handle the state for multiple peers at the same time. Use the context method to pick which peer to track. The first argument is used to identify the peer. Make it a string of some kind, since it will be used to identify the peer in logs.

Below is a small example of how the circuit breaker can be used:

import logging
import time

from circuit import CircuitBreakerSet

circuit_breaker = CircuitBreakerSet(time.time, logging.getLogger(
    'circuit-breaker'))
circuit_breaker.handle_error(ValueError)

def fn(circuit_breaker):
    try:
        with circuit_breaker.context('my-remote-peer'):
           raise ValueError('oh no')
    except CircuitOpenError:
        # the circuit was open so we did not even try to communicate
        # with the remote service.
        raise

If you call fn often enough the circuit breaker will open and CircuitOpenError will be raised.

The CircuitBreakerSet class takes a few keyword arguments:

  • time_unit (default 60) -- Number of seconds to sample seconds over.
  • maxfail (default 3) -- Number of seconds that is allowed over a time unit.
  • reset_timeout (default 10) -- Seconds that the circuit is open before going into half-open mode.

It is also possible to create a single instance of a circuit breaker. The circuit.CircuitBreaker class takes the following arguments:

  • clock -- A callable that returns the time in seconds.
  • log -- a logging.Logger object used for logging.
  • error_types -- A list of error types that are treated as errors.
  • maxfail -- Number of seconds that is allowed over a time unit.
  • reset_timeout -- Seconds that the circuit is open before going into half-open mode.
  • time_unit -- Number of seconds to sample seconds over.

Twisted Support

There's also support for using the circuit breaker with Twisted. Note that the circuit breaker still use pythons standard logging framework. Example:

import logger

from circuit import TwistedCircuitBreakerSet

circuit_breaker = TwistedCircuitBreakerSet(reactor, logging.getLogger(
    'circuit-breaker'))

(The TwistedCircuitBreakerSet adds support for defer.returnValue which uses exceptions internally.)

License

Copyright 2012 Edgeware AB.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Thanks