thrifter 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7eda9c8d9e79e117d147b9e6bca186d85c538dc
-  data.tar.gz: b00587a8f32c3690c68f504343b4a650026d0299
+  metadata.gz: 65d98aacd1ca9934a61d232bda0b67412571c0f6
+  data.tar.gz: a932dd7f6d35c006f4b82fbb1c1dcafa28fddb34
 SHA512:
-  metadata.gz: ad10cce350e1a4f0690c39aec5f80cdefa40415309ec19162bdfbd410be8d40bd2af861628215e8de6946271c7e1b945b9eab815722e647b2bb82177fba11e0c
-  data.tar.gz: a156b72b2740ea7f145c5add008ead3212483484ad2020b4e47e3e02ef7b911dfcea0fc9095f7386c81e1a612750f9d11ed52059babe339cde0327183deea041
+  metadata.gz: 46844d62766a667447c0138d60d07746a3d384f11586ff524eda5743de9d1ed804433de8bd18e00bc790c0e7f1493452facecc3c7bc764a58b1a58d14da819bc
+  data.tar.gz: 75b6e393f98b6c0bb4741db90c0663f9d8bbba43f9075035056fd9c912f7f74ac00bb999aa8ab21469ea041869ed1de6ffb9ab75e26f2f593d965f04a378e851

data/Makefile

@@ -20,7 +20,7 @@ $(THRIFT): test.thrift
 $(DOCKER_IMAGES):
 	mkdir -p $(@D)
 	touch $@
-		
+
 $(BUNDLE): Dockerfile thrifter.gemspec $(DOCKER_IMAGES)
 	docker build -t $(BUNDLE_IMAGE) .
 	docker inspect -f '{{ .Id }}' $(BUNDLE_IMAGE) >> $(DOCKER_IMAGES)

data/lib/thrifter.rb

@@ -33,6 +33,10 @@ module Thrifter
     def increment(*)
 
     end
+
+    def gauge(*)
+
+    end
   end
 
   RESERVED_METHODS = [
@@ -148,7 +152,7 @@ module Thrifter
         fail ArgumentError, 'URI did not contain port' unless @uri.port
       end
 
-      @pool = ConnectionPool.new size: config.pool_size.to_i, timeout: config.pool_timeout.to_f do
+      @pool = InstrumentedPool.new(statsd: config.statsd, size: config.pool_size.to_i, timeout: config.pool_timeout.to_f) do
         stack = MiddlewareStack.new
 
         stack.use config.stack
@@ -191,6 +195,8 @@ module Thrifter
   end
 end
 
+require_relative 'thrifter/instrumented_pool'
+
 require_relative 'thrifter/extensions/ping'
 require_relative 'thrifter/extensions/retriable'
 

data/lib/thrifter/extensions/retriable.rb

@@ -41,9 +41,11 @@ module Thrifter
           client.send name, *args
         rescue *retriable => ex
           if counter < tries
+            config.statsd.increment("rpc.#{name}.retry")
             sleep interval
             retry
           else
+            config.statsd.increment("rpc.#{name}.retry")
             raise RetryError.new(tries, name, ex)
           end
         end

data/lib/thrifter/instrumented_pool.rb

@@ -0,0 +1,36 @@
+module Thrifter
+  class InstrumentedPool < ConnectionPool
+    attr_reader :statsd
+
+    def initialize(options = { }, &block)
+      super(options, &block)
+      @statsd = options.fetch(:statsd)
+    end
+
+    def checkout(*args)
+      statsd.gauge('thread_pool.size', @size)
+      statsd.time('thread_pool.latency') do
+        super.tap do |conn|
+          statsd.increment('thread_pool.checkout')
+          statsd.gauge('thread_pool.in_use', in_use)
+        end
+      end
+    rescue Timeout::Error => ex
+      statsd.increment('thread_pool.timeout')
+      raise ex
+    end
+
+    def checkin(*args)
+      super.tap do
+        statsd.increment('thread_pool.checkin')
+        statsd.gauge('thread_pool.in_use', in_use)
+      end
+    end
+
+    private
+
+    def in_use
+      (1 - (@available.length / @size.to_f)).round(2)
+    end
+  end
+end

data/lib/thrifter/middleware/client_metrics.rb

@@ -28,6 +28,10 @@ module Thrifter
       statsd.increment 'rpc.error'
       statsd.increment 'rpc.error.timeout'
       raise ex
+    rescue Thrifter::RetryError  => ex
+      statsd.increment 'rpc.error'
+      statsd.increment 'rpc.error.retry'
+      raise ex
     rescue => ex
       statsd.increment 'rpc.error'
       statsd.increment 'rpc.error.other'

data/lib/thrifter/middleware/rpc_metrics.rb

@@ -77,6 +77,10 @@ module Thrifter
       statsd.increment "rpc.#{rpc.name}.error"
       statsd.increment "rpc.#{rpc.name}.error.timeout"
       raise ex
+    rescue Thrifter::RetryError => ex
+      statsd.increment "rpc.#{rpc.name}.error"
+      statsd.increment "rpc.#{rpc.name}.error.retry"
+      raise ex
     rescue => ex
       statsd.increment "rpc.#{rpc.name}.error"
       statsd.increment "rpc.#{rpc.name}.error.other"

data/lib/thrifter/version.rb

@@ -1,3 +1,3 @@
 module Thrifter
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/test/acceptance_test.rb

@@ -99,7 +99,11 @@ class AcceptanceTest < MiniTest::Unit::TestCase
       config.pool_timeout = 75
     end
 
-    ConnectionPool.expects(:new).with(size: 50, timeout: 75)
+    Thrifter::InstrumentedPool.expects(:new).with({
+      statsd: client.config.statsd,
+      size: 50,
+      timeout: 75
+    })
 
     client.new
   end
@@ -111,7 +115,11 @@ class AcceptanceTest < MiniTest::Unit::TestCase
       config.pool_timeout = '75.5'
     end
 
-    ConnectionPool.expects(:new).with(size: 50, timeout: 75.5)
+    Thrifter::InstrumentedPool.expects(:new).with({
+      statsd: client.config.statsd,
+      size: 50,
+      timeout: 75.5
+    })
 
     client.new
   end

data/test/extensions/retry_test.rb

@@ -14,10 +14,41 @@ class RetryTest < MiniTest::Unit::TestCase
     config.transport = FakeTransport
   end
 
+  class TestStatsd
+    attr_reader :counters
+
+    def initialize
+      @counters = [ ]
+    end
+
+    def increment(counter)
+      @counters << counter
+    end
+
+    def time(*args)
+      yield
+    end
+
+    def gauge(*)
+
+    end
+  end
+
+  attr_reader :statsd
+
   def known_errors
     Thrifter::Retry::DEFAULT_RETRIABLE_ERRORS
   end
 
+  def setup
+    super
+    @statsd = TestStatsd.new
+
+    RetryClient.configure do |config|
+      config.statsd = statsd
+    end
+  end
+
   def test_does_not_retry_on_unexpected_errors
     thrift_client = mock
     thrift_client.expects(:echo).with(:request).raises(JunkError)
@@ -42,6 +73,12 @@ class RetryTest < MiniTest::Unit::TestCase
     result = client.with_retry({ tries: 2, interval: 0.01 }).echo(:request)
 
     assert :response == result, 'return value incorrect'
+
+    counters = statsd.counters.count do |item|
+      item == 'rpc.echo.retry'
+    end
+
+    assert_equal 1, counters, 'Retry not counted'
   end
 
   def test_retries_on_exceptions_specified_explicitly
@@ -88,6 +125,12 @@ class RetryTest < MiniTest::Unit::TestCase
     assert_match /5/, error.message, 'Error not descriptive'
     assert_match /echo/, error.message, 'Error not descriptive'
     assert_match /#{err.to_s}/, error.message, 'Missing error details'
+
+    counters = statsd.counters.count do |item|
+      item == 'rpc.echo.retry'
+    end
+
+    assert_equal 5, counters, 'Retry not counted'
   end
 
   def test_retries_on_application_exception

data/test/instrumented_pool_test.rb

@@ -0,0 +1,117 @@
+require_relative 'test_helper'
+
+class InstrumentedPoolTest < MiniTest::Unit::TestCase
+  class TestStatsd
+    attr_reader :timers, :gauges, :counters
+
+    def initialize
+      @timers = [ ]
+      @gauges = [ ]
+      @counters = [ ]
+    end
+
+    def clear
+      timers.clear
+      gauges.clear
+      counters.clear
+    end
+
+    def time(key)
+      timers << key
+      yield
+    end
+
+    def increment(key, value = 1)
+      counters << [ key, value ]
+    end
+
+    def gauge(key, value)
+      gauges << [ key, value ]
+    end
+  end
+
+  class TimeoutPool < Thrifter::InstrumentedPool
+    class FakeStack
+      def pop(*args)
+        raise Timeout::Error
+      end
+    end
+
+    def initialize(*args, &block)
+      super(*args) { :placeholder }
+      @available = FakeStack.new
+    end
+  end
+
+  attr_reader :pool, :statsd
+
+  def setup
+    super
+
+    @statsd = TestStatsd.new
+    @pool = Thrifter::InstrumentedPool.new(size: 5, timeout: 5, statsd: statsd) do
+      :foo
+    end
+  end
+
+  def test_checkout_instrumentation
+    assert_equal :foo,  pool.checkout, 'Incorrect connection'
+
+    latency = statsd.timers.first
+    assert latency
+    assert_equal 'thread_pool.latency', latency
+
+    counter = statsd.counters[0]
+    assert counter
+    assert_equal 'thread_pool.checkout', counter[0]
+    assert_equal 1, counter[1]
+
+    size = statsd.gauges[0]
+    assert size
+    assert_equal 'thread_pool.size', size[0]
+    assert_equal 5, size[1]
+
+    in_use = statsd.gauges[1]
+    assert in_use
+    assert_equal 'thread_pool.in_use', in_use[0]
+    assert_equal 0.2, in_use[1]
+  end
+
+  def test_checkin_instrumentation
+    assert pool.checkout
+    statsd.clear
+
+    pool.checkin
+
+    counter = statsd.counters[0]
+    assert counter
+    assert_equal 'thread_pool.checkin', counter[0]
+    assert_equal 1, counter[1]
+
+    in_use = statsd.gauges.first
+    assert in_use
+    assert_equal 'thread_pool.in_use', in_use[0]
+    assert_equal 0.0, in_use[1]
+  end
+
+  def test_checkout_timeout_instrumentation
+    @pool = TimeoutPool.new({
+      statsd: statsd,
+      size: 5,
+      timeout: 5
+    })
+
+    assert_raises Timeout::Error do
+      pool.checkout
+    end
+
+    latency = statsd.timers.first
+    assert latency
+    assert_equal 'thread_pool.latency', latency
+
+    counter = statsd.counters.first
+    assert counter
+    assert_equal 'thread_pool.timeout', counter[0]
+    assert_equal 1, counter[1]
+  end
+end

data/test/middleware/client_metrics_test.rb

@@ -92,6 +92,23 @@ class ClientMetricsTest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_counts_retry_failures
+    app = stub
+    app.stubs(:call).with(rpc).raises(Thrifter::RetryError.new(1, 'echo', StandardError.new))
+
+    statsd = mock
+    statsd.expects(:time).yields
+    statsd.expects(:increment).with("rpc.error")
+    statsd.expects(:increment).with("rpc.outgoing")
+    statsd.expects(:increment).with("rpc.error.retry")
+
+    middleware = Thrifter::ClientMetrics.new app, statsd
+
+    assert_raises Thrifter::RetryError  do
+      middleware.call rpc
+    end
+  end
+
   def test_counts_other_errors
     app = stub
     app.stubs(:call).with(rpc).raises(StandardError)

data/test/middleware/rpc_metrics_test.rb

@@ -478,6 +478,23 @@ class RpcMetricsTest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_counts_retry_failures
+    app = stub
+    app.stubs(:call).with(rpc).raises(Thrifter::RetryError.new(1, 'echo', StandardError.new))
+
+    statsd = mock
+    statsd.expects(:time).yields
+    statsd.expects(:increment).with("rpc.#{rpc.name}.error.retry")
+    statsd.expects(:increment).with("rpc.#{rpc.name}.outgoing")
+    statsd.expects(:increment).with("rpc.#{rpc.name}.error")
+
+    middleware = Thrifter::RpcMetrics.new app, statsd
+
+    assert_raises Thrifter::RetryError  do
+      middleware.call rpc
+    end
+  end
+
   def test_counts_other_errors
     app = stub
     app.stubs(:call).with(rpc).raises(StandardError)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thrifter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - ahawkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-29 00:00:00.000000000 Z
+date: 2017-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thrift
@@ -227,6 +227,7 @@ files:
 - lib/thrifter/extensions/ping.rb
 - lib/thrifter/extensions/queueing.rb
 - lib/thrifter/extensions/retriable.rb
+- lib/thrifter/instrumented_pool.rb
 - lib/thrifter/middleware/client_metrics.rb
 - lib/thrifter/middleware/error_wrapping.rb
 - lib/thrifter/middleware/rpc_metrics.rb
@@ -239,6 +240,7 @@ files:
 - test/extensions/ping_test.rb
 - test/extensions/queueing_test.rb
 - test/extensions/retry_test.rb
+- test/instrumented_pool_test.rb
 - test/middleware/client_metrics_test.rb
 - test/middleware/error_wrapping_test.rb
 - test/middleware/rpc_metrics_test.rb
@@ -277,6 +279,7 @@ test_files:
 - test/extensions/ping_test.rb
 - test/extensions/queueing_test.rb
 - test/extensions/retry_test.rb
+- test/instrumented_pool_test.rb
 - test/middleware/client_metrics_test.rb
 - test/middleware/error_wrapping_test.rb
 - test/middleware/rpc_metrics_test.rb