rack-request-profiler 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+.rspec
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+group :test do
+  gem 'em-stathat'
+  gem 'rack'
+  gem 'rspec', '>= 2.7'
+  gem 'rack-test', :require => 'rack/test'
+  gem 'statsd-ruby', :require => 'statsd'
+end

data/README.md

@@ -0,0 +1,22 @@
+This project provides a simple "framework" for profiling request / response times, and sending the data to another service. It includes a base class `Rack::RequestProfiler` for handling the logic of wrapping and timing the request / response cycle in a rack app.
+
+By default, the `Rack::RequestProfiler` middleware does not do anything with the profiling data. Instead, this logic must be implemented by subclasses by defining the `handle_results` instance method. For example, you might send profiling data to an external web service (stathat, papertrail, loggly, etc), statsd, write to a logfile on disk, put it in a persistent store like redis or mongo, or really anything else your heart desires.
+
+This project currently provides profiler middlewares for stathat and statsd. If you'd like to contribute a profiler middleware, pull requests are welcome.
+
+## Installation
+
+`gem install rack-request_profiler`
+
+## Usage
+
+Simply include one of the profiler middlewares into the middleware stack in any rack-compatible application like so:
+
+```ruby
+use Rack::Profilers::Statsd, Statsd.new('localhost'), :ignore_path => /^\/assets/
+```
+
+## Profilers
+
+* Statsd - Uses the [statsd ruby client](https://github.com/reinh/statsd-ruby) to send data to statsd / graphite.
+* Stathat - Uses the [em-stathat gem](https://github.com/ajsharp/em-stathat) to send data to stathat asynchronously via eventmachine.

data/lib/rack-request-profiler.rb

@@ -0,0 +1,12 @@
+module Rack
+  autoload :RequestProfiler, 'rack/request-profiler'
+
+  module Profilers
+    autoload :Statsd,  'rack/profilers/statsd'
+    autoload :Stathat, 'rack/profilers/stathat'
+  end
+
+  module Utils
+    autoload :UrlStripper, 'rack/utils/url_stripper'
+  end
+end

data/lib/rack/profilers/stathat.rb

@@ -0,0 +1,32 @@
+require 'rack/request-profiler'
+require 'em-stathat'
+
+module Rack
+  module Profilers
+
+    # NOTE: This middleware expects that you are running an EventMachine
+    # reactor in the current process, and should not be used otherwise.
+    class Stathat < RequestProfiler
+
+      # @param [Hash] opts
+      # @option [Proc] :errback errback passed to the eventmachine instance
+      # @option [Proc] :callback callback passed to the eventmachine instance
+      def initialize(app, opts = {})
+        @app, @opts = app, opts
+      end
+
+      # @param [Hash] env the rack env
+      # @param [Rack::Request] request a request object constructed
+      #   from env
+      def handle_results(env, request)
+        clean_url = Utils::UrlStripper.replace_id(request.path)
+
+        EM.next_tick do
+          deferrable = EM::StatHat.new.ez_value("#{request.request_method} #{clean_url}", run_time)
+          deferrable.callback(&@opts[:callback]) if @opts[:callback]
+          deferrable.errback(&@opts[:errback]) if @opts[:errback]
+        end
+      end
+    end
+  end
+end

data/lib/rack/profilers/statsd.rb

@@ -0,0 +1,28 @@
+require 'rack/request-profiler'
+require 'statsd'
+
+module Rack
+  module Profilers
+    class Statsd < RequestProfiler
+
+      # @example
+      #   use Rack::Profilers::Statsd, Statsd.new('localhost'), :ignore_path => /^\/assets/
+      #
+      # @param [Statsd] statsd an instance of your statsd client
+      # @param [Hash] opts a hash of options
+      # @option :namespace namespce string for statsd
+      # @option :ignore_path request paths to ignore and not handle
+      def initialize(app, statsd, opts = {})
+        @app, @statsd, @opts = app, statsd, opts
+      end
+
+      def handle_results(env, request)
+        clean_url = Utils::UrlStripper.replace_id(request.path)
+        clean_url = clean_url[1..-1].gsub('/', '.')
+        namespace = @opts[:namespace] || ''
+
+        @statsd.timing("#{namespace}#{request.request_method}.#{clean_url}", run_time)
+      end
+    end
+  end
+end

data/lib/rack/request-profiler.rb

@@ -0,0 +1,44 @@
+module Rack
+  class RequestProfiler
+
+    # @param [Hash] opts a hash of options
+    # @option [Symbol] :ignore_path Request paths to ignore and not handle
+    def initialize(app, opts = {})
+      @app, @opts = app, opts
+    end
+
+    def start_time=(time)
+      @start_time = time
+    end
+
+    def start_time
+      @start_time
+    end
+
+    def call(env, &block)
+      self.start_time = Time.now
+      request         = Request.new(env)
+
+      # Short-circuit here and pass the response back through the
+      # middleware chain if the request path matches the ignore_path
+      if @opts[:ignore_path] && request.path.match(@opts[:ignore_path])
+        return @app.call(env)
+      end
+
+      status, headers, body = @app.call(env)
+
+      handle_results(env, request)
+      [status, headers, body]
+    end
+
+    # Override this method in subclasses
+    def handle_results(env, request = nil)
+      # override me!
+    end
+
+    # Returns elapsed time since start_time in milliseconds.
+    def run_time
+      ((Time.now - start_time) * 1000).round
+    end
+  end
+end

data/lib/rack/request-profiler/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class RequestProfiler
+    VERSION = '0.1.0'
+  end
+end

data/lib/rack/utils/url_stripper.rb

@@ -0,0 +1,11 @@
+module Rack
+  module Utils
+    class UrlStripper
+      ID_PATTERN = /([0-9][a-z][^\/]+)/
+
+      def self.replace_id(url)
+        url.gsub(ID_PATTERN, 'ID')
+      end
+    end
+  end
+end

data/rack-request-profiler.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/request-profiler/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-request-profiler"
+  s.version     = Rack::RequestProfiler::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Alex Sharp"]
+  s.email       = ["ajsharp@gmail.com"]
+  s.homepage    = "https://github.com/ajsharp/rack-request-profiler"
+  s.summary     = %q{Rack middleware for profiling request / response cycles.}
+  s.description = %q{Provides a framework for sending wall time statistics to external services, such as statsd, stathat, etc.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/rack/profilers/stathat_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Rack::Profilers::Stathat do
+  it "accepts callbacks" do
+    EM.run {
+      app = Rack::Builder.app do
+        use Rack::Profilers::Stathat, :callback => lambda { |req| puts("hey"); EM.stop }
+
+        run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['']]}
+      end
+      req = Rack::MockRequest.new(app).get('/')
+    }
+  end
+end

data/spec/rack/profilers/statsd_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Rack::Profilers::Statsd do
+  include Rack::Test::Methods
+  $statsd = Statsd.new 'localhost'
+
+  it "sends stuff to statsd" do
+    app = Rack::Builder.app do
+      use Rack::Profilers::Statsd, $statsd
+      run lambda { |env| [200, {}, ['']]}
+    end
+
+    obj = mock("object", :timing => true)
+    $statsd.should_receive(:timing)
+    response = Rack::MockRequest.new(app).get('/')
+  end
+
+  it "does not send stuff for ignored paths" do
+    app = Rack::Builder.app do
+      use Rack::Profilers::Statsd, $statsd, :ignore_path => /ignore-me/
+      run lambda { |env| [200, {}, ['']]}
+    end
+
+    $statsd.should_not_receive(:timing)
+    Rack::MockRequest.new(app).get('/ignore-me')
+  end
+end

data/spec/rack/request-profiler_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Rack::RequestProfiler do
+  include Rack::Test::Methods
+
+  it "implements the handle_results interface" do
+    Rack::RequestProfiler.new(lambda {}).should respond_to :handle_results
+  end
+
+  it "invokes the handle_results interface" do
+    class Rack::CustomProfiler < Rack::RequestProfiler
+      def handle_results(env)
+      end
+    end
+    app = Rack::Builder.app do
+      use Rack::CustomProfiler
+
+      run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['']]}
+    end
+
+    Rack::CustomProfiler.any_instance.should_receive(:handle_results)
+    Rack::MockRequest.new(app).get('/')
+  end
+
+  it "does not invoke handle_results if ignore_path matches" do
+    app = Rack::Builder.app do
+      use Rack::RequestProfiler, :ignore_path => /ignore_me/
+
+      run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['']]}
+    end
+
+    Rack::RequestProfiler.any_instance.should_not_receive(:handle_results)
+    Rack::MockRequest.new(app).get('/ignore_me')
+  end
+end

data/spec/rack/utils/url_stripper_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Rack::Utils::UrlStripper do
+  describe '.replace_id' do
+    it 'replaces BSON-like ids with ID' do
+      Rack::Utils::UrlStripper.replace_id("/resource/4f07931e3641417a88000002").should == '/resource/ID'
+    end
+
+    it "replaces ids with sub-resources" do
+      Rack::Utils::UrlStripper.replace_id("/resource/4f07931e3641417a88000002/another").should == '/resource/ID/another'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$:.push(File.dirname(File.expand_path(__FILE__)))
+
+require File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib', 'rack-request-profiler')
+
+require 'rack/test'
+require 'em-stathat'
+
+EventMachine::StatHat.config do |c|
+  c.ukey  = 'key'
+  c.email = 'user@example.com'
+end
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: rack-request-profiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Sharp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-09 00:00:00.000000000 Z
+dependencies: []
+description: Provides a framework for sending wall time statistics to external services,
+  such as statsd, stathat, etc.
+email:
+- ajsharp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- lib/rack-request-profiler.rb
+- lib/rack/profilers/stathat.rb
+- lib/rack/profilers/statsd.rb
+- lib/rack/request-profiler.rb
+- lib/rack/request-profiler/version.rb
+- lib/rack/utils/url_stripper.rb
+- rack-request-profiler.gemspec
+- spec/rack/profilers/stathat_spec.rb
+- spec/rack/profilers/statsd_spec.rb
+- spec/rack/request-profiler_spec.rb
+- spec/rack/utils/url_stripper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ajsharp/rack-request-profiler
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Rack middleware for profiling request / response cycles.
+test_files:
+- spec/rack/profilers/stathat_spec.rb
+- spec/rack/profilers/statsd_spec.rb
+- spec/rack/request-profiler_spec.rb
+- spec/rack/utils/url_stripper_spec.rb
+- spec/spec_helper.rb