rack-queue-metrics 1.0.2 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjliYTU3ZTUxNmM4NmMxMjUxYWUwNGU1ODI5N2E2OWNkYjM2YzQ5Mg==
-  data.tar.gz: !binary |-
-    MzQ3ZTkwZGQ4MDE1MjY1NjU1NjZhMzRmNTdmMjc3NTI0NTQ2YWQwNQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZTMzMTY3MDI0MWUxM2UxYjkxMmFhNjI0ZTRlOGZkYThkYzg4NDVhNzg5YjVj
-    M2U2M2E5MDc0M2EyYjNkOTRjYTEyNjdiMjUwMjVmYmFiNDkxZTA0NmM5N2Rh
-    MDY1NjUyN2RkMzcwOWM2NzdmODM2YmQwNjU0ZTg4MmM2Y2M0Yzc=
-  data.tar.gz: !binary |-
-    ZTExOTcyZTNhYzkzZmE1MDRiY2E1MTY0OTMwZDdmYjg0Y2Y1NzgyZTE0NWRh
-    ZDQwMDY4YTNiMjFjNmI0NzQ5ZTEzYmZjMDIwMDE0NDQ1OTdiNjgyMzFhZDgw
-    YmFkMjUwZDQ4Y2U1MmYwNzQ5Y2M2MDFkZGRjNjljY2U0Mzc0YzQ=
+SHA1:
+  metadata.gz: 753d70724e0d2f8d18d0fd147e0a170f9d8cc0f2
+  data.tar.gz: 55dbea922d5361e1d5c67926d9aed26f48283d05
+SHA512:
+  metadata.gz: 7f0c153bfde9e3d7ee57ab5238f7c8eb870d3c5836f18f96f0cf025ba6637485efbe492e5945328412d5794133e6d2afd16876f460eae66f82ca78c5b025a34d
+  data.tar.gz: 38e3c1d9e3726a35349373ffc93504a0e9489e5e351ec984719e82702e7d0b3d1ba79532895d80b841840dcac7060157481eead78e4a7b2236ec14797ae623bf

data/README.md

@@ -12,11 +12,11 @@ gem 'rack-queue-metrics'
 
 ### Rails
 
-You're done! If you want to instrument queue metrics beyond the default output, you can subscribe to the `unicorn.metrics.queue` notifcation in your Rails app. For example, to print queue information to your logs, add the following to `config/initializers/notifcations.rb:
+You're done! If you want to instrument queue metrics beyond the default output, you can subscribe to the `rack.queue-metrics` notifcation in your Rails app. For example, to print queue information to your logs, add the following to `config/initializers/notifcations.rb:
 
 ```
 # config/initializers/notifications.rb
-ActiveSupport::Notifications.subscribe(/unicorn.metrics.queue/) do |*args|
+ActiveSupport::Notifications.subscribe(/rack.queue-metrics/) do |*args|
   event = ActiveSupport::Notifications::Event.new(*args)
   payload = event.payload
 
@@ -53,7 +53,7 @@ at=metric measure=rack.queue-metrics addr=10.10.10.90:5000 queue_time=0 queue_de
 
 The following information is sent in the notification payload:
 
-* `requests[:active]`: Number of requests currently being processed by Unicorn at the start of the request
+* `requests[:active]`: Number of requests currently being processed by the dyno at the start of the request
 * `requests[:queued]`: Number of requests waiting to be processed at the start of the request
 * `queue_time`: Amount of time the current request spent in the queue
-* `addr`: Address of the dyno processing the request
+* `addr`: Address of the dyno processing the request

data/lib/queue-metrics/app_time.rb

@@ -0,0 +1,48 @@
+require 'logger'
+require 'queue-metrics/l2met_formatter'
+require 'queue-metrics/notify'
+
+module Rack
+  module QueueMetrics
+    class AppTime
+      include Notify
+
+      def initialize(app, logger = nil)
+        @app             = app
+        @instrument_name = "rack.queue-metrics.app-time"
+        @logger          = logger
+        if @logger.nil?
+          @logger = ::Logger.new($stdout)
+          @logger.formatter = L2MetFormatter.new
+        end
+      end
+
+      def call(env)
+        app_start        = (Time.now.to_f * 1000.0).round
+        request_id       = env["HTTP_REQUEST_ID"]
+        middleware_start = (env["MIDDLEWARE_START"] || 0).to_i
+        middleware_delta = nil
+        report = "measure=#{@instrument_name}.start app_start=#{app_start}"
+        if middleware_start > 0
+          middleware_delta = app_start - middleware_start
+          report << " middleware_delta=#{middleware_delta}"
+        end
+        report << " request_id=#{request_id}" if request_id
+        @logger.info report
+
+        status, headers, response = @app.call(env)
+
+        app_end   = (Time.now.to_f * 1000.0).round
+        app_delta = app_end - app_start
+        report  = "measure=#{@instrument_name}.end app_end=#{app_end}"
+        report << " app_delta=#{app_delta}"
+        report << " request_id=#{request_id}" if request_id
+        @logger.info report
+
+        notify(:app_end => app_end, :app_start => app_start, :app_delta => app_delta, :middleware_delta => middleware_delta, :request_id => request_id) if should_notify?
+
+        [status, headers, response]
+      end
+    end
+  end
+end

data/lib/queue-metrics/l2met_formatter.rb

@@ -0,0 +1,9 @@
+module Rack
+  module QueueMetrics
+    class L2MetFormatter
+      def call(serverity, datetime, progname, msg)
+        "at=metric #{msg}\n"
+      end
+    end
+  end
+end

data/lib/queue-metrics/notify.rb

@@ -0,0 +1,15 @@
+module Rack
+  module QueueMetrics
+    module Notify
+      def should_notify?
+        if defined?(ActiveSupport::Notifications)
+          ActiveSupport::Notifications.notifier.listening?(@instrument_name)
+        end
+      end
+
+      def notify(data)
+        ActiveSupport::Notifications.instrument(@instrument_name, data)
+      end
+    end
+  end
+end

data/lib/queue-metrics/queue_depth.rb

@@ -0,0 +1,60 @@
+require 'logger'
+require 'queue-metrics/l2met_formatter'
+require 'queue-metrics/notify'
+
+module Rack
+  module QueueMetrics
+    class QueueDepth
+      include Notify
+
+      def initialize(app, logger = nil)
+        @app             = app
+        @addr            = getaddr
+        @instrument_name = "rack.queue-metrics.queue-depth"
+        @logger          = logger
+        if @logger.nil?
+          @logger = ::Logger.new($stdout)
+          @logger.formatter = L2MetFormatter.new
+        end
+
+        Thread.new {report(1)}
+      end
+
+      def call(env)
+        return @app.call(env) unless ENV['PORT']
+        status, headers, body = @app.call(env)
+        [status, headers, body]
+      end
+
+    private
+
+      def getaddr
+        IPSocket.getaddress(Socket.gethostname).to_s + ':' + ENV['PORT']
+      rescue SocketError
+        nil
+      end
+
+      def report(interval)
+        loop do
+          stats = raindrops_stats
+          stats[:addr] = @addr
+          notify(stats) if should_notify?
+          @logger.info(["measure=#{@instrument_name}",
+                        "addr=#{@addr}",
+                        "queue_depth=#{stats[:requests][:queued]}"].join(' '))
+          sleep(interval)
+        end
+      end
+
+      def raindrops_stats
+        if defined? Raindrops::Linux.tcp_listener_stats
+          stats = Raindrops::Linux.tcp_listener_stats([ '0.0.0.0:'+ENV['PORT'] ])['0.0.0.0:'+ENV['PORT']]
+          return { :requests => { :active => stats.active, :queued => stats.queued }}
+        else
+          return { :requests => { :active => 0, :queued => 0 }}
+        end
+      end
+
+    end
+  end
+end

data/lib/queue-metrics/queue_time.rb

@@ -0,0 +1,41 @@
+require 'logger'
+require 'queue-metrics/l2met_formatter'
+require 'queue-metrics/notify'
+
+module Rack
+  module QueueMetrics
+    class QueueTime
+      include Notify
+
+      def initialize(app, logger = nil)
+        @app             = app
+        @instrument_name = "rack.queue-metrics.queue-time"
+        @logger          = logger
+        if @logger.nil?
+          @logger = ::Logger.new($stdout)
+          @logger.formatter = L2MetFormatter.new
+        end
+      end
+
+      def call(env)
+        middleware_start    = (Time.now.to_f * 1000.0).round
+        request_start       = (env["HTTP_X_REQUEST_START"] || 0).to_i
+        request_id          = env["HTTP_REQUEST_ID"]
+        request_start_delta = nil
+        report = "measure=#{@instrument_name} middleware_start=#{middleware_start}"
+        if request_start > 0
+          request_start_delta = middleware_start - request_start
+          report << " request_start=#{request_start} request_start_delta=#{request_start_delta}"
+        end
+        report << " request_id=#{request_id}" if request_id
+        @logger.info report
+
+        notify(:middleware_start => middleware_start, :request_start => request_start, :request_start_delta => request_start_delta, :request_id => request_id) if should_notify?
+
+        env["MIDDLEWARE_START"] = middleware_start
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/queue-metrics/railtie.rb

@@ -2,9 +2,11 @@ module Rack
   module QueueMetrics
     class RackQueueRailtie < Rails::Railtie
       initializer "rack_queue_railtie.configure_rails_initialization" do |app|
+        app.middleware.use Rack::QueueMetrics::QueueTime
         app.middleware.use Raindrops::Middleware
-        app.middleware.use Rack::QueueMetrics::Middleware
+        app.middleware.use Rack::QueueMetrics::QueueDepth
+        app.middleware.use Rack::QueueMetrics::AppTime
       end
     end
   end
-end
+end

data/lib/queue-metrics/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module QueueMetrics
-    VERSION = "1.0.2"
+    VERSION = "2.0.0"
   end
 end

data/lib/rack-queue-metrics.rb

@@ -1,2 +1,4 @@
-require 'queue-metrics/middleware'
-require 'queue-metrics/railtie' if defined?(Rails)
+require 'queue-metrics/queue_time'
+require 'queue-metrics/queue_depth'
+require 'queue-metrics/app_time'
+require 'queue-metrics/railtie' if defined?(Rails)

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: rack-queue-metrics
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - dominic (Dominic Dagradi)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-08 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: raindrops
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Measure queueing metrics for Rack apps
@@ -32,7 +32,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/queue-metrics/middleware.rb
+- lib/queue-metrics/app_time.rb
+- lib/queue-metrics/l2met_formatter.rb
+- lib/queue-metrics/notify.rb
+- lib/queue-metrics/queue_depth.rb
+- lib/queue-metrics/queue_time.rb
 - lib/queue-metrics/railtie.rb
 - lib/queue-metrics/version.rb
 - lib/rack-queue-metrics.rb
@@ -46,17 +50,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Measure queueing metrics for Rack apps

data/lib/queue-metrics/middleware.rb

@@ -1,41 +0,0 @@
-require 'socket'
-
-module Rack
-  module QueueMetrics
-    class Middleware
-      
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        return @app.call(env) unless ENV['PORT']
-
-        start_time = Time.now.to_f*1000.0
-        stats = raindrops_stats
-
-        status, headers, body = @app.call(env)
-
-        stats[:addr] = IPSocket.getaddress(Socket.gethostname).to_s + ':'+ENV['PORT']
-        stats[:queue_time] = env["HTTP_X_REQUEST_START"] ? (start_time - env["HTTP_X_REQUEST_START"].to_f).round : 0
-
-        puts "at=metric measure=rack.queue-metrics addr=#{stats[:addr]} queue_time=#{stats[:queue_time]} queue_depth=#{stats[:requests][:queued]}"
-        ActiveSupport::Notifications.instrument("rack.queue-metrics", stats) if defined?(ActiveSupport::Notifications)
-
-        [status, headers, body]
-      end
-
-    private
-
-      def raindrops_stats
-        if defined? Raindrops::Linux.tcp_listener_stats
-          stats = Raindrops::Linux.tcp_listener_stats([ '0.0.0.0:'+ENV['PORT'] ])['0.0.0.0:'+ENV['PORT']]
-          return { :requests => { :active => stats.active, :queued => stats.queued }}
-        else
-          return { :requests => { :active => 0, :queued => 0 }}
-        end
-      end
-
-    end
-  end
-end