resilient 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 099b9fa420d5b51a3b258c584b730fe03830a882
-  data.tar.gz: 1e977d958f1b55fe8e96ca833f08961ff19c1ad4
+  metadata.gz: a7441e56169aaa25eeeb4e40a73901f939e3af2d
+  data.tar.gz: 04f4f827c3fc3de69439b40590ab1c3615e43376
 SHA512:
-  metadata.gz: 227075bb296e259d107a45247ca95b84364717e6d341d1df5223e3f4729f9ee629835f776777d42547c2cf5a90e8d8ffb401eebd79c8b527992cc9e85baeeee4
-  data.tar.gz: 7ffa39266ff521fa573e5196c1a576afd2d530f1ac11eb51522290f2300eddd0d704a6511cf75c90eca14bebd2b68bfe68b5b5f774cd55a2e96aa63df05d155d
+  metadata.gz: e54a1abc95f5ba114b2eb4064a2d8f0190014268c7061a6869bc7811278f075331ec13cfa5758738be1690e427cfc38ca768d5f34f2258007eece41b9fc707e6
+  data.tar.gz: bf752309fd26f431ae9c04b7dffeb68827bb05835afee1b2beed0548ecbd70333ce53c7983e2855bb2c5ae2bcdfd1f1ce1b70849c03c609f67fe061e31a9cf77

data/.travis.yml

@@ -4,4 +4,5 @@ rvm:
   - 2.1.4
   - 2.2.3
 before_install: gem install bundler -v 1.10.6
+bundler_args: --without=development
 script: script/test

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.5.0
+
+* [tweaked interface for metrics](https://github.com/jnunemaker/resilient/pull/15)
+* [stop rounding error percentage](https://github.com/jnunemaker/resilient/commit/6cdade5c3fc5f75a6ffde87082771608d582026c)
+
+## prior to 0.5.0
+
+* No changelog kept so just checkout the commits. There aren't too terrible many.

data/Gemfile

@@ -1,5 +1,10 @@
 source "https://rubygems.org"
 gemspec
 
-gem "guard", "~> 2.13.0"
-gem "guard-minitest", "~> 2.4.4"
+gem "timecop", "~> 0.8"
+gem "minitest", "~> 5.8"
+
+group :development do
+  gem "guard", "~> 2.13.0"
+  gem "guard-minitest", "~> 2.4.4"
+end

data/README.md

@@ -82,6 +82,20 @@ circuit_breaker = Resilient::CircuitBreaker.get("example", {
 # etc etc etc
 ```
 
+## Default Properties
+
+Property                        | Default                | Notes
+--------------------------------|------------------------|--------
+**:force_open**                 | false                  | allows forcing the circuit open (stopping all requests)
+**:force_closed**               | false                  | allows ignoring errors and therefore never trip "open" (ie. allow all traffic through); normal instrumentation will still happen, thus allowing you to "test" configuration live without impact
+**:instrumenter**               | Instrumenters::Noop    | what to use to instrument all events that happen (ie: ActiveSupport::Notifications)
+**:sleep_window_seconds**       | 5                      | seconds after tripping circuit before allowing retry
+**:request_volume_threshold**   | 20                     | number of requests that must be made within a statistical window before open/close decisions are made using stats
+**:error_threshold_percentage** | 50                     |  % of "marks" that must be failed to trip the circuit
+**:window_size_in_seconds**     | 60                     | number of seconds in the statistical window
+**:bucket_size_in_seconds**     | 10                     | size of buckets in statistical window
+**:metrics**                    | Resilient::Metrics.new | metrics instance used to keep track of success and failure
+
 ## Tests
 
 To ensure that you have clean circuit breakers for each test case, be sure to run the following in the setup for your tests (which resets the default registry and thus clears all the registered circuits) either before every test case or at a minimum each test case that uses circuit breakers.

data/examples/binary.rb

@@ -0,0 +1,114 @@
+# setting up load path
+require "pathname"
+root_path = Pathname(__FILE__).dirname.join("..").expand_path
+lib_path  = root_path.join("lib")
+$:.unshift(lib_path)
+
+# requiring stuff for this example
+require "pp"
+require "minitest/autorun"
+require "resilient/circuit_breaker"
+require "resilient/test/metrics_interface"
+
+# Metrics class that closes circuit on every success call and opens circuit for
+# sleep_window_seconds on every failure.
+class BinaryMetrics
+  def initialize(options = {})
+    reset
+  end
+
+  def success
+    reset
+    nil
+  end
+
+  def failure
+    @closed = false
+    nil
+  end
+
+  def reset
+    @closed = true
+    nil
+  end
+
+  def under_request_volume_threshold?(request_volume_threshold)
+    false
+  end
+
+  def under_error_threshold_percentage?(error_threshold_percentage)
+    @closed
+  end
+end
+
+class BinaryMetricsTest < Minitest::Test
+  def setup
+    @object = BinaryMetrics.new
+  end
+
+  include Resilient::Test::MetricsInterface
+end
+
+circuit_breaker = Resilient::CircuitBreaker.get("example", {
+  sleep_window_seconds: 1,
+  metrics: BinaryMetrics.new,
+})
+
+# success
+if circuit_breaker.allow_request?
+  begin
+    puts "do expensive thing"
+    circuit_breaker.success
+  rescue => boom
+    # won't get here in this example
+    circuit_breaker.failure
+  end
+else
+  raise "will not get here"
+end
+
+# failure
+if circuit_breaker.allow_request?
+  begin
+    raise
+  rescue => boom
+    circuit_breaker.failure
+    puts "failed slow, do fallback"
+  end
+else
+  raise "will not get here"
+end
+
+# fail fast
+if circuit_breaker.allow_request?
+  raise "will not get here"
+else
+  puts "failed fast, do fallback"
+end
+
+start = Time.now
+
+while (Time.now - start) < 3
+  if circuit_breaker.allow_request?
+    puts "doing a single attempt as we've failed fast for sleep_window_seconds"
+    break
+  else
+    puts "failed fast, do fallback"
+  end
+  sleep rand(0.1)
+end
+
+if circuit_breaker.allow_request?
+  raise "will not get here"
+else
+  puts "request denied because single request has not been marked success yet"
+end
+
+puts "marking single request as success"
+circuit_breaker.success
+
+if circuit_breaker.allow_request?
+  puts "circuit reset and back closed now, allowing requests"
+else
+  raise "will not get here"
+end

data/lib/resilient/circuit_breaker.rb

@@ -117,11 +117,11 @@ module Resilient
     end
 
     def under_request_volume_threshold?
-      metrics.requests < @properties.request_volume_threshold
+      metrics.under_request_volume_threshold?(@properties.request_volume_threshold)
     end
 
     def under_error_threshold_percentage?
-      metrics.error_percentage < @properties.error_threshold_percentage
+      metrics.under_error_threshold_percentage?(@properties.error_threshold_percentage)
     end
 
     def open?

data/lib/resilient/circuit_breaker/metrics.rb

@@ -30,6 +30,14 @@ module Resilient
         @buckets = []
       end
 
+      def under_request_volume_threshold?(request_volume_threshold)
+        requests < request_volume_threshold
+      end
+
+      def under_error_threshold_percentage?(error_threshold_percentage)
+        error_percentage < error_threshold_percentage
+      end
+
       def success
         @storage.increment(current_bucket, StorageSuccessKeys)
         prune_buckets
@@ -42,15 +50,12 @@ module Resilient
         nil
       end
 
-      def successes
-        prune_buckets
-        @storage.sum(@buckets, :successes)[:successes]
+      def reset
+        @storage.prune(@buckets, StorageKeys)
+        nil
       end
 
-      def failures
-        prune_buckets
-        @storage.sum(@buckets, :failures)[:failures]
-      end
+      private
 
       def requests
         prune_buckets
@@ -71,16 +76,9 @@ module Resilient
         requests = successes + failures
         return 0 if failures == 0 || requests == 0
 
-        ((failures / requests.to_f) * 100).round
+        (failures / requests.to_f) * 100
       end
 
-      def reset
-        @storage.prune(@buckets, StorageKeys)
-        nil
-      end
-
-      private
-
       def current_bucket(timestamp = Time.now.to_i)
         bucket = @buckets.detect { |bucket| bucket.include?(timestamp) }
         return bucket if bucket

data/lib/resilient/test/metrics_interface.rb

@@ -1,6 +1,16 @@
 module Resilient
   class Test
     module MetricsInterface
+      def test_responds_to_under_request_volume_threshold_predicate
+        assert_respond_to @object, :under_request_volume_threshold?
+        assert_equal 1, @object.method(:under_request_volume_threshold?).arity
+      end
+
+      def test_responds_to_under_error_threshold_percentage_predicate
+        assert_respond_to @object, :under_error_threshold_percentage?
+        assert_equal 1, @object.method(:under_error_threshold_percentage?).arity
+      end
+
       def test_responds_to_success
         assert_respond_to @object, :success
       end
@@ -17,22 +27,6 @@ module Resilient
         assert_nil @object.failure
       end
 
-      def test_responds_to_successes
-        assert_respond_to @object, :successes
-      end
-
-      def test_responds_to_failures
-        assert_respond_to @object, :failures
-      end
-
-      def test_responds_to_requests
-        assert_respond_to @object, :requests
-      end
-
-      def test_responds_to_error_percentage
-        assert_respond_to @object, :error_percentage
-      end
-
       def test_responds_to_reset
         assert_respond_to @object, :reset
       end

data/lib/resilient/version.rb

@@ -1,3 +1,3 @@
 module Resilient
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resilient
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2016-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,11 +61,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - examples/basic.rb
+- examples/binary.rb
 - examples/get_vs_new.rb
 - examples/long_running.rb
 - lib/resilient.rb