metriks-middleware 1.0.0 → 1.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    metriks-middleware (1.0.0)
+    metriks-middleware (1.1.0)
       metriks (~> 0.9.9)
 
 GEM
@@ -11,7 +11,7 @@ GEM
     avl_tree (1.1.3)
     hitimes (1.1.1)
     metaclass (0.0.1)
-    metriks (0.9.9)
+    metriks (0.9.9.1)
       atomic (~> 1.0)
       avl_tree (~> 1.1.2)
       hitimes (~> 1.1)

data/lib/metriks/middleware.rb

@@ -2,7 +2,7 @@ require 'metriks'
 
 module Metriks
   class Middleware
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
 
     def initialize(app, options = {})
       @app  = app
@@ -12,6 +12,7 @@ module Metriks
     def call(env)
       time_response(env) do
         record_heroku_queue_status env
+        record_error_rate env
         call_downstream env
       end
     end
@@ -36,8 +37,22 @@ module Metriks
       Metriks.histogram("#{ @name }.queue.depth").update(queue_depth.to_i) if queue_depth
     end
 
+    def record_error_rate(env)
+      original_callback = env['async.callback']
+      env['async.callback'] = lambda do |env|
+        record_error env.first
+        original_callback.call env
+      end
+    end
+
     def call_downstream(env)
-      @app.call env
+      response = @app.call env
+      record_error response.first
+      response
+    end
+
+    def record_error(status)
+      Metriks.meter("#{ @name }.errors").mark if status >= 500
     end
 
     def response_timer

data/metriks-middleware.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'metriks-middleware'
-  s.version           = '1.0.0'
-  s.date              = '2012-07-02'
+  s.version           = '1.1.0'
+  s.date              = '2012-07-11'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
@@ -57,7 +57,8 @@ Gem::Specification.new do |s|
     Rakefile
     lib/metriks/middleware.rb
     metriks-middleware.gemspec
-    test/metriks-middleware_test.rb
+    test/async_app_test.rb
+    test/sync_app_test.rb
     test/test_helper.rb
   ]
   # = MANIFEST =

data/test/async_app_test.rb

@@ -0,0 +1,125 @@
+require 'test_helper'
+
+require 'metriks/middleware'
+
+class AsyncAppTest < Test::Unit::TestCase
+  class AsyncClose
+    def callback(&block) @callback = block     end
+    def call(*args)      @callback.call(*args) end
+  end
+
+  def setup
+    @async_close    = AsyncClose.new
+    @async_callback = ->(env) do @response = env end
+    @env = { 'async.close' => @async_close, 'async.callback' => @async_callback }
+    @downstream = lambda do |env|
+      env['async.callback'].call [200, {}, ['']]
+      [-1, {}, ['']]
+    end
+  end
+
+  def teardown
+    Metriks::Registry.default.each do |_, metric| metric.clear end
+  end
+
+  def test_calls_downstream
+    downstream = mock
+    response   = stub first: 42
+    downstream.expects(:call).with(@env).returns(response)
+
+    actual_response = Metriks::Middleware.new(downstream).call(@env)
+
+    assert_equal response, actual_response
+  end
+
+  def test_calls_original_callback
+    Metriks::Middleware.new(@downstream).call(@env)
+
+    assert_equal [200, {}, ['']], @response
+  end
+
+  def test_counts_throughput
+    Metriks::Middleware.new(@downstream).call(@env)
+    @async_close.call
+
+    count = Metriks.timer('app').count
+
+    assert_equal 1, count
+  end
+
+  def test_times_downstream_response
+    sleepy_app = ->(env) do
+      sleep 0.1
+      @downstream.call env
+    end
+
+    Metriks::Middleware.new(sleepy_app).call(@env)
+    @async_close.call
+
+    time  = Metriks.timer('app').mean
+
+    assert_in_delta 0.1, time, 0.01
+  end
+
+  def test_records_errors
+    error_sync_app  = lambda do |env| [500, {}, ['']] end
+    error_async_app = lambda do |env|
+      env['async.callback'].call [500, {}, ['']]
+      [-1, {}, ['']]
+    end
+
+    success_sync_app  = lambda do |env| [200, {}, ['']] end
+    success_async_app = lambda do |env|
+      env['async.callback'].call [200, {}, ['']]
+      [-1, {}, ['']]
+    end
+
+    Metriks::Middleware.new(error_sync_app).call(@env.dup)
+    Metriks::Middleware.new(error_async_app).call(@env.dup)
+    Metriks::Middleware.new(success_sync_app).call(@env.dup)
+    Metriks::Middleware.new(success_async_app).call(@env.dup)
+
+    errors = Metriks.meter('app.errors').count
+
+    assert_equal 2, errors
+  end
+
+  def test_omits_queue_metrics
+    Metriks::Middleware.new(@downstream).call(@env)
+    @async_close.call
+
+    wait  = Metriks.histogram('app.queue.wait').mean
+    depth = Metriks.histogram('app.queue.depth').mean
+
+    assert_equal 0, wait
+    assert_equal 0, depth
+  end
+
+  def test_records_heroku_queue_metrics
+    @env.merge! 'HTTP_X_HEROKU_QUEUE_WAIT_TIME' => '42',
+                'HTTP_X_HEROKU_QUEUE_DEPTH'     => '24'
+    Metriks::Middleware.new(@downstream).call(@env)
+    @async_close.call
+
+    wait  = Metriks.histogram('app.queue.wait').mean
+    depth = Metriks.histogram('app.queue.depth').mean
+
+    assert_equal 42, wait
+    assert_equal 24, depth
+  end
+
+  def test_name_merics
+    @env.merge! 'HTTP_X_HEROKU_QUEUE_WAIT_TIME' => '42',
+                'HTTP_X_HEROKU_QUEUE_DEPTH'     => '24'
+    Metriks::Middleware.new(@downstream, name: 'metric-name').call(@env)
+    @async_close.call
+
+    count = Metriks.timer('metric-name').count
+    wait  = Metriks.histogram('metric-name.queue.wait').mean
+    depth = Metriks.histogram('metric-name.queue.depth').mean
+
+    assert_operator count, :>, 0
+    assert_operator wait,  :>, 0
+    assert_operator depth, :>, 0
+  end
+end

data/test/sync_app_test.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+
+require 'metriks/middleware'
+
+class SyncAppTest < Test::Unit::TestCase
+  def setup
+    @env = {}
+    @downstream = lambda do |env| [200, {}, ['']] end
+  end
+
+  def teardown
+    Metriks::Registry.default.each do |_, metric| metric.clear end
+  end
+
+  def sleepy_app
+    lambda do |env|
+      sleep 0.1
+      @downstream.call env
+    end
+  end
+
+  def test_calls_downstream
+    downstream = mock
+    response   = stub first: 200
+    downstream.expects(:call).with(@env).returns(response)
+
+    actual_response = Metriks::Middleware.new(downstream).call(@env)
+
+    assert_equal response, actual_response
+  end
+
+  def test_counts_throughput
+    Metriks::Middleware.new(@downstream).call(@env)
+
+    count = Metriks.timer('app').count
+
+    assert_equal 1, count
+  end
+
+  def test_times_downstream_response
+    Metriks::Middleware.new(sleepy_app).call(@env)
+
+    time = Metriks.timer('app').mean
+
+    assert_in_delta 0.1, time, 0.01
+  end
+
+  def test_records_errors
+    error_app = lambda do |env| [500, {}, ['']] end
+    2.times { Metriks::Middleware.new(error_app).call(@env) }
+    Metriks::Middleware.new(@downstream).call(@env)
+
+    errors = Metriks.meter('app.errors').count
+
+    assert_equal 2, errors
+  end
+
+  def test_omits_queue_metrics
+    Metriks::Middleware.new(@downstream).call(@env)
+
+    wait  = Metriks.histogram('app.queue.wait').mean
+    depth = Metriks.histogram('app.queue.depth').mean
+
+    assert_equal 0, wait
+    assert_equal 0, depth
+  end
+
+  def test_records_heroku_queue_metrics
+    @env.merge! 'HTTP_X_HEROKU_QUEUE_WAIT_TIME' => '42',
+                'HTTP_X_HEROKU_QUEUE_DEPTH'     => '24'
+    Metriks::Middleware.new(@downstream).call(@env)
+
+    wait  = Metriks.histogram('app.queue.wait').mean
+    depth = Metriks.histogram('app.queue.depth').mean
+
+    assert_equal 42, wait
+    assert_equal 24, depth
+  end
+
+  def test_name_merics
+    error_app = lambda do |env| [500, {}, ['']] end
+    @env.merge! 'HTTP_X_HEROKU_QUEUE_WAIT_TIME' => '42',
+                'HTTP_X_HEROKU_QUEUE_DEPTH'     => '24'
+    Metriks::Middleware.new(error_app, name: 'metric-name').call(@env)
+
+    count  = Metriks.timer('metric-name').count
+    errors = Metriks.meter('metric-name.errors').count
+    wait   = Metriks.histogram('metric-name.queue.wait').mean
+    depth  = Metriks.histogram('metric-name.queue.depth').mean
+
+    assert_operator count,  :>, 0
+    assert_operator errors, :>, 0
+    assert_operator wait,   :>, 0
+    assert_operator depth,  :>, 0
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metriks-middleware
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000 Z
+date: 2012-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metriks
@@ -58,7 +58,8 @@ files:
 - Rakefile
 - lib/metriks/middleware.rb
 - metriks-middleware.gemspec
-- test/metriks-middleware_test.rb
+- test/async_app_test.rb
+- test/sync_app_test.rb
 - test/test_helper.rb
 homepage: https://github.com/lmarburger/metriks-middleware
 licenses: []
@@ -86,4 +87,5 @@ signing_key:
 specification_version: 2
 summary: Rack middleware for metriks
 test_files:
-- test/metriks-middleware_test.rb
+- test/async_app_test.rb
+- test/sync_app_test.rb

data/test/metriks-middleware_test.rb

@@ -1,123 +0,0 @@
-require 'test_helper'
-
-require 'metriks/middleware'
-
-class MeterTest < Test::Unit::TestCase
-  def setup
-    @downstream = lambda do |env| end
-    @env = {}
-  end
-
-  def teardown
-    Metriks::Registry.default.each do |_, metric| metric.clear end
-  end
-
-  def sleepy_app
-    lambda do |env| sleep(0.1) end
-  end
-
-  def async_env(deferrable)
-    { 'async.close' => deferrable }
-  end
-
-  def test_calls_downstream
-    downstream = mock
-    response   = stub
-    downstream.expects(:call).with(@env).returns(response)
-    actual_response = Metriks::Middleware.new(downstream).call(@env)
-
-    assert_equal response, actual_response
-  end
-
-  def test_async_app_calls_downstream
-    downstream = mock
-    response   = stub
-
-    deferrable = Object.new
-    def deferrable.callback() yield end
-    env = { 'async.close' => deferrable }
-
-    downstream.expects(:call).with(env).returns(response)
-    actual_response = Metriks::Middleware.new(downstream).call(env)
-
-    assert_equal response, actual_response
-  end
-
-  def test_counts_throughput
-    Metriks::Middleware.new(@downstream).call(@env)
-    count = Metriks.timer('app').count
-
-    assert_equal 1, count
-  end
-
-  def test_times_downstream_response
-    Metriks::Middleware.new(sleepy_app).call(@env)
-    time = Metriks.timer('app').mean
-
-    assert_in_delta 0.1, time, 0.01
-  end
-
-  def test_async_app_stops_timer_on_close
-    deferrable = Object.new
-    def deferrable.callback(&block) @callback = block end
-    def deferrable.call_callback()  @callback.call    end
-    env = { 'async.close' => deferrable }
-
-    Metriks::Middleware.new(sleepy_app).call(env)
-    deferrable.call_callback
-    count = Metriks.timer('app').count
-    time  = Metriks.timer('app').mean
-
-    assert_equal 1, count
-    assert_in_delta 0.1, time, 0.01
-  end
-
-  def test_omits_queue_metrics
-    Metriks::Middleware.new(@downstream).call(@env)
-    wait  = Metriks.histogram('app.queue.wait').mean
-    depth = Metriks.histogram('app.queue.depth').mean
-
-    assert_equal 0, wait
-    assert_equal 0, depth
-  end
-
-  def test_records_heroku_queue
-    env = { 'HTTP_X_HEROKU_QUEUE_WAIT_TIME' => '42',
-            'HTTP_X_HEROKU_QUEUE_DEPTH'     => '24' }
-
-    Metriks::Middleware.new(@downstream).call(env)
-    wait  = Metriks.histogram('app.queue.wait').mean
-    depth = Metriks.histogram('app.queue.depth').mean
-
-    assert_equal 42, wait
-    assert_equal 24, depth
-  end
-
-  def test_async_records_heroku_queue
-    deferrable = Object.new
-    def deferrable.callback() yield end
-    env = { 'async.close' => deferrable,
-            'HTTP_X_HEROKU_QUEUE_WAIT_TIME' => '42',
-            'HTTP_X_HEROKU_QUEUE_DEPTH'     => '24' }
-
-    Metriks::Middleware.new(@downstream).call(env)
-    wait  = Metriks.histogram('app.queue.wait').mean
-    depth = Metriks.histogram('app.queue.depth').mean
-
-    assert_equal 42, wait
-    assert_equal 24, depth
-  end
-
-  def test_name_merics
-    env = { 'HTTP_X_HEROKU_QUEUE_WAIT_TIME' => '42',
-            'HTTP_X_HEROKU_QUEUE_DEPTH'     => '24' }
-    Metriks::Middleware.new(@downstream, name: 'metric-name').call(env)
-    count = Metriks.timer('metric-name').count
-    wait  = Metriks.histogram('metric-name.queue.wait').mean
-    depth = Metriks.histogram('metric-name.queue.depth').mean
-
-    assert_not_nil count
-    assert_not_nil wait
-    assert_not_nil depth
-  end
-end