rack_timer 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rack_timer.gemspec
+gemspec

data/README

@@ -0,0 +1,46 @@
+Rack Timer provides timing output around each of your Rails rack-based middleware classes. It will log output to your Rails application log.
+
+To use, simply add rack_timer to your Gemfile:
+
+gem "rack_timer"
+
+By default the gem will only log Middleware that takes longer than the default Log Threshold of 1.0 ms. Set the RACK_TIMER_LOG_THRESHOLD environment variable to tweak this.
+
+If you are tracking request queuing time via New Relic's suggested header (HTTP_X_REQUEST_START or HTTP_X_QUEUE_START), then Rack Timer will output how much time elapsed between when this header was set and when the first piece of middleware executes. See New Relic's documentation for more info: https://newrelic.com/docs/features/tracking-front-end-time
+
+
+Example output of Rack Timer with RACK_TIMER_LOG_THRESHOLD = 0.0:
+
+Rack Timer -- Queuing time: 1203 microseconds
+Rack Timer -- Ngin::MiddlewareStart: 0.02288818359375 ms
+Rack Timer -- Rack::Lock: 0.0150203704833984 ms
+Rack Timer -- ActiveSupport::Cache::Strategy::LocalCache: 0.0181198120117188 ms
+Rack Timer -- Rack::Runtime: 0.0121593475341797 ms
+
+
+Started GET "/page/show/358660-history" for 75.146.189.233 at Mon Mar 05 13:37:30 -0800 2012
+Rack Timer -- Rails::Rack::Logger: 0.110149383544922 ms
+Rack Timer -- ActionDispatch::ShowExceptions: 0.00905990600585938 ms
+Rack Timer -- ActionDispatch::RemoteIp: 0.0131130218505859 ms
+Rack Timer -- Rack::Sendfile: 0.00691413879394531 ms
+Rack Timer -- ActionDispatch::Callbacks: 0.0200271606445312 ms
+Rack Timer -- ActiveRecord::ConnectionAdapters::ConnectionManagement: 0.00691413879394531 ms
+Rack Timer -- ActiveRecord::QueryCache: 0.0360012054443359 ms
+Rack Timer -- ActionDispatch::Cookies: 0.00691413879394531 ms
+Rack Timer -- ActionDispatch::Session::CookieStore: 0.0231266021728516 ms
+Rack Timer -- ActionDispatch::Flash: 1.24096870422363 ms
+Rack Timer -- ActionDispatch::ParamsParser: 0.0169277191162109 ms
+Rack Timer -- Rack::MethodOverride: 0.00786781311035156 ms
+Rack Timer -- ActionDispatch::Head: 0.00810623168945312 ms
+Rack Timer -- ActionDispatch::BestStandardsSupport: 0.00691413879394531 ms
+Rack Timer -- Warden::Manager: 0.0591278076171875 ms
+Rack Timer -- NewRelic::Rack::BrowserMonitoring: 0.00715255737304688 ms
+  Processing by PageController#show as HTML
+
+
+The Queuing time shows that with this request, 1203 microseconds (1.2 milliseconds) elapsed from the time Nginx set the HTTP_X_REQUEST_START header and the start of the first piece of middleware. Each subsequent Rack Timer output line shows how long each piece of middleware took to execute in milliseconds. Turns out that all of the standard Rails middleware classes are generally fast, which is a good thing!
+
+
+
+ 
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rack_timer/stack.rb

@@ -0,0 +1,44 @@
+module ActionDispatch
+  class MiddlewareStack < Array
+
+    # this class will wrap around each Rack-based middleware and take timing snapshots of how long
+    # each middleware takes to execute
+    class RackTimer
+
+      LogThreshold = ENV.has_key?('RACK_TIMER_LOG_THRESHOLD') ? ENV['RACK_TIMER_LOG_THRESHOLD'].to_f : 1.0 # millisecond
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if env.has_key?("MIDDLEWARE_TIMESTAMP") # skip over the first middleware
+          elapsed_time = (Time.now.to_f - env["MIDDLEWARE_TIMESTAMP"][1].to_f) * 1000 
+          if elapsed_time > LogThreshold # only log if took greater than LogThreshold
+            Rails.logger.info "Rack Timer -- #{env["MIDDLEWARE_TIMESTAMP"][0]}: #{elapsed_time} ms"
+          end
+        elsif env.has_key?("HTTP_X_REQUEST_START") or env.has_key?("HTTP_X_QUEUE_START")
+          # if we are tracking request queuing time via New Relic's suggested header(s),
+          # then lets see how much time was spent in the request queue by taking the difference
+          # between Time.now from the start of the first piece of middleware
+          # prefer HTTP_X_QUEUE_START over HTTP_X_REQUEST_START in case both exist
+          queue_start_time = (env["HTTP_X_QUEUE_START"] || env["HTTP_X_REQUEST_START"]).gsub("t=", "").to_i
+          Rails.logger.info "Rack Timer -- Queuing time: #{(Time.now.to_f * 1000000).to_i - queue_start_time} microseconds"
+        end
+        env["MIDDLEWARE_TIMESTAMP"] = [@app.class.to_s, Time.now]
+        @app.call env
+      end
+
+    end
+
+    class Middleware
+
+      # overrding the built-in Middleware.build and adding a RackTimer wrapper class
+      def build(app)
+        RackTimer.new(klass.new(app, *args, &block))
+      end    
+
+    end
+    
+  end
+end

data/lib/rack_timer/version.rb

@@ -0,0 +1,3 @@
+module RackTimer
+  VERSION = "0.0.1"
+end

data/lib/rack_timer.rb

@@ -0,0 +1,5 @@
+require "rack_timer/version"
+
+module RackTimer
+  require "rack_timer/stack"
+end

data/rack_timer.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack_timer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack_timer"
+  s.version     = RackTimer::VERSION
+  s.authors     = ["lukeludwig"]
+  s.email       = ["luke.ludwig@tstmedia.com"]
+  s.homepage    = "http://www.github.com/tstmedia/rack_timer"
+  s.summary     = %q{Provides timing output around each of your Rails rack-based middleware classes.}
+  s.description = %q{Provides timing output around each of your Rails rack-based middleware classes.}
+
+  s.rubyforge_project = "rack_timer"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: rack_timer
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- lukeludwig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-05 00:00:00 Z
+dependencies: []
+
+description: Provides timing output around each of your Rails rack-based middleware classes.
+email: 
+- luke.ludwig@tstmedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- lib/rack_timer.rb
+- lib/rack_timer/stack.rb
+- lib/rack_timer/version.rb
+- rack_timer.gemspec
+homepage: http://www.github.com/tstmedia/rack_timer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rack_timer
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Provides timing output around each of your Rails rack-based middleware classes.
+test_files: []
+