expeditor 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ee9877b9a720af63ec3a4163d680e43d734c4b7
-  data.tar.gz: 8707da47bb651151d0c9a2306dcbe237e165cfe5
+  metadata.gz: 06fd643997ffcbbcf94b5243a56f00a31e4788a3
+  data.tar.gz: 6aa12d927eab977c0d0b6c822b78b37877555637
 SHA512:
-  metadata.gz: 7889e85b9081df0c1aecc1039e0b2193224effe67d5169c6c100027714909b4616cb5c913a02d808bdf0e21669cdfd36ea22829dea1eb4bdc09df8dc0a8e95b5
-  data.tar.gz: c36f0c9b174b2043de7da8628afa6379f655d38a57538d99669e5124e24eff5e067ed96ad209e0a25ddc70cdcdaf7171c3de21c9ffbcb99e85ef78c6015b3864
+  metadata.gz: f81815f7920543475b352185f62dca303173988600a16db97b329662f72d6405e14b7efd834b3ff2eb7d393e9eccf3daa4a8eb4072d36997c33cdca2e1f16ea0
+  data.tar.gz: 1623ce5ccf9f6537e6ce87f0b056742dec4d71157c9108aedefbf4fd2924fa41211c50c76d13f8e9bedaa15d25a1192af2fe5d1f2994d2ad4f33cad7719788f6

data/.travis.yml

@@ -2,9 +2,10 @@ language: ruby
 sudo: false
 cache: bundler
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3.0
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
   - ruby-head
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -1,7 +1,10 @@
-<!-- ## Master (unreleased) -->
+## 0.6.0
+- Improve default configuration of circuit breaker [#25](https://github.com/cookpad/expeditor/pull/25)
+  - Default `non_break_count` is reduced from 100 to 20
+- Return proper status of service [#26](https://github.com/cookpad/expeditor/pull/26)
+  - Use `Expeditor::Service#status` instead of `#current_status`
 
 ## 0.5.0
-
 - Add a `current_thread` option of `Expeditor::Command#start` method to execute a task on current thread [#13](https://github.com/cookpad/expeditor/pull/13)
 - Drop support for MRI 2.0.x [#15](https://github.com/cookpad/expeditor/pull/15)
 - Deprecate Expeditor::Command#with_fallback. Use `set_fallback` instead [#14](https://github.com/cookpad/expeditor/pull/14)

data/README.md

@@ -126,20 +126,29 @@ command = Expeditor::Command.new(service: service) do
   ...
 end
 
-service.current_status
+service.status
 # => #<Expeditor::Status:0x007fdeeeb18468 @break=0, @dependency=0, @failure=0, @rejection=0, @success=0, @timeout=0>
 
 service.reset_status!  # reset status in the service
 ```
 
 ### circuit breaker
+The circuit breaker needs a service metrics (success, failure, timeout, ...) to decide open the circuit or not.
+Expeditor's circuit breaker has a few configuration for how it collects service metrics and how it opens the circuit.
+
+For service metrics, Expeditor collects them with the given time window.
+The metrics is guradually collected by breaking given time window into some peice of short time windows and resetting previous metrics when passing each short time window.
+
+`non_break_count` is used to ignore requests to the service which is not frequentlly requested. Configure this value considering your estimated "requests per period to the service".
+For example, when `period = 10` and `non_break_count = 20` and the requests do not occur more than 20 per 10 seconds, the circuit never opens because Expeditor ignores that "small number of requests".
+If you don't ignore the failures in that case, set `non_break_count` to smaller value than `20`.
 
 ```ruby
 service = Expeditor::Service.new(
-  period: 10,          # retention period of the service metrics (success, failure, timeout, ...)
-  sleep: 1,            # if once the circuit is opened, the circuit is still open until sleep time is passed even though failure rate is less than threshold
-  threshold: 0.5,      # if the failure rate is more than or equal to threshold, the circuit is opened
-  non_break_count: 100 # if the total count of metrics is not more than non_break_count, the circuit is not opened even though failure rate is more than threshold
+  threshold: 0.5,     # If the failure rate is more than or equal to threshold, the circuit will be opened.
+  sleep: 1,           # If once the circuit is opened, the circuit is still open until sleep time seconds is passed even though failure rate is less than threshold.
+  non_break_count: 20 # If the total count of metrics is not more than non_break_count, the circuit is not opened even though failure rate is more than threshold.
+  period: 10,         # Time window of collecting metrics (in seconds).
 )
 
 command = Expeditor::Command.new(service: service) do

data/examples/circuit_breaker.rb

@@ -0,0 +1,27 @@
+require 'expeditor'
+
+service = Expeditor::Service.new
+
+i = 1
+loop do
+  puts '=' * 100
+  p i
+
+  command = Expeditor::Command.new(service: service, timeout: 1) {
+    sleep 0.001 # simulate remote resource access
+    if File.exist?('foo')
+      'result'
+    else
+      raise 'Demo error'
+    end
+  }.set_fallback { |e|
+    p e
+    'default value'
+  }.start
+
+  p command.get
+  p service.status
+  puts
+
+  i += 1
+end

data/lib/expeditor/bucket.rb

@@ -1,6 +1,12 @@
 require 'expeditor/status'
 
 module Expeditor
+  # Bucket is a data structure like circular buffer. It holds some status
+  # objects and it rolls statuses each `per` time (default is 1 second). Once
+  # it reaches the end of statuses array, it backs to start of statuses array
+  # and then reset the status and resumes recording. This is done so that the
+  # statistics are recorded gradually with short time interval rahter than
+  # reset all the record every wide time range (default is 10 seconds).
   class Bucket
     def initialize(opts = {})
       @mutex = Mutex.new
@@ -23,14 +29,14 @@ module Expeditor
     def total
       acc = @mutex.synchronize do
         update
-        @statuses.inject([0, 0, 0, 0, 0, 0]) do |acc, s|
-          acc[0] += s.success
-          acc[1] += s.failure
-          acc[2] += s.rejection
-          acc[3] += s.timeout
-          acc[4] += s.break
-          acc[5] += s.dependency
-          acc
+        @statuses.inject([0, 0, 0, 0, 0, 0]) do |i, s|
+          i[0] += s.success
+          i[1] += s.failure
+          i[2] += s.rejection
+          i[3] += s.timeout
+          i[4] += s.break
+          i[5] += s.dependency
+          i
         end
       end
       status = Expeditor::Status.new

data/lib/expeditor/command.rb

@@ -238,7 +238,11 @@ module Expeditor
           if @fallback_block
             future = RichFuture.new(executor: executor) do
               success, value, reason = Concurrent::SafeTaskExecutor.new(@fallback_block, rescue_exception: true).execute(reason)
-              @ivar.send(:complete, success, value, reason)
+              if success
+                @ivar.set(value)
+              else
+                @ivar.fail(reason)
+              end
             end
             future.safe_execute
           else

data/lib/expeditor/service.rb

@@ -7,8 +7,8 @@ module Expeditor
 
     def initialize(opts = {})
       @executor = opts.fetch(:executor) { Concurrent::ThreadPoolExecutor.new }
-      @threshold = opts.fetch(:threshold, 0.5) # is 0.5 ok?
-      @non_break_count = opts.fetch(:non_break_count, 100) # is 100 ok?
+      @threshold = opts.fetch(:threshold, 0.5)
+      @non_break_count = opts.fetch(:non_break_count, 20)
       @sleep = opts.fetch(:sleep, 1)
       @bucket_opts = {
         size: 10,
@@ -70,7 +70,13 @@ module Expeditor
       @executor.shutdown
     end
 
+    def status
+      @bucket.total
+    end
+
+    # @deprecated
     def current_status
+      warn 'Expeditor::Service#current_status is deprecated. Please use #status instead'
       @bucket.current
     end
 

data/lib/expeditor/version.rb

@@ -1,3 +1,3 @@
 module Expeditor
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expeditor
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - shohei-yasutake
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2017-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -111,6 +111,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/circuit_breaker.rb
 - examples/example.rb
 - expeditor.gemspec
 - lib/expeditor.rb
@@ -143,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Expeditor provides asynchronous execution and fault tolerance for microservices