metriks-middleware 1.3.0 → 2.0.0

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec

data/lib/metriks/middleware.rb

@@ -2,7 +2,17 @@ require 'metriks'
 
 module Metriks
   class Middleware
-    VERSION = '1.3.0'
+    VERSION = '2.0.0'
+
+    REQUEST_DELAY              = 'request_delay'
+    HEROKU_DYNOS_IN_USE        = 'heroku.dynos_in_use'
+    ERROR_RESPONSE             = 'responses.error'
+    NOT_FOUND_RESPONSE         = 'responses.not_found'
+    NOT_MODIFIED_RESPONSE      = 'responses.not_modified'
+    CONTENT_LENGTH             = 'responses.content_length'
+
+    REQUEST_START_HEADER       = 'HTTP_X_REQUEST_START'
+    HEROKU_DYNOS_IN_USE_HEADER = 'HTTP_X_HEROKU_DYNOS_IN_USE'
 
     def initialize(app)
       @app = app
@@ -10,8 +20,9 @@ module Metriks
 
     def call(env)
       time_response(env) do
-        record_heroku_status env
-        record_error_rate env
+        record_request_delay env
+        record_heroku_dynos_in_use env
+        record_response env
         call_downstream env
       end
     end
@@ -28,20 +39,21 @@ module Metriks
       end
     end
 
-    def record_heroku_status(env)
-      queue_wait   = env['HTTP_X_HEROKU_QUEUE_WAIT_TIME']
-      queue_depth  = env['HTTP_X_HEROKU_QUEUE_DEPTH']
-      dynos_in_use = env['HTTP_X_HEROKU_DYNOS_IN_USE']
+    def record_request_delay(env)
+      delay = duration_since_request_start(env)
+      Metriks.histogram(REQUEST_DELAY).update(delay)
+    end
 
-      Metriks.histogram("queue.wait")  .update(queue_wait.to_i)   if queue_wait
-      Metriks.histogram("queue.depth") .update(queue_depth.to_i)  if queue_depth
-      Metriks.histogram("dynos.in_use").update(dynos_in_use.to_i) if dynos_in_use
+    def record_heroku_dynos_in_use(env)
+      dynos = env[HEROKU_DYNOS_IN_USE_HEADER]
+      return unless dynos
+      Metriks.histogram(HEROKU_DYNOS_IN_USE).update(dynos.to_i)
     end
 
-    def record_error_rate(env)
+    def record_response(env)
       original_callback = env['async.callback']
       env['async.callback'] = lambda do |(status, headers, body)|
-        record_error status
+        record_staus_code status
         record_content_length headers
         original_callback.call [status, headers, body]
       end
@@ -49,30 +61,37 @@ module Metriks
 
     def call_downstream(env)
       status, headers, body = @app.call env
-      record_error status
+      record_staus_code status
       record_content_length headers
 
       [status, headers, body]
     end
 
-    def record_error(status)
+    def record_staus_code(status)
       if status >= 500
-        Metriks.meter("responses.error").mark
+        Metriks.meter(ERROR_RESPONSE).mark
       elsif status == 404
-        Metriks.meter("responses.not_found").mark
+        Metriks.meter(NOT_FOUND_RESPONSE).mark
       elsif status == 304
-        Metriks.meter("responses.not_modified").mark
+        Metriks.meter(NOT_MODIFIED_RESPONSE).mark
       end
     end
 
     def record_content_length(headers)
       content_length = headers.fetch('Content-Length', 0).to_i
       return unless content_length > 0
-      Metriks.histogram('responses.content_length').update(content_length)
+      Metriks.histogram(CONTENT_LENGTH).update(content_length)
     end
 
     def response_timer
       Metriks.timer('app')
     end
+
+    def duration_since_request_start(env)
+      request_start = env[REQUEST_START_HEADER]
+      return 0 unless request_start
+      duration = ((Time.now.to_f * 1_000) - request_start.to_f).round
+      duration > 0 ? duration : 0
+    end
   end
 end

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.3.0'
-  s.date              = '2012-12-11'
+  s.version           = '2.0.0'
+  s.date              = '2013-02-22'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.

data/test/async_app_test.rb

@@ -28,7 +28,6 @@ class AsyncAppTest < Test::Unit::TestCase
     downstream.expects(:call).with(@env).returns(response)
 
     actual_response = Metriks::Middleware.new(downstream).call(@env)
-
     assert_equal response, actual_response
   end
 
@@ -43,7 +42,6 @@ class AsyncAppTest < Test::Unit::TestCase
     @async_close.call
 
     count = Metriks.timer('app').count
-
     assert_equal 1, count
   end
 
@@ -57,7 +55,6 @@ class AsyncAppTest < Test::Unit::TestCase
     @async_close.call
 
     time  = Metriks.timer('app').mean
-
     assert_in_delta 0.1, time, 0.01
   end
 
@@ -97,7 +94,6 @@ class AsyncAppTest < Test::Unit::TestCase
     Metriks::Middleware.new(success_async_app).call(@env.dup)
 
     errors = Metriks.meter('responses.error').count
-
     assert_equal 2, errors
   end
 
@@ -120,7 +116,6 @@ class AsyncAppTest < Test::Unit::TestCase
     Metriks::Middleware.new(success_async_app).call(@env.dup)
 
     not_founds = Metriks.meter('responses.not_found').count
-
     assert_equal 2, not_founds
   end
 
@@ -143,36 +138,48 @@ class AsyncAppTest < Test::Unit::TestCase
     Metriks::Middleware.new(success_async_app).call(@env.dup)
 
     not_modifieds = Metriks.meter('responses.not_modified').count
-
     assert_equal 2, not_modifieds
   end
 
-  def test_omits_queue_metrics
+  def test_omits_request_delay
     Metriks::Middleware.new(@downstream).call(@env)
-    @async_close.call
-
-    wait  = Metriks.histogram('queue.wait').mean
-    depth = Metriks.histogram('queue.depth').mean
-    used  = Metriks.histogram('dynos.in_use').mean
 
-    assert_equal 0, wait
-    assert_equal 0, depth
+    used = Metriks.histogram('request_delay').mean
     assert_equal 0, used
   end
 
-  def test_records_heroku_queue_metrics
-    @env.merge! 'HTTP_X_HEROKU_QUEUE_WAIT_TIME' => '42',
-                'HTTP_X_HEROKU_QUEUE_DEPTH'     => '24',
-                'HTTP_X_HEROKU_DYNOS_IN_USE'    => '3'
+  def test_records_request_delay
+    now   = Time.now.to_f * 1000
+    start = now - 42
+    @env.merge! 'HTTP_X_REQUEST_START' => start.to_s
     Metriks::Middleware.new(@downstream).call(@env)
-    @async_close.call
 
-    wait  = Metriks.histogram('queue.wait').mean
-    depth = Metriks.histogram('queue.depth').mean
-    used  = Metriks.histogram('dynos.in_use').mean
+    delay = Metriks.histogram('request_delay').mean
+    assert_in_delta 42, delay, 1
+  end
+
+  def test_ignores_future_request_start_time
+    now   = Time.now.to_f * 1000
+    start = now + 42
+    @env.merge! 'HTTP_X_REQUEST_START' => start.to_s
+    Metriks::Middleware.new(@downstream).call(@env)
+
+    delay = Metriks.histogram('request_delay').mean
+    assert_equal 0, delay
+  end
+
+  def test_omits_heroku_dynos_in_use
+    Metriks::Middleware.new(@downstream).call(@env)
+
+    used = Metriks.histogram('heroku.dynos_in_use').mean
+    assert_equal 0, used
+  end
+
+  def test_records_heroku_dynos_in_use
+    @env.merge! 'HTTP_X_HEROKU_DYNOS_IN_USE' => '42'
+    Metriks::Middleware.new(@downstream).call(@env)
 
-    assert_equal 42, wait
-    assert_equal 24, depth
-    assert_equal 3,  used
+    dynos = Metriks.histogram('heroku.dynos_in_use').mean
+    assert_equal 42, dynos
   end
 end

data/test/sync_app_test.rb

@@ -25,7 +25,6 @@ class SyncAppTest < Test::Unit::TestCase
     downstream.expects(:call).with(@env).returns(response)
 
     actual_response = Metriks::Middleware.new(downstream).call(@env)
-
     assert_equal response, actual_response
   end
 
@@ -33,7 +32,6 @@ class SyncAppTest < Test::Unit::TestCase
     Metriks::Middleware.new(@downstream).call(@env)
 
     count = Metriks.timer('app').count
-
     assert_equal 1, count
   end
 
@@ -41,7 +39,6 @@ class SyncAppTest < Test::Unit::TestCase
     Metriks::Middleware.new(sleepy_app).call(@env)
 
     time = Metriks.timer('app').mean
-
     assert_in_delta 0.1, time, 0.01
   end
 
@@ -62,7 +59,6 @@ class SyncAppTest < Test::Unit::TestCase
     Metriks::Middleware.new(@downstream).call(@env)
 
     errors = Metriks.meter('responses.error').count
-
     assert_equal 2, errors
   end
 
@@ -72,7 +68,6 @@ class SyncAppTest < Test::Unit::TestCase
     Metriks::Middleware.new(@downstream).call(@env)
 
     not_founds = Metriks.meter('responses.not_found').count
-
     assert_equal 2, not_founds
   end
 
@@ -82,34 +77,48 @@ class SyncAppTest < Test::Unit::TestCase
     Metriks::Middleware.new(@downstream).call(@env)
 
     not_modifieds = Metriks.meter('responses.not_modified').count
-
     assert_equal 2, not_modifieds
   end
 
-  def test_omits_queue_metrics
+  def test_omits_request_delay
     Metriks::Middleware.new(@downstream).call(@env)
 
-    wait  = Metriks.histogram('queue.wait').mean
-    depth = Metriks.histogram('queue.depth').mean
-    used  = Metriks.histogram('dynos.in_use').mean
-
-    assert_equal 0, wait
-    assert_equal 0, depth
+    used = Metriks.histogram('request_delay').mean
     assert_equal 0, used
   end
 
-  def test_records_heroku_queue_metrics
-    @env.merge! 'HTTP_X_HEROKU_QUEUE_WAIT_TIME' => '42',
-                'HTTP_X_HEROKU_QUEUE_DEPTH'     => '24',
-                'HTTP_X_HEROKU_DYNOS_IN_USE'    => '3'
+  def test_records_request_delay
+    now   = Time.now.to_f * 1000
+    start = now - 42
+    @env.merge! 'HTTP_X_REQUEST_START' => start.to_s
     Metriks::Middleware.new(@downstream).call(@env)
 
-    wait  = Metriks.histogram('queue.wait').mean
-    depth = Metriks.histogram('queue.depth').mean
-    used  = Metriks.histogram('dynos.in_use').mean
+    delay = Metriks.histogram('request_delay').mean
+    assert_in_delta 42, delay, 1
+  end
+
+  def test_ignores_future_request_start_time
+    now   = Time.now.to_f * 1000
+    start = now + 42
+    @env.merge! 'HTTP_X_REQUEST_START' => start.to_s
+    Metriks::Middleware.new(@downstream).call(@env)
+
+    delay = Metriks.histogram('request_delay').mean
+    assert_equal 0, delay
+  end
+
+  def test_omits_heroku_dynos_in_use
+    Metriks::Middleware.new(@downstream).call(@env)
+
+    used = Metriks.histogram('heroku.dynos_in_use').mean
+    assert_equal 0, used
+  end
+
+  def test_records_heroku_dynos_in_use
+    @env.merge! 'HTTP_X_HEROKU_DYNOS_IN_USE' => '42'
+    Metriks::Middleware.new(@downstream).call(@env)
 
-    assert_equal 42, wait
-    assert_equal 24, depth
-    assert_equal 3,  used
+    dynos = Metriks.histogram('heroku.dynos_in_use').mean
+    assert_equal 42, dynos
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metriks-middleware
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-11 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metriks
@@ -93,6 +93,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1952576612337173392
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: