rack-timer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 093c4b4ce6a889fc7fb2fef289cca1a6cd3e1b4e
+  data.tar.gz: d87b254b2fdf74e78b4889430e065fb5499a8268
+SHA512:
+  metadata.gz: 360878f72429257dfa302dfa81b8481ff365febdf66c1b93ca0da0189dec7f006ea6a0d6248691ee00740634675ce13680c08dd9e3a431abc7fbdce10da3b13d
+  data.tar.gz: 3fe7d3ea84d810875cc881f3fc529fa921b9e5ec8274507176feaa8766ae8ce3513722306d0d21c21086a738df1e4eb82016800ffcbadf9130db85bc3e7d1e89

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+- 2.1.0
+- 2.0.0
+- 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-timer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    rack-timer (0.0.1)
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    slop (3.4.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  pry
+  rack-timer!
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 HouseTrip Ltd
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# rack-timer
+
+Are you spending too much time in Rack middlewares?
+
+Is one of your Rack middlewares misbehaving in production?
+
+Add `RackTimer::Middleware` to the to of your middleware stack and firgure out.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-timer'
+
+Add the middleware to your stack. In your `config.ru`, add this before any other
+middleware:
+
+    require 'rack-timer'
+    use RackTimer::Middleware
+
+When your app runs, it will output timing information to standard error.
+If you want to change that, you can tell `rack-timer` to send data to another
+file-y object, for instance:
+
+    RackTimer.output = $stdout
+    
+
+## Usage
+
+Run your app normally after installation, wait a while, and download your logs.
+
+They will report the middleware starting up:
+
+    [rack-timer] assimilating: Rack::MiddlewareTimer
+    [rack-timer] assimilating: Rack::Lock
+    [rack-timer] assimilating: Airbrake::UserInformer
+    [rack-timer] assimilating: Rack::DetectCrawler
+
+then timing each request:
+
+    [borg] Proc took 3398135 us
+    [rack-timer] Rack::Cors took 54 us
+    [rack-timer] Rack::OutOfBandGC took 51 us
+    ...
+    [rack-timer] Airbrake::UserInformer took 74 us
+    [rack-timer] Rack::Lock took 78 us
+    [rack-timer] Rack::MiddlewareTimer took 80 us
+    [rack-timer] queued for 5256 us
+
+Besides middleware timing, two bits of extra information are reported:
+
+- `Proc` (the first entry for each request) typically is your app itself
+  (excluding middleware).
+- `queued for...` will be present if your web frontend adds the `X-Request-Start`
+  HTTP header. If using Nginx+Unicorn or Apache+Passenger, this will report the
+  queueing time in Unicorn or Passenger.
+
+## An example
+
+We developed this because of wierd issues with queuing time (was too high
+without an obvious reason).
+
+We graphed the middleware timings:
+
+![](http://cl.ly/image/460a3z060F3B/capture%202014-03-12%20at%2016.51.53.png)
+
+And the queueing timings:
+
+![](http://cl.ly/image/2D2336390628/capture%202014-03-12%20at%2013.25.43.png)
+
+(horizontally: log10 of the queuing time in microseconds, ie. 3 is 1ms and 6 is
+1 second)
+
+The conlusion was that something what causing queuing in some cases. It turned
+out our out-of-band garbage colleciton hack was no longer compatible with
+Passenger, and removing it solved the issue:
+
+![](http://cl.ly/image/3z0V40291P46/capture%202014-03-12%20at%2014.18.55.png)
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/rack-timer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/rack-timer.rb

@@ -0,0 +1,2 @@
+require 'rack-timer/version'
+require 'rack-timer/middleware'

data/lib/rack-timer/middleware.rb

@@ -0,0 +1,89 @@
+
+require 'rack'
+
+module RackTimer
+
+  module ModuleMethods
+    def log(message)
+      (@_output || $stderr).puts(message)
+    end
+
+    def output=(io)
+      @_output = io
+    end
+  end
+  extend ModuleMethods
+
+
+  class Middleware
+
+    def initialize(app)
+      @app = app
+      self.extend(Borg)
+      _log "started borg collective: #{self.class.name}"
+    end
+
+    def call(env)
+      @app.call(env)
+    end
+
+    module Borg
+      def self.extended(object)
+        object.singleton_class.class_eval do
+          alias_method :call_without_timing, :call
+          alias_method :call, :call_with_timing
+          public :call
+        end
+
+        object.instance_eval do
+          _log "assimilating: #{object.class.name}"
+          recursive_borg
+        end
+      end
+
+      def borged?
+        true
+      end
+
+      private
+
+      def recursive_borg
+        return if @app.nil?
+        return if @app.respond_to?(:borged?)
+        return unless @app.respond_to?(:call)
+        @app.extend(Borg)
+      end
+
+      def call_with_timing(env)
+        time_before = _current_ticks
+        result = call_without_timing(env)
+        time_delta = _current_ticks - time_before
+
+        if time_inner = env['rack-timer.time']
+          time_inner = time_inner.to_i
+          time_self = time_delta - time_inner 
+        else
+          time_self = time_delta
+        end
+        _log "#{self.class.name} took #{time_self} us"
+
+        if (request_start = env['HTTP_X_REQUEST_START']) && kind_of?(RackTimer::Middleware)
+          time_queue_start = request_start.gsub('t=', '').to_i
+          time_in_queue = time_before - time_queue_start
+          _log "queued for #{time_in_queue} us"
+        end
+
+        env['rack-timer.time'] = time_delta
+        return result
+      end
+
+      def _log(message)
+        RackTimer.log "[rack-timer] #{message}"
+      end
+
+      def _current_ticks
+        (Time.now.to_f * 1e6).to_i
+      end
+    end
+  end
+end

data/lib/rack-timer/version.rb

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

data/rack-timer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack-timer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-timer"
+  spec.version       = RackTimer::VERSION
+  spec.authors       = ["Julien Letessier"]
+  spec.email         = ["julien.letessier@gmail.com"]
+  spec.summary       = %q{Measure time spent in your Rack middlewares}
+  spec.description   = %q{Measure time spent in your Rack middlewares}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "rack"
+end

data/spec/rack-timer/middleware_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'rack-timer'
+
+describe RackTimer::Middleware do
+  let(:buffer) { StringIO.new }
+  let(:output) { buffer.rewind ; buffer.read }
+  let(:app) { build_stack *stack }
+  let(:stack) { [Test::App, Test::FastMiddleware, RackTimer::Middleware] }
+
+  before do
+    RackTimer.output = buffer
+  end
+
+  def build_stack(app_class, *middlewares)
+    app = app_class.new
+    middlewares.each do |m|
+      app = m.new(app)
+    end
+    app
+  end
+
+  describe 'assimilation' do
+    it 'gets logged' do
+      app
+      output.should =~ /assimilating: RackTimer::Middleware/
+      output.should =~ /assimilating: Test::FastMiddleware/
+    end
+  end
+
+  describe 'middleware timing' do
+    it 'logs app timing' do
+      app.call({})
+      output.should =~ /Test::App took \d+ us/
+    end
+
+    it 'logs middleware timing' do
+      app.call({})
+      output.should =~ /Test::FastMiddleware took \d+ us/
+    end
+
+    context 'with a slow middleware' do
+      let(:stack) { [Test::App, Test::SlowMiddleware, Test::FastMiddleware, RackTimer::Middleware] }
+      
+      it 'times the slow middleware' do
+        app.call({})
+        output.should =~ /Test::SlowMiddleware took \d+ us/
+      end
+
+      it 'does not include the slow middleware time in the outer middleware' do
+        app.call({})
+        time_slow = /Test::SlowMiddleware took (?<time>\d+) us/.match(output)[:time].to_i
+        time_fast = /Test::FastMiddleware took (?<time>\d+) us/.match(output)[:time].to_i
+        time_slow.should > 250_000
+        time_fast.should < time_slow
+      end
+    end
+  end
+
+  describe 'queue timing' do
+    let(:timestamp) { (Time.now.to_f * 1e6).to_i }
+    let(:env) {{ 'HTTP_X_REQUEST_START' => "t=#{timestamp}" }}
+
+    it 'adds queue time when HTTP_X_REQUEST_START present' do
+      app.call(env)
+      output.should =~ /queued for \d+ us/
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+#
+# lib = File.expand_path('../../lib', __FILE__)
+# $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rack'
+require 'pry'
+
+module Test
+  class App
+    def call(env)
+      [200, {}, 'ok']
+    end
+  end
+
+  class FastMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env)
+    end
+  end
+
+  class SlowMiddleware < FastMiddleware
+    def call(env)
+      sleep 250e-3
+      super
+    end
+  end
+end
+
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rack-timer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Julien Letessier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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 time spent in your Rack middlewares
+email:
+- julien.letessier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-timer.rb
+- lib/rack-timer/middleware.rb
+- lib/rack-timer/version.rb
+- rack-timer.gemspec
+- spec/rack-timer/middleware_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Measure time spent in your Rack middlewares
+test_files:
+- spec/rack-timer/middleware_spec.rb
+- spec/spec_helper.rb