rack-instrument 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fecc12632b181a794b76c07ebd53bef7441b6e70
+  data.tar.gz: 8632c4c9bf2243d3f26a0c19669b15827e6b3c12
+SHA512:
+  metadata.gz: 3a7a3e1d6ab3c45322e8b0375de35b42d3bff5a0de9527d9a47da61d8cef9f42dc88332702abdb6b8a404248376684124375f035e630ac967571b89f19b981b0
+  data.tar.gz: a31516d6522937fb8ca8e9dbf195d06922018c7354fa4de372735d6375e4d5d581ed646694169ff07ce7363c8d549fb75ed1ec671c5e45416f55574a29c1dd97

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 brookemckim
+
+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,51 @@
+# Rack::Instrument
+
+Rack::Instrument is a rack middleware for instrumenting request time,
+total requests, and total requests per path. I am testing with
+[statsd](https://github.com/reinh/statsd) as an instrumenter, but you can use any 
+object that responds to increment or timing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-instrument'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-instrument
+
+## Usage
+
+```ruby
+require 'rack/instrument'
+require 'statsd'
+
+# Instansiate your instrumenter.
+statsd = Statsd.new 'localhost'
+statsd.namespace = 'myapp'
+
+# Pass the instrumentor along with an Array of the metrics you would
+# like. 
+#
+#  Metrics
+#    :request - Increments the total request count.
+#    :time    - Records total request time.
+#    :path    - Increments the total request count per path.
+use Rack::Instrument, statsd, [:request, :time, :path]
+```
+
+Check the examples directory for more examples.
+
+## Contributing
+
+1. Fork it
+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 @@
+require "bundler/gem_tasks"

data/examples/config.ru

@@ -0,0 +1,17 @@
+# Example rack application that uses statsd-ruby for instrumentation
+
+require 'rack'
+require 'rack/instrument'
+require 'statsd' # https://github.com/reinh/statsd
+
+statsd = Statsd.new 'localhost'
+statsd.namespace = 'myapp'
+
+use Rack::Instrument, statsd, [:request, :time, :path]
+
+map '/' do
+  run lambda { |env|
+    [200, {}, ["Instrumenting is Instrumental\n"]]
+  }
+end
+

data/lib/rack/instrument.rb

@@ -0,0 +1,79 @@
+require 'rack'
+
+class Rack::Instrument
+  # This can be used as the instrument in order to disable instrumentation
+  # without removing it completely.
+  #
+  # use Rack::Instrument, Rack::Instrument::NullInstrument.new
+  class NullInstrument
+    def increment(*args); end
+    def timing(*args); end
+  end
+
+  # use Rack::Instrument, Statsd.new('localhost'), [:request, :time, :path]
+  def initialize(app, instrument, instrumentations = [])
+    @app = app
+    @instrument = instrument || NullInstrument.new
+
+    @instrument_request = instrumentations.include? :request
+    @instrument_time    = instrumentations.include? :time
+    @instrument_path    = instrumentations.include? :path
+  end
+
+  attr_accessor :instrument
+
+  # Flag for whether or not requests should be counted.
+  attr_reader :instrument_request
+
+  # Flag for whether or not requests should be timed.
+  attr_reader :instrument_time
+
+  # Flag for whether or not specific paths should be counted.
+  attr_reader :instrument_path
+
+  # Rack
+  def call(env)
+    request_start = Time.now
+
+    record_request
+    record_path(env)
+
+    status, headers, response = @app.call(env)
+
+    record_time(request_start)
+
+    [status, headers, response]
+  end
+
+  # Count the total number of requests.
+  def record_request
+    return unless instrument_request
+
+    instrument.increment 'requests'
+  end
+
+  # Instrument the total request time.
+  def record_time(request_start)
+    return unless instrument_time
+
+    request_end  = Time.now
+    request_time = (request_end - request_start) * 1000
+
+    instrument.timing 'request_time', request_time
+  end
+
+  # Count the number of times a specific path has been visited.
+  def record_path(env)
+    return unless instrument_path
+
+    # Normalize and remove leading /
+    path = env['REQUEST_PATH'].downcase.slice(1..-1)
+
+    # Convert / to _
+    path_key = path.gsub('/', '_').gsub('.', '_')
+    path_key = 'index' if path_key.empty?
+
+    instrument.increment 'requests.' + path_key
+  end
+end
+

data/rack-instrument.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-instrument'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Brooke McKim']
+  spec.email         = ['brooke.mckim@gmail.com']
+  spec.description   = %q{Rack middleware for recording request metrics}
+  spec.summary       = %q{Rack::Instrument is a rack middleware for instrumenting request time, total requests, and total requests per path.}
+  spec.homepage      = "https://github.com/brookemckim/rack-instrument"
+  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_development_dependency 'rake'
+
+  spec.add_dependency 'rack'
+end
+

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: rack-instrument
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brooke McKim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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: Rack middleware for recording request metrics
+email:
+- brooke.mckim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/config.ru
+- lib/rack/instrument.rb
+- rack-instrument.gemspec
+homepage: https://github.com/brookemckim/rack-instrument
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Rack::Instrument is a rack middleware for instrumenting request time, total
+  requests, and total requests per path.
+test_files: []