rack-doge 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87761889060a812f09c81772a68b8716e3fa3c28
+  data.tar.gz: f87eefc8a9bcff2404db9a7cb7434cb23650c4b3
+SHA512:
+  metadata.gz: 77532518a884c0c7c6c510ad8313e25c9c9bee1031a02c94e8c243bca7cff4b725d7f4908064a669edecb5e161bec85585d887d1a1e84e8ed502bcf947b4abd3
+  data.tar.gz: 21b8e778f94f30b12326e0460a314a95f5bff4c51e0944daac3d6d745e9ac121af374c8c46ab31838b397097d206ccc59091e4754d4e695904cb95e6fbc11501

data/.gitignore

@@ -0,0 +1,29 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chad Bailey
+
+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,33 @@
+# rack-doge
+
+Add this gem to a Rails app to get a log line like this for each request:
+
+    at=info thread_id=70351652783840 process_id=55394 request_id=013f9cc29c1e4c483435dbc15ab260f4 pre_request=0ms rack_in=202ms app=505ms rack_out=301ms
+
+That includes:
+
+* `thread_id`: For tracking requests across threads, (e.g. Puma)
+* `process_id`: For tracking requests across workers (e.g. Puma or Unicorn)
+* `request_id`: Correlate with you app (or Heroku router) logs
+* `pre_request`: Measure the time between `HTTP_X_REQUEST_START` and the start of your rack stack (similar to New Relic's 'reuqest queueing' metric)
+* `rack_in`: The time in the rack stack before your app sees the request
+* `app`: The time spent processing the request in your app
+* `rack_out`: The time spent going back out of the rack stack
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-doge'
+
+And then execute:
+
+    $ bundle
+
+## 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/doge.rb

@@ -0,0 +1,7 @@
+require "rack/doge/version"
+
+module Rack
+  module Doge
+    # Your code goes here...
+  end
+end

data/doge/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Doge
+    VERSION = "0.0.1"
+  end
+end

data/lib/doge/base_doge.rb

@@ -0,0 +1,23 @@
+require 'doge/notify'
+module Rack
+  module Doge
+    class BaseDoge
+      include Notify
+
+      def initialize(app, logger = nil)
+        @logger  = logger
+        @app     = app
+        @instrument_name = "rack.doge"
+        @logger  = ::Logger.new($stdout) if @logger.nil?
+        # @logger.formatter = L2MetFormatter.new
+      end
+
+      protected
+
+      def time_ms
+        (Time.now.to_f * 1000.0).round
+      end
+
+    end
+  end
+end

data/lib/doge/end.rb

@@ -0,0 +1,13 @@
+module Rack
+  module Doge
+    class End < BaseDoge
+      # This middleware should run as late in the stack as possible.
+      def call(env)
+        env["RACK_IN_END"] = time_ms
+        status, headers, response = @app.call(env)
+        env["RACK_OUT_START"] = time_ms
+        [status, headers, response]
+      end
+    end
+  end
+end

data/lib/doge/notify.rb

@@ -0,0 +1,15 @@
+module Rack
+  module Doge
+    module Notify
+      def should_notify?
+        if defined?(ActiveSupport::Notifications)
+          ActiveSupport::Notifications.notifier.listening?(@instrument_name)
+        end
+      end
+
+      def notify(data)
+        ActiveSupport::Notifications.instrument(@instrument_name, data)
+      end
+    end
+  end
+end

data/lib/doge/railtie.rb

@@ -0,0 +1,11 @@
+module Rack
+  module Doge
+    class DogeRailtie < Rails::Railtie
+      initializer "doge_railtie.configure_rails_initialization" do |app|
+        app.middleware.insert 0, Rack::Doge::Start
+        app.middleware.insert 0, Rack::Doge::Reporter
+        app.middleware.use Rack::Doge::End
+      end
+    end
+  end
+end

data/lib/doge/reporter.rb

@@ -0,0 +1,41 @@
+module Rack
+  module Doge
+    class Reporter < BaseDoge
+      def call(env)
+        @metrics = {}
+
+        status, headers, response = @app.call(env)
+
+        measure_pre_request_time(env)
+        measure(:rack_in, :rack_in_start, :rack_in_end, env)
+        measure(:app, :rack_in_end, :rack_out_start, env)
+        measure(:rack_out, :rack_out_start, :rack_out_end, env)
+
+        @metrics = {thread_id: Thread.current.object_id, process_id: Process.pid, request_id: (env["action_dispatch.request_id"] || "")}.merge(@metrics)
+        notify(@metrics) if should_notify?
+        @logger.info "at=info " + @metrics.map { |k, v| "#{k}=#{v}"}.join(" ")
+
+        [status, headers, response]
+      end
+
+      private
+
+      def measure(measurement, start_time, end_time, env)
+        starting = env[start_time.to_s.upcase].to_i
+        ending   = env[end_time.to_s.upcase].to_i
+        if starting > 0 && ending > 0
+          @metrics[measurement] = (ending - starting).to_s + "ms"
+        end
+      end
+
+      def measure_pre_request_time(env)
+        if (request_start = (env["HTTP_X_REQUEST_START"] || 0).to_i) > 0
+          @metrics[:pre_request] = (env["RACK_IN_START"] - request_start).to_s + "ms"
+        else
+          @metrics[:pre_request] = "0ms"
+        end
+      end
+
+    end
+  end
+end

data/lib/doge/start.rb

@@ -0,0 +1,14 @@
+module Rack
+  module Doge
+    class Start < BaseDoge
+      # This rack should run as early in the stack as possible.
+
+      def call(env)
+        env["RACK_IN_START"] = time_ms
+        status, headers, response = @app.call(env)
+        env["RACK_OUT_END"] = time_ms
+        [status, headers, response]
+      end
+    end
+  end
+end

data/lib/doge/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Doge
+    VERSION="0.0.1"
+  end
+end

data/lib/rack-doge.rb

@@ -0,0 +1,5 @@
+require 'doge/base_doge'
+require 'doge/start'
+require 'doge/end'
+require 'doge/reporter'
+require 'doge/railtie' if defined?(Rails)

data/rack-doge.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-doge"
+  spec.version       = Rack::Doge::VERSION
+  spec.authors       = ["Chad Bailey"]
+  spec.email         = ["chad@heroku.com"]
+  spec.description   = %q{Analyze timing and process info from your Rack stack.}
+  spec.summary       = %q{Analyze timing and process info from your Rack stack.}
+  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.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: rack-doge
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chad Bailey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-31 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'
+description: Analyze timing and process info from your Rack stack.
+email:
+- chad@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doge.rb
+- doge/version.rb
+- lib/.DS_Store
+- lib/doge/base_doge.rb
+- lib/doge/end.rb
+- lib/doge/notify.rb
+- lib/doge/railtie.rb
+- lib/doge/reporter.rb
+- lib/doge/start.rb
+- lib/doge/version.rb
+- lib/rack-doge.rb
+- rack-doge.gemspec
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Analyze timing and process info from your Rack stack.
+test_files: []