circuitbox 1.1.0 → 2.0.0.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bb9f064a8178b7bfef8be4552f91410d0783acf5
-  data.tar.gz: ca1e8126ff01603f881c351c28c47396a8fa7d97
+SHA256:
+  metadata.gz: fb89d6ef46d73dfa35e7c43181112309aa524979ec1285688cc8cebf8d781bd4
+  data.tar.gz: 735c23115ea5127923c05b84d5b6cfe64193521bcd751639cc6ceab32c6b97ce
 SHA512:
-  metadata.gz: f9e3f74178e1cf6200d5dbbf99925ddb1f235ebf3d287e3c82bd0894d1430b69a4ed062bbaf9afb9cacd5b5707c32cf2dcbd10cd78293b5f438f3b738b956837
-  data.tar.gz: fe2a7be07392bd92a0a9e731550f82f1b4e3c6d2ed21759c25d91776e5734d538bb4e7d5bc33da09edd8de5ea2ccdb731e6e8baa36946ea02a7e908415b5c17e
+  metadata.gz: a29d10725e8a1a36eec12985681cd66b7c2b3303cb996bfe72226674230d7c8ef38b02bb5731665edd49c7922b2a9f0072434a2ab33da7f64713875415071420
+  data.tar.gz: 9a165096e2b0e5fe484c433284a3c0b6658f4b880552602cb57b22fcf3ea540302b3d3a0910b31b8f3e1938259ca6394faefd3bffffc6c40bf3104d8d02564ec

data/README.md

@@ -1,8 +1,8 @@
 # Circuitbox
 
-[![Build Status](https://travis-ci.org/yammer/circuitbox.svg?branch=master)](https://travis-ci.org/yammer/circuitbox) [![Gem Version](https://badge.fury.io/rb/circuitbox.svg)](https://badge.fury.io/rb/circuitbox)
+![Tests](https://github.com/yammer/circuitbox/workflows/Tests/badge.svg) [![Gem Version](https://badge.fury.io/rb/circuitbox.svg)](https://badge.fury.io/rb/circuitbox)
 
-Circuitbox is a Ruby circuit breaker gem. It protects your application from failures of it's service dependencies. It wraps calls to external services and monitors for failures in one minute intervals. Once more than 10 requests have been made with a 50% failure rate, Circuitbox stops sending requests to that failing service for one minute. This helps your application gracefully degrade.
+Circuitbox is a Ruby circuit breaker gem. It protects your application from failures of its service dependencies. It wraps calls to external services and monitors for failures in one minute intervals. Once more than 10 requests have been made with a 50% failure rate, Circuitbox stops sending requests to that failing service for one minute. This helps your application gracefully degrade.
 Resources about the circuit breaker pattern:
 * [http://martinfowler.com/bliki/CircuitBreaker.html](http://martinfowler.com/bliki/CircuitBreaker.html)
 * [https://github.com/Netflix/Hystrix/wiki/How-it-Works#CircuitBreaker](https://github.com/Netflix/Hystrix/wiki/How-it-Works#CircuitBreaker)
@@ -10,13 +10,13 @@ Resources about the circuit breaker pattern:
 ## Usage
 
 ```ruby
-Circuitbox[:your_service] do
+Circuitbox.circuit(:your_service, exceptions: [Net::ReadTimeout]) do
   Net::HTTP.get URI('http://example.com/api/messages')
 end
 ```
 
 Circuitbox will return nil for failed requests and open circuits.
-If your HTTP client has it's own conditions for failure, you can pass an `exceptions` option.
+If your HTTP client has its own conditions for failure, you can pass an `exceptions` option.
 
 ```ruby
 class ExampleServiceClient
@@ -25,50 +25,75 @@ class ExampleServiceClient
   end
 
   def http_get
-    circuit.run do
+    circuit.run(circuitbox_exceptions: false) do
       Zephyr.new("http://example.com").get(200, 1000, "/api/messages")
     end
   end
 end
 ```
 
-Using the `run!` method will throw an exception when the circuit is open or the underlying service fails.
+Using the `run` method will throw an exception when the circuit is open or the underlying service fails.
 
 ```ruby
   def http_get
-    circuit.run! do
+    circuit.run do
       Zephyr.new("http://example.com").get(200, 1000, "/api/messages")
     end
   end
 ```
 
+## Global Configuration
+Circuitbox has defaults for circuit_store, notifier, and logger.
+This can be configured through ```Circuitbox.configure```.
+The circuit cache used by ```Circuitbox.circuit``` will be cleared after running ```Circuitbox.configure```.
+This means when accessing the circuit through ```Circuitbox.circuit``` any custom configuration options should always be given.
+
+Any circuit created manually through ```Circuitbox::CircuitBreaker``` before updating the configuration
+will need to be recreated to pick up the new defaults.
+
+```ruby
+  Circuitbox.configure do |config|
+    config.default_circuit_store = Circuitbox::MemoryStore.new
+    config.default_notifier = Circuitbox::Notifier::Null.new
+    config.default_logger = Rails.logger
+  end
+```
+
 
-## Configuration
+## Per-Circuit Configuration
 
 ```ruby
 class ExampleServiceClient
   def circuit
     Circuitbox.circuit(:your_service, {
+      # exceptions circuitbox tracks for counting failures (required)
       exceptions:       [YourCustomException],
 
       # seconds the circuit stays open once it has passed the error threshold
       sleep_window:     300,
 
-      # number of requests within 1 minute before it calculates error rates
+      # length of interval (in seconds) over which it calculates the error rate
+      time_window:      60,
+
+      # number of requests within `time_window` seconds before it calculates error rates (checked on failures)
       volume_threshold: 10,
 
       # the store you want to use to save the circuit state so it can be
       # tracked, this needs to be Moneta compatible, and support increment
-      cache: Moneta.new(:Memory)
+      # this overrides what is set in the global configuration
+      cache: Circuitbox::MemoryStore.new,
 
-      # exceeding this rate will open the circuit
+      # exceeding this rate will open the circuit (checked on failures)
       error_threshold:  50,
 
-      # seconds before the circuit times out
-      timeout_seconds:  1
-
       # Logger to use
-      logger: Logger.new(STDOUT)
+      # This overrides what is set in the global configuration
+      logger: Logger.new(STDOUT),
+
+      # Customized notifier
+      # overrides the default
+      # this overrides what is set in the global configuration
+      notifier: Notifier.new
     })
   end
 end
@@ -78,29 +103,26 @@ You can also pass a Proc as an option value which will evaluate each time the ci
 
 ```ruby
 Circuitbox.circuit(:yammer, {
-  sleep_window: Proc.new { Configuration.get(:sleep_window) }
+  sleep_window: Proc.new { Configuration.get(:sleep_window) },
+  exceptions: [Net::ReadTimeout]
 })
 ```
 
 ## Circuit Store (:cache)
 
 Holds all the relevant data to trip the circuit if a given number of requests
-fail in a specified period of time. The store is based on
-[Moneta](https://github.com/minad/moneta) so there are a lot of stores to choose
-from. There are some pre-requisits they need to satisfy so:
-
-- Need to support increment, this is true for most but not all available stores.
-- Need to support concurrent access if you share them. For example sharing a
+fail in a specified period of time. Circuitbox also supports
+[Moneta](https://github.com/minad/moneta). As moneta is not a dependency of circuitbox
+it needs to be loaded prior to use. There are a lot of moneta stores to choose from but
+some pre-requisits need to be satisfied first:
+
+- Needs to support increment, this is true for most but not all available stores.
+- Needs to support expiry.
+- Needs to support concurrent access if you share them. For example sharing a
   KyotoCabinet store across process fails because the store is single writer
   multiple readers, and all circuits sharing the store need to be able to write.
 
 
-## Monitoring & Statistics
-
-You can also run `rake circuits:stats SERVICE={service_name}` to see successes, failures and opened circuits.
-Add `PARTITION={partition_key}` to see the circuit for a particular partition.
-The stats are aggregated into 1 minute intervals.
-
 ## Notifications
 
 circuitbox use ActiveSupport Notifications.
@@ -120,7 +142,7 @@ ActiveSupport::Notifications.subscribe('circuit_close') do |name, start, finish,
   circuit_name = payload[:circuit]
   Rails.logger.info("Close circuit for: #{circuit_name}")
 end
-````
+```
 
 **generate metrics:**
 
@@ -139,9 +161,7 @@ end
 
 `payload[:gauge]` can be:
 
-- `failure_count`
-- `success_count`
-- `error_rate`
+- `runtime` # runtime will only be notified when circuit is closed and block is successfully executed.
 
 **warnings:**
 in case of misconfiguration, circuitbox will fire a circuitbox_warning
@@ -156,77 +176,6 @@ end
 
 ```
 
-### Multi process Circuits
-
-`circuit_store` is backed by [Moneta](https://github.com/minad/moneta) which
-supports multiple backends. This can be configured by passing `cache:
-Moneta.new(:PStore, file: "myfile.store")` to use for example the built in
-PStore ruby library for persisted store, which can be shared cross process.
-
-Depending on your requirements different stores can make sense, see the
-benchmarks and [moneta
-feature](https://github.com/minad/moneta#backend-feature-matrix) matrix for
-details.
-
-```
-user     system      total        real
-memory:    1.440000   0.140000   1.580000 (  1.579244)
-lmdb:      4.330000   3.280000   7.610000 ( 13.086398)
-pstore:   23.680000   4.350000  28.030000 ( 28.094312)
-daybreak:  2.270000   0.450000   2.720000 (  2.626748)
-```
-
-You can run the benchmarks yourself by running `rake benchmark`.
-
-### Memory
-
-An in memory store, which is local to the process. This is not threadsafe so it
-is not useable with multithreaded webservers for example. It is always going to
-be the fastest option if no multi-process or thread is required, like in
-development on Webbrick.
-
-This is the default.
-
-```ruby
-Circuitbox.circuit :identifier, cache: Moneta.new(:Memory)
-```
-
-### LMDB
-
-An persisted directory backed store, which is thread and multi process safe.
-depends on the `lmdb` gem. It is slower than Memory or Daybreak, but can be
-used in multi thread and multi process environments like like Puma.
-
-```ruby
-require "lmdb"
-Circuitbox.circuit :identifier, cache: Moneta.new(:LMDB, dir: "./", db: "mydb")
-```
-
-### PStore
-
-An persisted file backed store, which comes with the ruby
-[stdlib](http://ruby-doc.org/stdlib-2.3.0/libdoc/pstore/rdoc/PStore.html). It
-has no external dependecies and works on every ruby implementation. Due to it
-being file backed it is multi process safe, good for development using Unicorn.
-
-```ruby
-Circuitbox.circuit :identifier, cache: Moneta.new(:PStore, file: "db.pstore")
-```
-
-### Daybreak
-
-Persisted, file backed key value store in pure ruby. It is process safe and
-outperforms most other stores in circuitbox. This is recommended for production
-use with Unicorn. It depends on the `daybreak` gem.
-
-```ruby
-require "daybreak"
-Circuitbox.circuit :identifier, cache: Moneta.new(:Daybreak, file: "db.daybreak", expires: true)
-```
-
-It is important for the store to have
-[expires](https://github.com/minad/moneta#backend-feature-matrix) support.
-
 ## Faraday
 
 Circuitbox ships with [Faraday HTTP client](https://github.com/lostisland/faraday) middleware.
@@ -250,24 +199,15 @@ end
 By default the Faraday middleware returns a `503` response when the circuit is
 open, but this as many other things can be configured via middleware options
 
-* `exceptions` pass a list of exceptions for the Circuitbreaker to catch,
-  defaults to Timeout and Request failures
-
-```ruby
-c.use Circuitbox::FaradayMiddleware, exceptions: [Faraday::Error::TimeoutError]
-```
-
 * `default_value` value to return for open circuits, defaults to 503 response
   wrapping the original response given by the service and stored as
   `original_response` property of the returned 503, this can be overwritten
   with either
   * a static value
   * a `lambda` which is passed the `original_response` and `original_error`.
-    `original_response` will be populated if Faraday returne an error response,
+    `original_response` will be populated if Faraday returns an error response,
     `original_error` will be populated if an error was thrown before Faraday
-    returned a response.  (It will also accept a lambda with arity 1 that is
-    only passed `original_response`.  This use is deprecated and will be removed
-    in the next major version.)
+    returned a response.
 
 ```ruby
 c.use Circuitbox::FaradayMiddleware, default_value: lambda { |response, error| ... }
@@ -279,15 +219,9 @@ c.use Circuitbox::FaradayMiddleware, default_value: lambda { |response, error| .
 c.use Circuitbox::FaradayMiddleware, identifier: "service_name_circuit"
 ```
 
-* `circuit_breaker_run_options` options passed to the circuit run method, see
-  the main circuitbreaker for those.
-
-```ruby
-conn.get("/api", circuit_breaker_run_options: {})
-```
-
 * `circuit_breaker_options` options to initialize the circuit with defaults to
-  `{ volume_threshold: 10, exceptions: Circuitbox::FaradayMiddleware::DEFAULT_EXCEPTIONS }`
+  `{ exceptions: Circuitbox::FaradayMiddleware::DEFAULT_EXCEPTIONS }`.
+  Accepts same options as Circuitbox:CircuitBreaker#new
 
 ```ruby
 c.use Circuitbox::FaradayMiddleware, circuit_breaker_options: {}
@@ -300,71 +234,6 @@ c.use Circuitbox::FaradayMiddleware, circuit_breaker_options: {}
 c.use Circuitbox::FaradayMiddleware, open_circuit: lambda { |response| response.status >= 500 }
 ```
 
-## CHANGELOG
-### v1.1.0
-- ruby 2.2 support [#58](https://github.com/yammer/circuitbox/pull/58)
-- configurable logger [#58](https://github.com/yammer/circuitbox/pull/58)
-
-### v1.0.3
-- fix timeout issue for default configuration, as default `:Memory` adapter does
-  not natively support expires, we need to actually load it on demand.
-- fix memoization of `circuit_breaker_options` not actually doing memoization in
-  `excon` and `faraday` middleware.
-
-### v1.0.2
-- Fix timeout issue [#51](https://github.com/yammer/circuitbox/issues/51)
-  [sebastian-juliu](https://github.com/sebastian-julius)
-
-### v1.0.1
-- Fix Rails integration, as version 1.0.0 removed the rails tasks integration, but missed
-  removing the related railtie.
-
-### v1.0.0
-- support for cross process circuitbreakers by swapping the circuitbreaker store for a
-  `Moneta` supported key value store.
-- Change `FaradayMiddleware` default behaviour to not open on `4xx` errors but just on `5xx`
-  server errors and connection errors
-- Remove stat store, which was largely unused
-
-### v0.11.0
-- fix URI require missing (https://github.com/yammer/circuitbox/pull/42 @gottfrois)
-- configurable circuitbox store backend via Moneta supporting multi process circuits
-
-### v0.10.4
-- Issue #39, keep the original backtrace for the wrapped exception around when
-  re-raising a Circuitbox::Error
-
-### v0.10.3
-- Circuitbox::ServiceFailureError wraps the original exception that was raised.
-  The behaviour for to_s wasn't exposing this information and was returning the
-  name of class "Circuitbox::ServiceFailureError". Change the behaviour for to_s
-  to indicate this exception is a wrapper around the original exception.
-  [sherrry](https://github.com/sherrry)
-
-### v0.10.2
-- Faraday middleware passes two arguments to the `default_value` callback, not
-  just one.  First argument is still the error response from Faraday if there is
-  one.  Second argument is the exception that caused the call to fail if it
-  failed before Faraday returned a response.  Old behaviour is preserved if you
-  pass a lambda that takes just one argument, but this is deprecated and will be
-  removed in the next version of Circuitbox.
-  [dwaller](https://github.com/dwaller)
-
-### v0.10.1
-- [Documentation fix](https://github.com/yammer/circuitbox/pull/29) [chiefcll](https://github.com/chiefcll)
-- [Faraday middleware fix](https://github.com/yammer/circuitbox/pull/30) [chiefcll](https://github.com/chiefcll)
-
-### v0.10
-- configuration option for faraday middleware for what should be considered to open the circuit [enrico-scalavio](https://github.com/enrico-scalavino)
-- fix for issue 16, support of in_parallel requests in faraday middlware which were opening the circuit.
-- deprecate the __run_option__ `:storage_key`
-
-### v0.9
-- add `run!` method to raise exception on circuit open and service
-
-### v0.8
-- Everything prior to keeping the change log
-
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/circuitbox.rb

@@ -1,67 +1,24 @@
-require 'uri'
-require 'singleton'
-require 'active_support'
-require 'logger'
-require 'timeout'
-require 'moneta'
+# frozen_string_literal: true
 
-require 'circuitbox/version'
-require 'circuitbox/memcache_store'
-require 'circuitbox/circuit_breaker'
-require 'circuitbox/notifier'
+require 'logger'
 
-require 'circuitbox/errors/error'
-require 'circuitbox/errors/open_circuit_error'
-require 'circuitbox/errors/service_failure_error'
+require_relative 'circuitbox/version'
+require_relative 'circuitbox/circuit_breaker'
+require_relative 'circuitbox/errors/error'
+require_relative 'circuitbox/errors/open_circuit_error'
+require_relative 'circuitbox/errors/service_failure_error'
+require_relative 'circuitbox/configuration'
 
 class Circuitbox
-  attr_accessor :circuits, :circuit_store
-  cattr_accessor :configure
-
-  def self.instance
-    @@instance ||= new
-  end
-
-  def initialize
-    self.instance_eval(&@@configure) if @@configure
-  end
-
-  def self.configure(&block)
-    @@configure = block if block
-  end
-
-  def self.reset
-    @@instance = nil
-    @@configure = nil
-  end
+  class << self
+    include Configuration
 
-  def self.circuit_store
-    self.instance.circuit_store ||= Moneta.new(:Memory, expires: true)
-  end
+    def circuit(service_name, options, &block)
+      circuit = (cached_circuits[service_name] ||= CircuitBreaker.new(service_name, options))
 
-  def self.circuit_store=(store)
-    self.instance.circuit_store = store
-  end
-
-  def self.[](service_identifier, options = {})
-    self.circuit(service_identifier, options)
-  end
+      return circuit unless block
 
-  def self.circuit(service_identifier, options = {})
-    service_name = self.parameter_to_service_name(service_identifier)
-
-    self.instance.circuits ||= Hash.new
-    self.instance.circuits[service_name] ||= CircuitBreaker.new(service_name, options)
-
-    if block_given?
-      self.instance.circuits[service_name].run { yield }
-    else
-      self.instance.circuits[service_name]
+      circuit.run(circuitbox_exceptions: false, &block)
     end
   end
-
-  def self.parameter_to_service_name(param)
-    uri = URI(param.to_s)
-    uri.host.present? ? uri.host : param.to_s
-  end
 end