heroku-true-relic 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,39 @@
+heroku-true-relic
+=================
+Show accurate heroku queue time numbers in new relic
+
+## Disclaimer
+
+This is still a work in progress - please let me know if you're having trouble getting this working!
+
+## Usage
+
+### Rails 3
+```ruby
+gem 'heroku-true-relic'
+```
+
+### Rails 2
+
+```ruby
+gem 'heroku-true-relic', :require => 'heroku-true-relic/rails2'
+```
+
+
+### Rack apps (not tested, but should work fine)
+
+```ruby
+require 'heroku-true-relic'
+
+...
+
+use HerokuTrueRelic::QueueTimeLogger
+```
+
+## Running the specs
+
+* Install [rvm](http://rvm.io)
+* Git clone this repository
+* cd into the directory (make sure the `.rmvrc` file is read properly
+* `rake all:bundle`
+* `rake all:spec`

data/Rakefile

@@ -0,0 +1,56 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HerokuTrueRelic'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+desc 'Default: Run all specs.'
+task :default => 'all:spec'
+
+namespace :all do
+  desc "Run specs on all spec apps"
+  task :spec do
+    for_each_directory_of('spec/**/Rakefile', "Failed to run specs") do |directory|
+      system("BUNDLE_GEMFILE='./Gemfile' bundle exec rake spec")
+    end
+  end
+
+  desc "Bundle all spec apps"
+  task :bundle do
+    for_each_directory_of('spec/**/Gemfile', 'Failed to bundle') do |directory|
+      system("BUNDLE_GEMFILE='./Gemfile' bundle install")
+    end
+  end
+end
+
+def for_each_directory_of(path, fail_msg, &block)
+  results = Dir[path].sort.map do |file|
+    directory = File.dirname(file)
+    puts '', "\033[44m#{directory}\033[0m", ''
+    result = nil
+    Dir.chdir(directory) do
+      result = block.call(directory)
+    end
+    result
+  end
+
+  fail fail_msg unless results.all?
+end

data/lib/heroku-true-relic.rb

@@ -0,0 +1,5 @@
+require 'heroku-true-relic/queue_time_logger'
+require 'heroku-true-relic/railtie' if defined?(Rails::Railtie)
+
+module HerokuTrueRelic
+end

data/lib/heroku-true-relic/queue_time_logger.rb

@@ -0,0 +1,32 @@
+module HerokuTrueRelic
+  # combination of https://gist.github.com/daveyeu/4960893
+  # and https://gist.github.com/jasonrclark/d82a1ea7695daac0b9ee
+  class QueueTimeLogger
+    attr_reader :app
+
+    def initialize(app, options = {})
+      @app = app
+    end
+
+    def call(env)
+      now = Time.now.to_f
+
+      # Delete Heroku's queue time header because it's incorrect and useless
+      env.delete("HTTP_X_HEROKU_QUEUE_WAIT_TIME")
+
+      microseconds = (now * 1_000_000).to_i
+      env["HTTP_X_MIDDLEWARE_START"] = "t=#{microseconds}"
+
+      if env["HTTP_X_REQUEST_START"]
+        # HTTP_X_REQUEST_START is expected by New Relic to have a t= leading
+        # but currently doesn't, so it can just get to_i applied.
+        request_start_microseconds = env["HTTP_X_REQUEST_START"].to_i * 1_000
+        queue_time_microseconds = [microseconds - request_start_microseconds, 0].max
+
+        env["HTTP_X_QUEUE_TIME"] = "t=#{queue_time_microseconds}"
+      end
+
+      app.call(env)
+    end
+  end
+end

data/lib/heroku-true-relic/rails2.rb

@@ -0,0 +1,13 @@
+require 'heroku-true-relic'
+
+module HerokuTrueRelic
+  class Rails2
+    def self.add_middleware
+      if defined?(::Rails.configuration) && ::Rails.configuration.respond_to?(:middleware)
+        ::Rails.configuration.middleware.insert_after 'Rack::Lock', HerokuTrueRelic::QueueTimeLogger
+      end
+    end
+  end
+end
+
+HerokuTrueRelic::Rails2.add_middleware

data/lib/heroku-true-relic/railtie.rb

@@ -0,0 +1,7 @@
+module HerokuTrueRelic
+  class Railtie < Rails::Railtie
+    initializer 'heroku_true_relic.add_queue_time_logger' do |app|
+      app.config.middleware.insert_after 'Rack::Lock', "HerokuTrueRelic::QueueTimeLogger"
+    end
+  end
+end

data/lib/heroku-true-relic/version.rb

@@ -0,0 +1,3 @@
+module HerokuTrueRelic
+  VERSION = "0.1.0"
+end

data/lib/tasks/heroku-true-relic_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :heroku-true-relic do
+#   # Task goes here
+# end

data/spec/rails-2.3/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+gem "rails", "~> 2.3.17"
+gem "sqlite3"
+gem 'heroku-true-relic', :path => '../..'
+
+group :test, :development do
+  gem "rspec", '1.3.2'
+  gem "rspec-rails", '1.3.4'
+  gem "pry"
+  gem "capybara"
+  gem "timecop"
+  gem 'test-unit', '1.2.3'
+end

data/spec/rails-2.3/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: ../..
+  specs:
+    heroku-true-relic (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (2.3.17)
+      actionpack (= 2.3.17)
+    actionpack (2.3.17)
+      activesupport (= 2.3.17)
+      rack (~> 1.1.0)
+    activerecord (2.3.17)
+      activesupport (= 2.3.17)
+    activeresource (2.3.17)
+      activesupport (= 2.3.17)
+    activesupport (2.3.17)
+    capybara (2.0.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 1.0.0)
+    childprocess (0.3.8)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.0.8)
+    ffi (1.4.0)
+    hoe (3.5.0)
+      rake (>= 0.8, < 11.0)
+    method_source (0.8.1)
+    mime-types (1.21)
+    multi_json (1.6.1)
+    nokogiri (1.5.6)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.1.6)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (2.3.17)
+      actionmailer (= 2.3.17)
+      actionpack (= 2.3.17)
+      activerecord (= 2.3.17)
+      activeresource (= 2.3.17)
+      activesupport (= 2.3.17)
+      rake (>= 0.8.3)
+    rake (10.0.3)
+    rspec (1.3.2)
+    rspec-rails (1.3.4)
+      rack (>= 1.0.0)
+      rspec (~> 1.3.1)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.29.0)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
+      rubyzip
+      websocket (~> 1.0.4)
+    slop (3.4.3)
+    sqlite3 (1.3.7)
+    test-unit (1.2.3)
+      hoe (>= 1.5.1)
+    timecop (0.5.9.2)
+    websocket (1.0.7)
+    xpath (1.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  heroku-true-relic!
+  pry
+  rails (~> 2.3.17)
+  rspec (= 1.3.2)
+  rspec-rails (= 1.3.4)
+  sqlite3
+  test-unit (= 1.2.3)
+  timecop

data/spec/rails-2.3/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc 'Default: Run all specs for a specific rails version.'
+task :default => :spec
+
+desc "Run all specs for a specific rails version"
+Spec::Rake::SpecTask.new() do |t|
+  t.spec_files = FileList['**/*_spec.rb', '../shared/**/*_spec.rb']
+end

data/spec/rails-2.3/app_root/config/boot.rb

@@ -0,0 +1,114 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      if load_error.message =~ /Could not find RubyGem rails/
+        STDERR.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+        exit 1
+      else
+        raise
+      end
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.2'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/spec/rails-2.3/app_root/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/rails-2.3/app_root/config/environment.rb

@@ -0,0 +1,45 @@
+# Be sure to restart your server when you modify this file
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.3.17' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Bundler.require
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence over those specified here.
+  # Application configuration should go into files in config/initializers
+  # -- all .rb files in that directory are automatically loaded.
+
+  # Add additional load paths for your own custom dirs
+  # config.autoload_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Specify gems that this application depends on and have them installed with rake gems:install
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+
+  # Only load the plugins named here, in the order given (default is alphabetical).
+  # :all can be used as a placeholder for all plugins not explicitly named
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+  # Skip frameworks you're not going to use. To use Rails without a database,
+  # you must remove the Active Record framework.
+  # config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+  # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+  # Run "rake -D time" for a list of tasks for finding time zone names.
+  config.time_zone = 'UTC'
+
+  # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+  # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
+  # config.i18n.default_locale = :de
+end
+
+require "heroku-true-relic/rails2"