rack-queue-metrics 1.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGM2N2FlNzhmYmZlYWI4ZmVlNTYwOTYzZDVhODljZTUzZTJjYWI3NQ==
+  data.tar.gz: !binary |-
+    ZGNiZGRlMjAwM2QxNDJhZjAzMWM5OGQ0YzEwOTE2MmE3ZDZiMjQ2ZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODQ1ZmI1MjU2MDBhZDI0Y2FkNmFmN2EwMDg0ZGFjOWVkNDM1YWY0NjIyN2Y1
+    NmRkNTI5MTBkOWY5YzI5MGMxMGM3MGU4ZjQ1YTYwODk5MDdmM2NhMGYyZjZh
+    ZDMwNWM4OWI2MjVhMzY3ZmU5MTVjOGJmM2MxYWUxMGM2NmY0Mjk=
+  data.tar.gz: !binary |-
+    Y2I3ZGFjOTkyZDZjMmUxMDYyMmJiNjZmNDVlYTY3OWYxNjcwYWJmNTA3MjZm
+    OTQ5YjJiZDdhNTg4MTJhMzQ2ZDZmOGNkZmVmNDRkYzNkN2JkYjQwOGIzMTU4
+    ZGEzNjYwYzYzODEzMDQ2NTY2M2YzYzI4YTVjOWMyMTYwZjEyZjQ=

data/README.md

@@ -0,0 +1,59 @@
+# Rack Queue Metrics
+
+Report on queued connections in any Rack-based server using [Raindrops](http://raindrops.bogomips.org/) and the [Raindrops::Linux](http://raindrops.bogomips.org/Raindrops/Linux.html) features. 
+
+## Usage
+
+First, add `rack-queue-metrics` to your Gemfile:
+
+```
+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:
+
+```
+# config/initializers/notifications.rb
+ActiveSupport::Notifications.subscribe(/unicorn.metrics.queue/) do |*args|
+  event = ActiveSupport::Notifications::Event.new(*args)
+  payload = event.payload
+
+  addr = payload[:addr]
+  active = payload[:requests][:active]
+  queued = payload[:requests][:queued]
+  queue_time = payload[:queue_time]
+
+  puts "STATS addr=#{addr} active=#{active} queued=#{queued} queue_time=#{queue_time} "
+end
+```
+
+For more information, see the [ActiveSupport::Notification](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html) docs.
+
+### Sinatra/Rack Apps
+
+Include the `Raindrops` and `Rack::QueueMetrics` middleware in your application's config.ru:
+
+```
+  # config.ru
+  use Raindrops::Middleware
+  use Rack::QueueMetrics::Middleware
+```
+
+### Output
+
+With every request, `rack-queue-metrics` will output a log line with the the following format:
+
+```
+at=metric measure=rack.queue-metrics addr=10.10.10.90:5000 queue_time=0 queue_depth=0
+```
+
+## Notifications
+
+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[: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

data/lib/queue-metrics/middleware.rb

@@ -0,0 +1,41 @@
+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] = headers['X-Request-Start'] ? (start_time - headers['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

data/lib/queue-metrics/railtie.rb

@@ -0,0 +1,10 @@
+module Rack
+  module QueueMetrics
+    class RackQueueRailtie < Rails::Railtie
+      initializer "rack_queue_railtie.configure_rails_initialization" do |app|
+        app.middleware.use Raindrops::Middleware
+        app.middleware.use Rack::QueueMetrics::Middleware
+      end
+    end
+  end
+end

data/lib/queue-metrics/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module QueueMetrics
+    VERSION = "1.0.1"
+  end
+end

data/lib/rack-queue-metrics.rb

@@ -0,0 +1,2 @@
+require 'queue-metrics/middleware'
+require 'queue-metrics/railtie' if defined?(Rails)

data/rack-queue-metrics.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "queue-metrics/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-queue-metrics"
+  s.version     = Rack::QueueMetrics::VERSION
+  s.authors     = ["dominic (Dominic Dagradi)"]
+  s.email       = ["dominic@heroku.com"]
+  s.homepage    = "http://github.com/heroku/rack-queue-metrics"
+  s.summary     = %q{Measure queueing metrics for Rack apps}
+  s.description = %q{Measure queueing metrics for Rack apps}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'raindrops'
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: rack-queue-metrics
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- dominic (Dominic Dagradi)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-08 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
+email:
+- dominic@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/queue-metrics/middleware.rb
+- lib/queue-metrics/railtie.rb
+- lib/queue-metrics/version.rb
+- lib/rack-queue-metrics.rb
+- rack-queue-metrics.gemspec
+homepage: http://github.com/heroku/rack-queue-metrics
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Measure queueing metrics for Rack apps
+test_files: []