rack-graphite 1.0.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+group :test do
+  gem 'rspec', '~> 2.14'
+  gem 'rack-test'
+  gem 'sinatra'
+  gem 'debugger', :platform => :mri_19
+  gem 'debugger-pry', :platform => :mri_19
+  gem 'pry'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Lookout
+
+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,55 @@
+rack-graphite
+=============
+
+Rack middleware for automatically logging request information to Graphite.
+
+
+This gem assumes that you're using
+[lookout-statsd](https://github.com/lookout/statsd) and have already initalized
+`Statsd.instance` in your environment before handling any requests.
+
+By default this will log metrics such as:
+
+* For a `GET /` request
+    * `requests.get.root.`
+        * `count`
+        * `lower`
+        * `mean`
+        * `upper`
+        * `upper_90`
+* For a `GET /home` request
+    * `requests.get.home.`
+        * `count`
+        * `lower`
+        * `mean`
+        * `upper`
+        * `upper_90`
+* For a `PUT /upload' request
+    * `requests.put.upload.`
+        * `count`
+        * `lower`
+        * `mean`
+        * `upper`
+        * `upper_90`
+* For a `GET /user/login` request
+    * `requests.get.user.login.`
+        * `count`
+        * `lower`
+        * `mean`
+        * `upper`
+        * `upper_90`
+
+## Usage
+
+**In Sinatra**
+
+    require 'rack/graphite'
+
+    class MyApp < Sinatra::Base
+      use Rack::Graphite
+
+      get '/' do
+        'Hello!'
+      end
+    end
+

data/Rakefile

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

data/lib/rack/graphite.rb

@@ -0,0 +1,35 @@
+require 'statsd'
+
+module Rack
+  class Graphite
+    VERSION = '1.0.0'
+    PREFIX = 'requests'
+
+    def initialize(app, options={})
+      @app = app
+      @prefix = options[:prefix] || PREFIX
+    end
+
+    def call(env)
+      path = env['PATH_INFO'] || '/'
+      method = env['REQUEST_METHOD'] || 'GET'
+      metric = path_to_graphite(method, path)
+
+      result = nil
+      Statsd.instance.timing(metric) do
+        result = @app.call(env)
+      end
+      return result
+    end
+
+    def path_to_graphite(method, path)
+      method = method.downcase
+      if (path.nil?) || (path == '/') || (path.empty?)
+        "#{@prefix}.#{method}.root"
+      else
+        path = path.gsub('/', '.')
+        "#{@prefix}.#{method}#{path}"
+      end
+    end
+  end
+end

data/rack-graphite.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/graphite'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-graphite"
+  spec.version       = Rack::Graphite::VERSION
+  spec.authors       = ["R. Tyler Croy"]
+  spec.email         = ["rtyler.croy@lookout.com"]
+  spec.description   = "Simple Rack middleware for logging request counts/timing information"
+  spec.summary       = "Simple Rack middleware for logging request counts/timing information"
+  spec.homepage      = "https://github.com/lookout/rack-graphite"
+  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.3"
+
+  spec.add_dependency 'lookout-statsd'
+end

data/spec/graphite_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe Rack::Graphite do
+  let(:statsd) { double('Mock Statsd::Client') }
+
+  before :each do
+    Statsd.stub(:instance).and_return(statsd)
+  end
+
+
+  describe '#path_to_graphite' do
+    let(:middleware) { described_class.new(nil) }
+    subject(:graphite) { middleware.path_to_graphite(method, path) }
+
+    context 'GET requests' do
+      let(:method) { 'GET' }
+
+      context 'with a / URL' do
+        let(:path) { '/' }
+        it { should eql('requests.get.root') }
+      end
+
+      context 'with a onelevel URL' do
+        let(:path) { '/onelevel' }
+        it { should eql('requests.get.onelevel') }
+      end
+
+      context 'with a twolevel URL' do
+        let(:path) { '/two/level' }
+        it { should eql('requests.get.two.level') }
+      end
+
+      context 'with an empty URL' do
+        let(:path) { '' }
+        it { should eql('requests.get.root') }
+      end
+
+      context 'with a nil URL' do
+        let(:path) { nil }
+        it { should eql('requests.get.root') }
+      end
+    end
+  end
+
+
+  context 'with a fake app' do
+    let(:app) { double('Mock Rack App') }
+    subject(:middleware) { described_class.new(app) }
+
+    before :each do
+      # Stub out timing by default to and just yield
+      statsd.stub(:timing).and_yield
+    end
+
+    describe '#call' do
+      let(:env) { {:test => 'rspec'} }
+
+      before :each do
+        # Stub out by default for all tests
+        app.stub(:call)
+      end
+
+      it 'should propogate the invocation to the app' do
+        app.should_receive(:call).with(env)
+        middleware.call(env)
+      end
+
+      it 'should return the result of the propogated app.call' do
+        result = double('Mock Rack Response')
+        app.should_receive(:call).and_return(result)
+        expect(middleware.call({})).to eql(result)
+      end
+
+      it 'should invoke a timer' do
+        statsd.should_receive(:timing)
+        middleware.call({})
+      end
+    end
+  end
+
+  context 'with a simple Sinatra app', :type => :integration do
+    let(:app) { TestApp }
+
+    subject(:response) { last_response }
+
+    context 'with a root request' do
+      before :each do
+        statsd.should_receive(:timing).with('requests.get.root').and_yield
+        get '/'
+      end
+      its(:status) { should eql(200) }
+    end
+
+    context 'with a request with query params' do
+      before :each do
+        statsd.should_receive(:timing).with('requests.get.onelevel').and_yield
+        get '/onelevel?q=foo'
+      end
+      its(:status) { should eql(200) }
+    end
+
+    context 'with a PUT request' do
+      before :each do
+        statsd.should_receive(:timing).with('requests.put.onelevel').and_yield
+        put '/onelevel'
+      end
+      its(:status) { should eql(200) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+$LOAD_PATH.unshift(File.expand_path(__FILE__ + '/../lib'))
+
+require 'rack/graphite'
+require 'rack/test'
+
+unless RUBY_PLATFORM == 'java'
+  # Only require the debugger on MRI
+  require 'debugger'
+  require 'debugger/pry'
+end
+
+RSpec.configure do |c|
+  c.include(Rack::Test::Methods, :type => :integration)
+  c.before(:all, :type => :integration) do
+  end
+end
+
+
+require 'sinatra/base'
+class TestApp < Sinatra::Base
+  use Rack::Graphite
+
+  get '/' do
+    'Hello'
+  end
+
+  put '/onelevel' do
+    'Thanks'
+  end
+
+  get '/onelevel' do
+    'Hello One Level'
+  end
+
+  get '/two/levels' do
+    'Hello Two Levels'
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: rack-graphite
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- R. Tyler Croy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: lookout-statsd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple Rack middleware for logging request counts/timing information
+email:
+- rtyler.croy@lookout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack/graphite.rb
+- rack-graphite.gemspec
+- spec/graphite_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lookout/rack-graphite
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1834689501216258839
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1834689501216258839
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Simple Rack middleware for logging request counts/timing information
+test_files:
+- spec/graphite_spec.rb
+- spec/spec_helper.rb