resilient 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cebeacad55c7a80623379752b452f9a20dd0009
-  data.tar.gz: 9d56f7dc8b598304b8f2aea2e6c46a743f0820f2
+  metadata.gz: 81aab488be171ccf0e6f8418c1d97e81b2fa708a
+  data.tar.gz: dffce71c386d7dae85c2f18a43985aad026c4402
 SHA512:
-  metadata.gz: 63d8cb0a2f6d784573a22df49b407530ebbbe8e8cc534c678ff92d89f749e62ab9c906eb17ad490aad92ede7bf5f8bbeffa0a8e265f801b29a20131804d28647
-  data.tar.gz: 02023b4a9de5bb484fb732c28e11538aa33f0a6ee01e84bff4d1f5c85ae483886e6d1171af99a86eeebbaa5256909f0cce0a4213e4f6d24144e330566b0c6374
+  metadata.gz: 082c69397be74dca6885167e4167822bcf4f0474e7945cf8bd95e3c687d624ed8905e4c048688230b014d72548da33625459be364ad82d79c71b8f02c21cd907
+  data.tar.gz: 1d25aeecb4829d3684309837d8c775bb21ded3f7952bed7c6e28277ff20be6988c2296211a2fb0ffa85ce5f51988fa522966c2389f22701b8f3602826d13eff5

data/README.md

@@ -63,7 +63,7 @@ circuit_breaker = Resilient::CircuitBreaker.new(properties: properties, key: Res
 # etc etc etc
 ```
 
-force the circuit to be always closed:
+force the circuit to be always closed (great way to test in production with no impact, all instrumentation still runs which means you can measure in production with config and gain confidence while never actually opening a circuit incorrectly):
 
 ```ruby
 properties = Resilient::CircuitBreaker::Properties.new(force_closed: true)

data/lib/resilient/circuit_breaker.rb

@@ -34,45 +34,27 @@ module Resilient
     end
 
     def allow_request?
-      default_payload = {
-        key: @key,
-        force_open: false,
-        force_closed: false,
-      }
-
-      instrument("resilient.circuit_breaker.allow_request", default_payload) { |payload|
-        result = if payload[:force_open] = @properties.force_open
+      instrument("resilient.circuit_breaker.allow_request", key: @key) { |payload|
+        payload[:result] = if payload[:force_open] = @properties.force_open
           false
         else
-          if payload[:force_closed] = @properties.force_closed
-            # we still want to simulate normal behavior/metrics like open, allow
-            # single request, etc. so it is possible to test properties in
-            # production without impact
-            if payload[:open] = open?
-              payload[:allow_single_request] = allow_single_request?
-            end
+          # we still want to simulate normal behavior/metrics like open, allow
+          # single request, etc. so it is possible to test properties in
+          # production without impact using force_closed so we run these here
+          # instead of in the else below
+          allow_request = !open? || allow_single_request?
 
+          if payload[:force_closed] = @properties.force_closed
             true
           else
-            if !(payload[:open] = open?)
-              true
-            else
-              payload[:allow_single_request] = allow_single_request?
-            end
+            allow_request
           end
         end
-
-        payload[:result] = result
       }
     end
 
     def success
-      default_payload = {
-        key: @key,
-        closed_the_circuit: false,
-      }
-
-      instrument("resilient.circuit_breaker.success", default_payload) { |payload|
+      instrument("resilient.circuit_breaker.success", key: @key) { |payload|
         if @open
           payload[:closed_the_circuit] = true
           close_circuit
@@ -84,22 +66,14 @@ module Resilient
     end
 
     def failure
-      default_payload = {
-        key: @key,
-      }
-
-      instrument("resilient.circuit_breaker.failure", default_payload) { |payload|
+      instrument("resilient.circuit_breaker.failure", key: @key) { |payload|
         @metrics.failure
         nil
       }
     end
 
     def reset
-      default_payload = {
-        key: @key,
-      }
-
-      instrument("resilient.circuit_breaker.reset", default_payload) { |payload|
+      instrument("resilient.circuit_breaker.reset", key: @key) { |payload|
         @open = false
         @opened_or_last_checked_at_epoch = 0
         @metrics.reset
@@ -129,23 +103,35 @@ module Resilient
     end
 
     def open?
-      return true if @open
-      return false if under_request_volume_threshold?
-      return false if under_error_threshold_percentage?
-
-      open_circuit
-      true
+      instrument("resilient.circuit_breaker.open") { |payload|
+        payload[:result] = if @open
+          true
+        else
+          if under_request_volume_threshold?
+            false
+          else
+            if under_error_threshold_percentage?
+              false
+            else
+              open_circuit
+              true
+            end
+          end
+        end
+      }
     end
 
     def allow_single_request?
-      now = Time.now.to_i
+      instrument("resilient.circuit_breaker.allow_single_request") { |payload|
+        now = Time.now.to_i
 
-      if @open && now > (@opened_or_last_checked_at_epoch + @properties.sleep_window_seconds)
-        @opened_or_last_checked_at_epoch = now
-        true
-      else
-        false
-      end
+        payload[:result] = if @open && now > (@opened_or_last_checked_at_epoch + @properties.sleep_window_seconds)
+          @opened_or_last_checked_at_epoch = now
+          true
+        else
+          false
+        end
+      }
     end
 
     def instrument(name, payload = {}, &block)

data/lib/resilient/version.rb

@@ -1,3 +1,3 @@
 module Resilient
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: resilient
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.8'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
 description: 
@@ -59,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -100,17 +100,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: toolkit for resilient ruby apps