metriks-middleware 0.0.1 → 1.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    metriks-middleware (0.0.1)
+    metriks-middleware (1.0.0)
       metriks (~> 0.9.9)
 
 GEM
@@ -10,13 +10,17 @@ GEM
     atomic (1.0.1)
     avl_tree (1.1.3)
     hitimes (1.1.1)
+    metaclass (0.0.1)
     metriks (0.9.9)
       atomic (~> 1.0)
       avl_tree (~> 1.1.2)
       hitimes (~> 1.1)
+    mocha (0.11.4)
+      metaclass (~> 0.0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   metriks-middleware!
+  mocha (~> 0.11.4)

data/Rakefile

@@ -52,7 +52,7 @@ task :default => :test
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.pattern = 'test/**/*_test.rb'
   test.verbose = true
 end
 

data/lib/metriks/middleware.rb

@@ -2,40 +2,38 @@ require 'metriks'
 
 module Metriks
   class Middleware
-    VERSION = '0.0.1'
+    VERSION = '1.0.0'
 
-    def initialize(app, options)
-      @app = app
-      @metric_prefix = options.fetch :metric_prefix, 'app'
+    def initialize(app, options = {})
+      @app  = app
+      @name = options.fetch :name, 'app'
     end
 
     def call(env)
       time_response(env) do
-        record_heroku_status env
+        record_heroku_queue_status env
         call_downstream env
       end
     end
 
   protected
 
-    def time_response(env, &block)
+    def time_response(env, &handle_request)
       if env.has_key? 'async.close'
         context = response_timer.time
         env['async.close'].callback do context.stop end
-        block.call
+        handle_request.call
       else
-        response_timer.time &block
+        response_timer.time &handle_request
       end
     end
 
-    def record_heroku_status(env)
+    def record_heroku_queue_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']
 
-      Metriks.histogram("#{ @metric_prefix }.queue.wait") .update(queue_wait.to_i)   if queue_wait
-      Metriks.histogram("#{ @metric_prefix }.queue.depth").update(queue_depth.to_i)  if queue_depth
-      Metriks.histogram("#{ @metric_prefix }.dynos")      .update(dynos_in_use.to_i) if dynos_in_use
+      Metriks.histogram("#{ @name }.queue.wait") .update(queue_wait.to_i)  if queue_wait
+      Metriks.histogram("#{ @name }.queue.depth").update(queue_depth.to_i) if queue_depth
     end
 
     def call_downstream(env)
@@ -43,7 +41,7 @@ module Metriks
     end
 
     def response_timer
-      Metriks.timer @metric_prefix
+      Metriks.timer(@name)
     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           = '0.0.1'
-  s.date              = '2012-06-30'
+  s.version           = '1.0.0'
+  s.date              = '2012-07-02'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
@@ -43,6 +43,7 @@ Gem::Specification.new do |s|
 
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
+  s.add_development_dependency 'mocha', '~> 0.11.4'
 
   ## Leave this section as-is. It will be automatically generated from the
   ## contents of your Git repository via the gemspec task. DO NOT REMOVE
@@ -56,10 +57,12 @@ Gem::Specification.new do |s|
     Rakefile
     lib/metriks/middleware.rb
     metriks-middleware.gemspec
+    test/metriks-middleware_test.rb
+    test/test_helper.rb
   ]
   # = MANIFEST =
 
   ## Test files will be grabbed from the file list. Make sure the path glob
   ## matches what you actually use.
-  # s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+  s.test_files = s.files.select { |path| path =~ /^test\/.*_test\.rb/ }
 end

data/test/metriks-middleware_test.rb

@@ -0,0 +1,123 @@
+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

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+require 'mocha'
+
+Thread.abort_on_exception = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metriks-middleware
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-30 00:00:00.000000000 Z
+date: 2012-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metriks
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.4
 description: Rack middleware to track throughput and response time with metriks.
 email: larry@marburger.cc
 executables: []
@@ -42,6 +58,8 @@ files:
 - Rakefile
 - lib/metriks/middleware.rb
 - metriks-middleware.gemspec
+- test/metriks-middleware_test.rb
+- test/test_helper.rb
 homepage: https://github.com/lmarburger/metriks-middleware
 licenses: []
 post_install_message: 
@@ -67,4 +85,5 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 2
 summary: Rack middleware for metriks
-test_files: []
+test_files:
+- test/metriks-middleware_test.rb