rack-aggregate 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    rack-aggregate (0.0.1)
+      aggregate
+      rack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aggregate (0.2.1)
+    diff-lcs (1.1.2)
+    rack (1.2.1)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aggregate
+  rack
+  rack-aggregate!
+  rspec

data/README.md

@@ -0,0 +1,53 @@
+# Rack Aggregate
+
+Statistics aggregator middleware based on [Joseph Ruscio's aggregate gem](https://github.com/josephruscio/aggregate) which provides: minimum, maximum, mean, standard deviation measures of your applications response latency. Best of all, it accomplishes this without recording or storing any of the actual sample values - meaning, by itself it will not impact your performance or memory footprint even across millions of requests.
+
+## Example
+
+    > ruby examples/rackapp.rb
+    > ab -c1 -n20 http://127.0.0.1:4567/ (run 20 requests against the app)
+    > ...
+    > curl http://127.0.0.1:4567/aggregate
+
+    count:    20
+    mean:    4100.30ms
+    min:    1000.11ms
+    max:    9000.17ms
+    std_dev:  2447.42ms
+
+    Request histogram (buckets in ms):
+    value |------------------------------------------------------------------| count
+      512 |@                                                                 |     1
+     1024 |@@@@@@@                                                           |     7
+     2048 |@@@@                                                              |     4
+     4096 |@@@@@@                                                            |     6
+     8192 |@@                                                                |     2
+          ~
+    Total |------------------------------------------------------------------|    20
+
+### Quickstart with Rack
+
+    gem install rack-aggregate
+
+    # in your rack app / rackup file
+    require 'rack/aggregate'
+    use Rack::Aggregate
+
+### Quickstart with Rails 3
+
+    # in your Gemfile
+    gem 'rack-aggregate', :require => 'rack/aggregate'
+
+    # in development.rb environment
+    config.middleware.use Rack::Aggregate
+
+## Wishlist
+
+- Configurable aggregate path
+- Custom sampling rate - no need to log every request
+- Other output formats? JSON?
+
+# License
+
+(The MIT License)
+Copyright © 2011 Ilya Grigorik

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/examples/rackapp.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'rack'
+
+$LOAD_PATH.unshift 'lib'
+$LOAD_PATH.unshift 'examples'
+
+require 'rack/aggregate'
+
+class SomeApp
+  def call(env)
+    sleep(rand(10))
+    [200, {"Content-Type" => "text/plain"}, "Hello World"]
+  end
+end
+
+builder = Rack::Builder.new do
+  use Rack::CommonLogger
+  use Rack::Aggregate
+
+  run SomeApp.new
+end
+
+Rack::Handler::Thin.run builder.to_app, :Port => 4567

data/lib/rack/aggregate.rb

@@ -0,0 +1,12 @@
+require 'rack'
+require 'aggregate'
+
+require 'rack/aggregate/context'
+
+module Rack
+  module Aggregate
+    def self.new(app, options = {}, &blk)
+      Context.new(app, options, &blk)
+    end
+  end
+end

data/lib/rack/aggregate/context.rb

@@ -0,0 +1,41 @@
+module Rack
+  module Aggregate
+    class Context
+      AGGREGATE_PATH  = /^\/aggregate$/.freeze
+
+      def initialize(app, options = {}, &blk)
+        options = {
+          # ...
+        }.merge(options)
+
+        @app = app
+        @aggregate = ::Aggregate.new
+
+        yield self if block_given?
+      end
+
+      def call(env)
+        if env['PATH_INFO'] =~ AGGREGATE_PATH
+          resp = Rack::Response.new('', 200)
+          resp['Content-Type'] = 'text/plain'
+
+          resp.write "count:\t\t#{@aggregate.count}\n"
+          [:mean, :min, :max, :std_dev].each do |metric|
+            resp.write "#{metric}:\t\t%1.2fms\n" % (@aggregate.send(metric) || 0)
+          end
+
+          resp.write "Request histogram:\n"
+          resp.write @aggregate.to_s
+
+          return resp.finish
+        end
+
+        start = Time.now
+        @status, @headers, @response = @app.call(env)
+        @aggregate << (Time.now - start) * 1000
+
+        [@status, @headers, @response]
+      end
+    end
+  end
+end

data/lib/rack/aggregate/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Aggregate
+    VERSION = "0.1.0"
+  end
+end

data/rack-aggregate.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/aggregate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-aggregate"
+  s.version     = Rack::Aggregate::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ilya Grigorik"]
+  s.email       = ["ilya@igvita.com"]
+  s.homepage    = "http://github.com/igrigorik/rack-aggregate"
+  s.summary     = %q{Rack response-time statistics aggregator middleware}
+  s.description = s.summary
+
+  s.rubyforge_project = "rack-aggregate"
+
+  s.add_dependency "rack"
+  s.add_dependency "aggregate"
+  s.add_development_dependency "rspec"
+
+  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"]
+end

data/spec/context_spec.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+describe Rack::Aggregate do
+  let(:app) { [200, {'Content-Type' => 'text/plain'}, 'Hello World'] }
+
+  describe 'middleware' do
+    it 'take a backend and returns a middleware component' do
+      Rack::Aggregate.new(app).should respond_to(:call)
+    end
+
+    it 'take an options Hash' do
+      lambda { Rack::Aggregate.new(app, {}) }.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe 'response' do
+    it 'should respond with 200 to requests to the aggregate endpoint' do
+      respond_with(200)
+      response = get('/aggregate')
+
+      response.status.should == 200
+      response.body.should match('Empty histogram')
+    end
+
+    it 'should collect aggregate performance statistics' do
+      respond_with(200)
+
+      10.times { get('/some_endpoint') }
+      response = get('/aggregate')
+
+      response.status.should == 200
+      [:mean, :min, :max, :std_dev].each do |metric|
+        response.body.should match(/#{metric}:\s+\d\.\d+/)
+      end
+    end
+
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,39 @@
+require 'bundler'
+Bundler.setup
+
+require 'rack/aggregate'
+
+[ STDOUT, STDERR ].each { |io| io.sync = true }
+
+def respond_with(status=200, headers={}, body=['Hello World'])
+  called = false
+  @app = lambda do |env|
+    called = true
+    response = Rack::Response.new(body, status, headers)
+    request = Rack::Request.new(env)
+
+    yield request, response if block_given?
+
+    response.finish
+  end
+
+  @app
+end
+
+def request(method, uri='/', opts={})
+  opts = {
+    'rack.run_once' => true,
+    'rack.errors' => @errors,
+  }.merge(opts)
+
+  @aggregate ||= Rack::Aggregate::Context.new(@app)
+  @request = Rack::MockRequest.new(@aggregate)
+
+  yield @aggregate if block_given?
+
+  @request.request(method.to_s.upcase, uri, opts)
+end
+
+def get(uri, env={}, &b)
+  request(:get, uri, env, &b)
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: rack-aggregate
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ilya Grigorik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: aggregate
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Rack response-time statistics aggregator middleware
+email: 
+- ilya@igvita.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- examples/rackapp.rb
+- lib/rack/aggregate.rb
+- lib/rack/aggregate/context.rb
+- lib/rack/aggregate/version.rb
+- rack-aggregate.gemspec
+- spec/context_spec.rb
+- spec/helper.rb
+has_rdoc: true
+homepage: http://github.com/igrigorik/rack-aggregate
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rack-aggregate
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rack response-time statistics aggregator middleware
+test_files: 
+- spec/context_spec.rb
+- spec/helper.rb