scout_rails_proxy 1.0.4 → 1.0.6

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in scout_rails.gemspec
+# Specify your gem's dependencies in scout_rails_proxy.gemspec
 gemspec

data/README.markdown

@@ -1,4 +1,4 @@
-# ScoutRails
+# ScoutRailsProxy
 
 A Ruby gem for detailed Rails application performance analysis. Metrics are reported to [Scout](https://scoutapp.com), a hosted server and application monitoring service. For general server monitoring, see our [server monitoring agent](https://github.com/scoutapp/scout-client).
 
@@ -8,9 +8,9 @@ A Ruby gem for detailed Rails application performance analysis. Metrics are repo
 
 Install the gem:
 
-    gem install scout_rails
+    gem install scout_rails_proxy
     
-Signup for a [Scout](https://scoutapp.com) account and copy the config file to `RAILS_ROOT/config/scout_rails.yml`.
+Signup for a [Scout](https://scoutapp.com) account and copy the config file to `RAILS_ROOT/config/scout_rails_proxy.yml`.
 
 Your config file should look like:
 

data/lib/scout_rails_proxy.rb

@@ -0,0 +1,32 @@
+module ScoutRailsProxy
+end
+require 'socket'
+require 'set'
+require 'net/http'
+require File.expand_path('../scout_rails_proxy/version.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/agent.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/layaway.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/layaway_file.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/config.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/environment.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/metric_meta.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/metric_stats.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/stack_item.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/store.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/tracer.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/transaction_sample.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/instruments/process/process_cpu.rb', __FILE__)
+require File.expand_path('../scout_rails_proxy/instruments/process/process_memory.rb', __FILE__)
+
+if defined?(Rails) and Rails.respond_to?(:version) and Rails.version =~ /^3/
+  module ScoutRailsProxy
+    class Railtie < Rails::Railtie
+      initializer "scout_rails_proxy.start" do |app|
+        ScoutRailsProxy::Agent.instance.start
+      end
+    end
+  end
+else
+  ScoutRailsProxy::Agent.instance.start
+end
+

data/lib/{scout_rails → scout_rails_proxy}/agent.rb

@@ -1,4 +1,4 @@
-module ScoutRails
+module ScoutRailsProxy
   # The agent gathers performance data from a Ruby application. One Agent instance is created per-Ruby process. 
   #
   # Each Agent object creates a worker thread (unless monitoring is disabled or we're forking). 
@@ -33,24 +33,24 @@ module ScoutRails
     def initialize(options = {})
       @started = false
       @options ||= options
-      @store = ScoutRails::Store.new
-      @layaway = ScoutRails::Layaway.new
-      @config = ScoutRails::Config.new(options[:config_path])
+      @store = ScoutRailsProxy::Store.new
+      @layaway = ScoutRailsProxy::Layaway.new
+      @config = ScoutRailsProxy::Config.new(options[:config_path])
       @metric_lookup = Hash.new
-      @process_cpu=ScoutRails::Instruments::Process::ProcessCpu.new(environment.processors)
-      @process_memory=ScoutRails::Instruments::Process::ProcessMemory.new
+      @process_cpu=ScoutRailsProxy::Instruments::Process::ProcessCpu.new(environment.processors)
+      @process_memory=ScoutRailsProxy::Instruments::Process::ProcessMemory.new
     end
     
     def environment
-      @environment ||= ScoutRails::Environment.new
+      @environment ||= ScoutRailsProxy::Environment.new
     end
     
-    # This is called via +ScoutRails::Agent.instance.start+ when ScoutRails is required in a Ruby application.
+    # This is called via +ScoutRailsProxy::Agent.instance.start+ when ScoutRailsProxy is required in a Ruby application.
     # It initializes the agent and starts the worker thread (if appropiate).
     def start(options = {})
       @options.merge!(options)
       init_logger
-      logger.info "Attempting to start Scout Agent [#{ScoutRails::VERSION}] on [#{Socket.gethostname}]"
+      logger.info "Attempting to start Scout Agent [#{ScoutRailsProxy::VERSION}] on [#{Socket.gethostname}]"
       if !config.settings['monitor'] and !@options[:force]
         logger.warn "Monitoring isn't enabled for the [#{environment.env}] environment."
         return false
@@ -72,7 +72,7 @@ module ScoutRails
       end
       start_worker_thread
       handle_exit
-      logger.info "Scout Agent [#{ScoutRails::VERSION}] Initialized"
+      logger.info "Scout Agent [#{ScoutRailsProxy::VERSION}] Initialized"
     end
     
     # Placeholder: store metrics locally on exit so those in memory aren't lost. Need to decide
@@ -94,7 +94,7 @@ module ScoutRails
     end
     
     def init_logger
-      @log_file = "#{log_path}/scout_rails.log"
+      @log_file = "#{log_path}/scout_rails_proxy.log"
       @logger = Logger.new(@log_file)
       @logger.level = Logger::DEBUG
       def logger.format_message(severity, timestamp, progname, msg)
@@ -123,7 +123,7 @@ module ScoutRails
       Unicorn::HttpServer.class_eval do
         old = instance_method(:worker_loop)
         define_method(:worker_loop) do |worker|
-          ScoutRails::Agent.instance.start_worker_thread
+          ScoutRailsProxy::Agent.instance.start_worker_thread
           old.bind(self).call(worker)
         end
       end
@@ -316,4 +316,4 @@ module ScoutRails
     end
     
   end # class Agent
-end # module ScoutRails
+end # module ScoutRailsProxy

data/lib/scout_rails_proxy/config.rb

@@ -0,0 +1,34 @@
+module ScoutRailsProxy
+  class Config
+    def initialize(config_path = nil)
+      @config_path = config_path
+    end
+    
+    def settings
+      return @settings if @settings
+      load_file
+    end
+    
+    def config_path
+      @config_path || File.join(ScoutRailsProxy::Agent.instance.environment.root,"config","scout_rails_proxy.yml")
+    end
+    
+    def config_file
+      File.expand_path(config_path)
+    end
+    
+    def load_file
+      if !File.exist?(config_file)
+        ScoutRailsProxy::Agent.instance.logger.warn "No config file found at [#{config_file}]."
+        @settings = {}
+      else
+        @settings = YAML.load(ERB.new(File.read(config_file)).result(binding))[ScoutRailsProxy::Agent.instance.environment.env] || {} 
+      end  
+    rescue Exception => e
+      ScoutRailsProxy::Agent.instance.logger.warn "Unable to load the config file."
+      ScoutRailsProxy::Agent.instance.logger.warn e.message
+      ScoutRailsProxy::Agent.instance.logger.warn e.backtrace
+      @settings = {}
+    end
+  end
+end

data/lib/{scout_rails → scout_rails_proxy}/environment.rb

@@ -1,5 +1,5 @@
 # Used to retrieve environment information for this application.
-module ScoutRails
+module ScoutRailsProxy
   class Environment
     def env
       @env ||= case framework

data/lib/{scout_rails → scout_rails_proxy}/instruments/active_record_instruments.rb

@@ -1,9 +1,9 @@
-module ScoutRails::Instruments
+module ScoutRailsProxy::Instruments
   # Contains ActiveRecord instrument, aliasing +ActiveRecord::ConnectionAdapters::AbstractAdapter#log+ calls
   # to trace calls to the database. 
   module ActiveRecordInstruments
     def self.included(instrumented_class)
-      ScoutRails::Agent.instance.logger.debug "Instrumenting #{instrumented_class.inspect}"
+      ScoutRailsProxy::Agent.instance.logger.debug "Instrumenting #{instrumented_class.inspect}"
       instrumented_class.class_eval do
         unless instrumented_class.method_defined?(:log_without_scout_instruments)
           alias_method :log_without_scout_instruments, :log
@@ -62,20 +62,20 @@ end # module Instruments
 def add_instruments
   if defined?(ActiveRecord) && defined?(ActiveRecord::Base)
     ActiveRecord::ConnectionAdapters::AbstractAdapter.module_eval do
-      include ::ScoutRails::Instruments::ActiveRecordInstruments
-      include ::ScoutRails::Tracer
+      include ::ScoutRailsProxy::Instruments::ActiveRecordInstruments
+      include ::ScoutRailsProxy::Tracer
     end
     ActiveRecord::Base.class_eval do
-       include ::ScoutRails::Tracer
+       include ::ScoutRailsProxy::Tracer
     end
   end
 rescue
-  ScoutRails::Agent.instance.logger.warn "ActiveRecord instrumentation exception: #{$!.message}"
+  ScoutRailsProxy::Agent.instance.logger.warn "ActiveRecord instrumentation exception: #{$!.message}"
 end
 
 if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i == 3
   Rails.configuration.after_initialize do
-    ScoutRails::Agent.instance.logger.debug "Adding ActiveRecord instrumentation to a Rails 3 app"
+    ScoutRailsProxy::Agent.instance.logger.debug "Adding ActiveRecord instrumentation to a Rails 3 app"
     add_instruments
   end
 else

data/lib/{scout_rails → scout_rails_proxy}/instruments/net_http.rb

@@ -1,7 +1,7 @@
 if defined?(::Net) && defined?(Net::HTTP)
-  ScoutRails::Agent.instance.logger.debug "Instrumenting Net::HTTP"
+  ScoutRailsProxy::Agent.instance.logger.debug "Instrumenting Net::HTTP"
   Net::HTTP.class_eval do
-    include ScoutRails::Tracer
+    include ScoutRailsProxy::Tracer
     
     def request_with_scout_instruments(*args,&block)
       self.class.instrument("HTTP/request", :desc => "#{(@address+args.first.path.split('?').first)[0..99]}") do

data/lib/{scout_rails → scout_rails_proxy}/instruments/process/process_cpu.rb

@@ -1,4 +1,4 @@
-module ScoutRails::Instruments
+module ScoutRailsProxy::Instruments
   module Process
     class ProcessCpu
       def initialize(num_processors)

data/lib/{scout_rails → scout_rails_proxy}/instruments/process/process_memory.rb

@@ -1,4 +1,4 @@
-module ScoutRails::Instruments
+module ScoutRailsProxy::Instruments
   module Process
     class ProcessMemory
       def run

data/lib/{scout_rails → scout_rails_proxy}/instruments/rails/action_controller_instruments.rb

@@ -1,7 +1,7 @@
-module ScoutRails::Instruments
+module ScoutRailsProxy::Instruments
   module ActionControllerInstruments
     def self.included(instrumented_class)
-      ScoutRails::Agent.instance.logger.debug "Instrumenting #{instrumented_class.inspect}"
+      ScoutRailsProxy::Agent.instance.logger.debug "Instrumenting #{instrumented_class.inspect}"
       instrumented_class.class_eval do
         unless instrumented_class.method_defined?(:perform_action_without_scout_instruments)
           alias_method :perform_action_without_scout_instruments, :perform_action
@@ -25,12 +25,12 @@ end
 
 if defined?(ActionController) && defined?(ActionController::Base)
   ActionController::Base.class_eval do
-    include ScoutRails::Tracer
-    include ::ScoutRails::Instruments::ActionControllerInstruments
+    include ScoutRailsProxy::Tracer
+    include ::ScoutRailsProxy::Instruments::ActionControllerInstruments
 
     def rescue_action_with_scout(exception)
-      ScoutRails::Agent.instance.store.track!("Errors/Request",1, :scope => nil)
-      ScoutRails::Agent.instance.store.ignore_transaction!
+      ScoutRailsProxy::Agent.instance.store.track!("Errors/Request",1, :scope => nil)
+      ScoutRailsProxy::Agent.instance.store.ignore_transaction!
       rescue_action_without_scout exception
     end
 
@@ -38,9 +38,9 @@ if defined?(ActionController) && defined?(ActionController::Base)
     alias_method :rescue_action, :rescue_action_with_scout
     protected :rescue_action
   end
-  ScoutRails::Agent.instance.logger.debug "Instrumenting ActionView::Template"
+  ScoutRailsProxy::Agent.instance.logger.debug "Instrumenting ActionView::Template"
   ActionView::Template.class_eval do
-    include ::ScoutRails::Tracer
+    include ::ScoutRailsProxy::Tracer
     instrument_method :render, :metric_name => 'View/#{path[%r{^(/.*/)?(.*)$},2]}/Rendering', :scope => true
   end
 end

data/lib/{scout_rails → scout_rails_proxy}/instruments/rails3/action_controller_instruments.rb

@@ -1,15 +1,15 @@
 # Rails 3
-module ScoutRails::Instruments
+module ScoutRailsProxy::Instruments
   module ActionControllerInstruments
     # Instruments the action and tracks errors.
     def process_action(*args)
       scout_controller_action = "Controller/#{controller_path}/#{action_name}"
-      #ScoutRails::Agent.instance.logger.debug "Processing #{scout_controller_action}"
+      #ScoutRailsProxy::Agent.instance.logger.debug "Processing #{scout_controller_action}"
       self.class.trace(scout_controller_action, :uri => request.fullpath) do
         begin
           super
         rescue Exception => e
-          ScoutRails::Agent.instance.store.track!("Errors/Request",1, :scope => nil)
+          ScoutRailsProxy::Agent.instance.store.track!("Errors/Request",1, :scope => nil)
           raise
         ensure
           Thread::current[:scout_scope_name] = nil
@@ -22,17 +22,17 @@ end
 # ActionController::Base is a subclass of ActionController::Metal, so this instruments both
 # standard Rails requests + Metal.
 if defined?(ActionController) && defined?(ActionController::Metal)
-  ScoutRails::Agent.instance.logger.debug "Instrumenting ActionController::Metal"
+  ScoutRailsProxy::Agent.instance.logger.debug "Instrumenting ActionController::Metal"
   ActionController::Metal.class_eval do
-    include ScoutRails::Tracer
-    include ::ScoutRails::Instruments::ActionControllerInstruments
+    include ScoutRailsProxy::Tracer
+    include ::ScoutRailsProxy::Instruments::ActionControllerInstruments
   end
 end
 
 if defined?(ActionView) && defined?(ActionView::PartialRenderer)
-  ScoutRails::Agent.instance.logger.debug "Instrumenting ActionView::PartialRenderer"
+  ScoutRailsProxy::Agent.instance.logger.debug "Instrumenting ActionView::PartialRenderer"
   ActionView::PartialRenderer.class_eval do
-    include ScoutRails::Tracer
+    include ScoutRailsProxy::Tracer
     instrument_method :render_partial, :metric_name => 'View/#{@template.virtual_path}/Rendering', :scope => true
   end
 end

data/lib/{scout_rails → scout_rails_proxy}/instruments/sinatra_instruments.rb

@@ -1,4 +1,4 @@
-module ScoutRails::Instruments
+module ScoutRailsProxy::Instruments
   module SinatraInstruments
     def route_eval_with_scout_instruments(&blockarg)
       path = unescape(@request.path_info)
@@ -20,13 +20,13 @@ module ScoutRails::Instruments
       end
     end # route_eval_with_scout_instrumentss
   end # SinatraInstruments
-end # ScoutRails::Instruments
+end # ScoutRailsProxy::Instruments
 
 if defined?(::Sinatra) && defined?(::Sinatra::Base)
-  ScoutRails::Agent.instance.logger.debug "Instrumenting Sinatra"
+  ScoutRailsProxy::Agent.instance.logger.debug "Instrumenting Sinatra"
   ::Sinatra::Base.class_eval do
-    include ScoutRails::Tracer
-    include ::ScoutRails::Instruments::SinatraInstruments
+    include ScoutRailsProxy::Tracer
+    include ::ScoutRailsProxy::Instruments::SinatraInstruments
     alias route_eval_without_scout_instruments route_eval
     alias route_eval route_eval_with_scout_instruments
   end

data/lib/{scout_rails → scout_rails_proxy}/layaway.rb

@@ -4,21 +4,21 @@
 # 
 # Metrics are stored in a Hash, where the keys are Time.to_i on the minute. When depositing data, 
 # metrics are either merged with an existing time or placed in a new key.
-class ScoutRails::Layaway
+class ScoutRailsProxy::Layaway
   attr_accessor :file
   def initialize
-    @file = ScoutRails::LayawayFile.new
+    @file = ScoutRailsProxy::LayawayFile.new
   end
   
   def deposit_and_deliver
-    new_data = ScoutRails::Agent.instance.store.metric_hash
+    new_data = ScoutRailsProxy::Agent.instance.store.metric_hash
     controller_count = 0
     new_data.each do |meta,stats|
       if meta.metric_name =~ /\AController/
         controller_count += stats.call_count
       end
     end
-    ScoutRails::Agent.instance.logger.debug "Depositing #{controller_count} requests into #{Time.at(slot).strftime("%m/%d/%y %H:%M:%S %z")} slot."
+    ScoutRailsProxy::Agent.instance.logger.debug "Depositing #{controller_count} requests into #{Time.at(slot).strftime("%m/%d/%y %H:%M:%S %z")} slot."
     
     to_deliver = {}
     file.read_and_write do |old_data|
@@ -29,12 +29,12 @@ class ScoutRails::Layaway
         to_deliver = old_data
         old_data = Hash.new
       elsif old_data.any?
-        ScoutRails::Agent.instance.logger.debug "Not yet time to deliver metrics for slot [#{Time.at(old_data.keys.sort.last).strftime("%m/%d/%y %H:%M:%S %z")}]"
+        ScoutRailsProxy::Agent.instance.logger.debug "Not yet time to deliver metrics for slot [#{Time.at(old_data.keys.sort.last).strftime("%m/%d/%y %H:%M:%S %z")}]"
       else
-        ScoutRails::Agent.instance.logger.debug "There is no data in the layaway file to deliver."
+        ScoutRailsProxy::Agent.instance.logger.debug "There is no data in the layaway file to deliver."
       end
-      old_data[slot]=ScoutRails::Agent.instance.store.merge_data_and_clear(old_data[slot] || Hash.new)
-      ScoutRails::Agent.instance.logger.debug "Saving the following #{old_data.size} time slots locally:"
+      old_data[slot]=ScoutRailsProxy::Agent.instance.store.merge_data_and_clear(old_data[slot] || Hash.new)
+      ScoutRailsProxy::Agent.instance.logger.debug "Saving the following #{old_data.size} time slots locally:"
       old_data.each do |k,v|
         controller_count = 0
         new_data.each do |meta,stats|
@@ -42,7 +42,7 @@ class ScoutRails::Layaway
             controller_count += stats.call_count
           end
         end
-        ScoutRails::Agent.instance.logger.debug "#{Time.at(k).strftime("%m/%d/%y %H:%M:%S %z")} => #{controller_count} requests"
+        ScoutRailsProxy::Agent.instance.logger.debug "#{Time.at(k).strftime("%m/%d/%y %H:%M:%S %z")} => #{controller_count} requests"
       end
       old_data
     end
@@ -58,14 +58,14 @@ class ScoutRails::Layaway
     data = data.to_a.sort
     now = Time.now
     if (most_recent = data.first.first) < now.to_i - 2*60
-      ScoutRails::Agent.instance.logger.debug "Local Storage is stale (#{Time.at(most_recent).strftime("%m/%d/%y %H:%M:%S %z")}). Not sending data."
+      ScoutRailsProxy::Agent.instance.logger.debug "Local Storage is stale (#{Time.at(most_recent).strftime("%m/%d/%y %H:%M:%S %z")}). Not sending data."
       {}
     else
       data.first.last
     end
   rescue
-    ScoutRails::Agent.instance.logger.debug $!.message
-    ScoutRails::Agent.instance.logger.debug $!.backtrace
+    ScoutRailsProxy::Agent.instance.logger.debug $!.message
+    ScoutRailsProxy::Agent.instance.logger.debug $!.backtrace
   end
   
   def slot

data/lib/{scout_rails → scout_rails_proxy}/layaway_file.rb

@@ -1,7 +1,7 @@
 # Logic for the serialized file access
-class ScoutRails::LayawayFile
+class ScoutRailsProxy::LayawayFile
   def path
-    "#{ScoutRails::Agent.instance.log_path}/scout_rails.db"
+    "#{ScoutRailsProxy::Agent.instance.log_path}/scout_rails_proxy.db"
   end
 
   def dump(object)
@@ -10,13 +10,13 @@ class ScoutRails::LayawayFile
 
   def load(dump)
     if dump.size == 0
-      ScoutRails::Agent.instance.logger.debug("No data in layaway file.")
+      ScoutRailsProxy::Agent.instance.logger.debug("No data in layaway file.")
       return nil
     end
     Marshal.load(dump)
   rescue ArgumentError, TypeError => e
-    ScoutRails::Agent.instance.logger.debug("Error loading data from layaway file: #{e.inspect}")
-    ScoutRails::Agent.instance.logger.debug(e.backtrace.inspect)
+    ScoutRailsProxy::Agent.instance.logger.debug("Error loading data from layaway file: #{e.inspect}")
+    ScoutRailsProxy::Agent.instance.logger.debug(e.backtrace.inspect)
     nil
   end
 
@@ -35,8 +35,8 @@ class ScoutRails::LayawayFile
       end
     end
   rescue Errno::ENOENT, Exception  => e
-    ScoutRails::Agent.instance.logger.error(e.message)
-    ScoutRails::Agent.instance.logger.debug(e.backtrace.split("\n"))
+    ScoutRailsProxy::Agent.instance.logger.error(e.message)
+    ScoutRailsProxy::Agent.instance.logger.debug(e.backtrace.split("\n"))
   end
 
   def get_data(f)

data/lib/{scout_rails → scout_rails_proxy}/metric_meta.rb

@@ -1,5 +1,5 @@
 # Contains the meta information associated with a metric. Used to lookup Metrics in to Store's metric_hash.
-class ScoutRails::MetricMeta
+class ScoutRailsProxy::MetricMeta
   def initialize(metric_name, options = {})
     @metric_name = metric_name
     @metric_id = nil

data/lib/{scout_rails → scout_rails_proxy}/metric_stats.rb

@@ -1,5 +1,5 @@
 # Stats that are associated with each instrumented method. 
-class ScoutRails::MetricStats
+class ScoutRailsProxy::MetricStats
   attr_accessor :call_count
   attr_accessor :min_call_time
   attr_accessor :max_call_time

data/lib/{scout_rails → scout_rails_proxy}/stack_item.rb

@@ -1,4 +1,4 @@
-class ScoutRails::StackItem
+class ScoutRailsProxy::StackItem
   attr_accessor :children_time
   attr_reader :metric_name, :start_time 
   

data/lib/{scout_rails → scout_rails_proxy}/store.rb

@@ -1,6 +1,6 @@
 # The store encapsolutes the logic that (1) saves instrumented data by Metric name to memory and (2) maintains a stack (just an Array)
-# of instrumented methods that are being called. It's accessed via +ScoutRails::Agent.instance.store+. 
-class ScoutRails::Store
+# of instrumented methods that are being called. It's accessed via +ScoutRailsProxy::Agent.instance.store+. 
+class ScoutRailsProxy::Store
   attr_accessor :metric_hash
   attr_accessor :transaction_hash
   attr_accessor :stack
@@ -36,7 +36,7 @@ class ScoutRails::Store
   # (2) Adds a StackItem to the stack. This StackItem is returned and later used to validate the item popped off the stack
   # when an instrumented code block completes.
   def record(metric_name)
-    item = ScoutRails::StackItem.new(metric_name)
+    item = ScoutRailsProxy::StackItem.new(metric_name)
     stack << item
     item
   end
@@ -51,7 +51,7 @@ class ScoutRails::Store
     # unbalanced stack check - unreproducable cases have seen this occur. when it does, sets a Thread variable 
     # so we ignore further recordings. +Store#reset_transaction!+ resets this. 
     if item != sanity_check_item
-      ScoutRails::Agent.instance.logger.warn "Scope [#{Thread::current[:scout_scope_name]}] Popped off stack: #{item.inspect} Expected: #{sanity_check_item.inspect}. Aborting."
+      ScoutRailsProxy::Agent.instance.logger.warn "Scope [#{Thread::current[:scout_scope_name]}] Popped off stack: #{item.inspect} Expected: #{sanity_check_item.inspect}. Aborting."
       ignore_transaction!
       return
     end
@@ -59,14 +59,14 @@ class ScoutRails::Store
     if last=stack.last
       last.children_time += duration
     end
-    meta = ScoutRails::MetricMeta.new(item.metric_name, :desc => options[:desc])
+    meta = ScoutRailsProxy::MetricMeta.new(item.metric_name, :desc => options[:desc])
     meta.scope = nil if stack_empty
     
     # add backtrace for slow calls ... how is exclusive time handled?
     if duration > 0.5 and !stack_empty
       meta.extra = {:backtrace => caller.find_all { |c| c =~ /\/app\//}}
     end
-    stat = transaction_hash[meta] || ScoutRails::MetricStats.new(!stack_empty)
+    stat = transaction_hash[meta] || ScoutRailsProxy::MetricStats.new(!stack_empty)
     
     stat.update!(duration,duration-item.children_time)
     transaction_hash[meta] = stat   
@@ -101,9 +101,9 @@ class ScoutRails::Store
     categories = categories(metrics)
     aggregates = {}
     categories.each do |cat|
-      agg_meta=ScoutRails::MetricMeta.new("#{cat}/all")
+      agg_meta=ScoutRailsProxy::MetricMeta.new("#{cat}/all")
       agg_meta.scope = parent_meta.metric_name
-      agg_stats = ScoutRails::MetricStats.new
+      agg_stats = ScoutRailsProxy::MetricStats.new
       metrics.each do |meta,stats|
         if meta.metric_name =~ /\A#{cat}\//
           agg_stats.combine!(stats) 
@@ -118,7 +118,7 @@ class ScoutRails::Store
   def store_sample(uri,transaction_hash,parent_meta,parent_stat,options = {})    
     @transaction_sample_lock.synchronize do
       if parent_stat.total_call_time >= 2 and (@sample.nil? or (@sample and parent_stat.total_call_time > @sample.total_call_time))
-        @sample = ScoutRails::TransactionSample.new(uri,parent_meta.metric_name,parent_stat.total_call_time,transaction_hash.dup)
+        @sample = ScoutRailsProxy::TransactionSample.new(uri,parent_meta.metric_name,parent_stat.total_call_time,transaction_hash.dup)
       end
     end
   end
@@ -130,9 +130,9 @@ class ScoutRails::Store
   # :scope => If provided, overrides the default scope. 
   # :exclusive_time => Sets the exclusive time for the method. If not provided, uses +call_time+.
   def track!(metric_name,call_time,options = {})
-     meta = ScoutRails::MetricMeta.new(metric_name)
+     meta = ScoutRailsProxy::MetricMeta.new(metric_name)
      meta.scope = options[:scope] if options.has_key?(:scope)
-     stat = metric_hash[meta] || ScoutRails::MetricStats.new
+     stat = metric_hash[meta] || ScoutRailsProxy::MetricStats.new
      stat.update!(call_time,options[:exclusive_time] || call_time)
      metric_hash[meta] = stat
   end

data/lib/{scout_rails → scout_rails_proxy}/tracer.rb

@@ -6,7 +6,7 @@
 #   we created earlier. 
 # * Once verified, the metrics for the recording session are merged into the in-memory Store#metric_hash. The current scope
 #   is also set for the metric (if Thread::current[:scout_scope_name] isn't nil).
-module ScoutRails::Tracer
+module ScoutRailsProxy::Tracer
   def self.included(klass)
     klass.extend ClassMethods
   end
@@ -15,7 +15,7 @@ module ScoutRails::Tracer
     
     # Use to trace a method call, possibly reporting slow transaction traces to Scout. 
     def trace(metric_name, options = {}, &block)
-      ScoutRails::Agent.instance.store.reset_transaction!      
+      ScoutRailsProxy::Agent.instance.store.reset_transaction!      
       instrument(metric_name, options) do
         Thread::current[:scout_scope_name] = metric_name
         yield
@@ -29,23 +29,23 @@ module ScoutRails::Tracer
     def instrument(metric_name, options={}, &block)
       # don't instrument if (1) NOT inside a transaction and (2) NOT a Controller metric.
       if !Thread::current[:scout_scope_name] and metric_name !~ /\AController\//
-        ScoutRails::Agent.instance.logger.debug "Not instrumenting [#{metric_name}] - no scope."
+        ScoutRailsProxy::Agent.instance.logger.debug "Not instrumenting [#{metric_name}] - no scope."
         return yield
       end
       if options.delete(:scope)
         Thread::current[:scout_sub_scope] = metric_name 
       end
-      stack_item = ScoutRails::Agent.instance.store.record(metric_name)
+      stack_item = ScoutRailsProxy::Agent.instance.store.record(metric_name)
       begin
         yield
       ensure
         Thread::current[:scout_sub_scope] = nil if Thread::current[:scout_sub_scope] == metric_name
-        ScoutRails::Agent.instance.store.stop_recording(stack_item,options)
+        ScoutRailsProxy::Agent.instance.store.stop_recording(stack_item,options)
       end
     end
     
     def instrument_method(method,options = {})
-      ScoutRails::Agent.instance.logger.info "Instrumenting #{method}"
+      ScoutRailsProxy::Agent.instance.logger.info "Instrumenting #{method}"
       metric_name = options[:metric_name] || default_metric_name(method)
       return if !instrumentable?(method) or instrumented?(method,metric_name)
       class_eval instrumented_method_string(method, {:metric_name => metric_name, :scope => options[:scope]}), __FILE__, __LINE__
@@ -69,14 +69,14 @@ module ScoutRails::Tracer
     # The method must exist to be instrumented.
     def instrumentable?(method)
       exists = method_defined?(method) || private_method_defined?(method)
-      ScoutRails::Agent.instance.logger.warn "The method [#{self.name}##{method}] does not exist and will not be instrumented" unless exists
+      ScoutRailsProxy::Agent.instance.logger.warn "The method [#{self.name}##{method}] does not exist and will not be instrumented" unless exists
       exists
     end
     
     # +True+ if the method is already instrumented. 
     def instrumented?(method,metric_name)
       instrumented = method_defined?(_instrumented_method_name(method, metric_name))
-      ScoutRails::Agent.instance.logger.warn "The method [#{self.name}##{method}] has already been instrumented" if instrumented
+      ScoutRailsProxy::Agent.instance.logger.warn "The method [#{self.name}##{method}] has already been instrumented" if instrumented
       instrumented
     end
     

data/lib/{scout_rails → scout_rails_proxy}/transaction_sample.rb

@@ -1,4 +1,4 @@
-class ScoutRails::TransactionSample
+class ScoutRailsProxy::TransactionSample
   attr_reader :metric_name, :total_call_time, :metrics, :meta, :uri
   
   def initialize(uri,metric_name,total_call_time,metrics)

data/lib/scout_rails_proxy/version.rb

@@ -0,0 +1,3 @@
+module ScoutRailsProxy
+  VERSION = "1.0.6"
+end

data/{scout_rails.gemspec → scout_rails_proxy.gemspec}

@@ -1,17 +1,17 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "scout_rails/version"
+require "scout_rails_proxy/version"
 
 Gem::Specification.new do |s|
   s.name        = "scout_rails_proxy"
-  s.version     = ScoutRails::VERSION
+  s.version     = ScoutRailsProxy::VERSION
   s.authors     = ["Derek Haynes",'Andre Lewis','Bastian Schumacher']
   s.email       = ["support@scoutapp.com"]
-  s.homepage    = "https://github.com/scoutapp/scout_rails"
+  s.homepage    = "https://github.com/scoutapp/scout_rails_proxy"
   s.summary     = "Rails application performance monitoring with proxy support"
   s.description = "Monitors a Ruby on Rails application and reports detailed metrics on performance to Scout, a hosted monitoring service."
 
-  # s.rubyforge_project = "scout_rails"
+  # s.rubyforge_project = "scout_rails_proxy"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_rails_proxy
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -27,28 +27,28 @@ files:
 - Gemfile
 - README.markdown
 - Rakefile
-- lib/scout_rails.rb
-- lib/scout_rails/agent.rb
-- lib/scout_rails/config.rb
-- lib/scout_rails/environment.rb
-- lib/scout_rails/instruments/active_record_instruments.rb
-- lib/scout_rails/instruments/net_http.rb
-- lib/scout_rails/instruments/process/process_cpu.rb
-- lib/scout_rails/instruments/process/process_memory.rb
-- lib/scout_rails/instruments/rails/action_controller_instruments.rb
-- lib/scout_rails/instruments/rails3/action_controller_instruments.rb
-- lib/scout_rails/instruments/sinatra_instruments.rb
-- lib/scout_rails/layaway.rb
-- lib/scout_rails/layaway_file.rb
-- lib/scout_rails/metric_meta.rb
-- lib/scout_rails/metric_stats.rb
-- lib/scout_rails/stack_item.rb
-- lib/scout_rails/store.rb
-- lib/scout_rails/tracer.rb
-- lib/scout_rails/transaction_sample.rb
-- lib/scout_rails/version.rb
-- scout_rails.gemspec
-homepage: https://github.com/scoutapp/scout_rails
+- lib/scout_rails_proxy.rb
+- lib/scout_rails_proxy/agent.rb
+- lib/scout_rails_proxy/config.rb
+- lib/scout_rails_proxy/environment.rb
+- lib/scout_rails_proxy/instruments/active_record_instruments.rb
+- lib/scout_rails_proxy/instruments/net_http.rb
+- lib/scout_rails_proxy/instruments/process/process_cpu.rb
+- lib/scout_rails_proxy/instruments/process/process_memory.rb
+- lib/scout_rails_proxy/instruments/rails/action_controller_instruments.rb
+- lib/scout_rails_proxy/instruments/rails3/action_controller_instruments.rb
+- lib/scout_rails_proxy/instruments/sinatra_instruments.rb
+- lib/scout_rails_proxy/layaway.rb
+- lib/scout_rails_proxy/layaway_file.rb
+- lib/scout_rails_proxy/metric_meta.rb
+- lib/scout_rails_proxy/metric_stats.rb
+- lib/scout_rails_proxy/stack_item.rb
+- lib/scout_rails_proxy/store.rb
+- lib/scout_rails_proxy/tracer.rb
+- lib/scout_rails_proxy/transaction_sample.rb
+- lib/scout_rails_proxy/version.rb
+- scout_rails_proxy.gemspec
+homepage: https://github.com/scoutapp/scout_rails_proxy
 licenses: []
 post_install_message: 
 rdoc_options: []

data/lib/scout_rails.rb

@@ -1,32 +0,0 @@
-module ScoutRails
-end
-require 'socket'
-require 'set'
-require 'net/http'
-require File.expand_path('../scout_rails/version.rb', __FILE__)
-require File.expand_path('../scout_rails/agent.rb', __FILE__)
-require File.expand_path('../scout_rails/layaway.rb', __FILE__)
-require File.expand_path('../scout_rails/layaway_file.rb', __FILE__)
-require File.expand_path('../scout_rails/config.rb', __FILE__)
-require File.expand_path('../scout_rails/environment.rb', __FILE__)
-require File.expand_path('../scout_rails/metric_meta.rb', __FILE__)
-require File.expand_path('../scout_rails/metric_stats.rb', __FILE__)
-require File.expand_path('../scout_rails/stack_item.rb', __FILE__)
-require File.expand_path('../scout_rails/store.rb', __FILE__)
-require File.expand_path('../scout_rails/tracer.rb', __FILE__)
-require File.expand_path('../scout_rails/transaction_sample.rb', __FILE__)
-require File.expand_path('../scout_rails/instruments/process/process_cpu.rb', __FILE__)
-require File.expand_path('../scout_rails/instruments/process/process_memory.rb', __FILE__)
-
-if defined?(Rails) and Rails.respond_to?(:version) and Rails.version =~ /^3/
-  module ScoutRails
-    class Railtie < Rails::Railtie
-      initializer "scout_rails.start" do |app|
-        ScoutRails::Agent.instance.start
-      end
-    end
-  end
-else
-  ScoutRails::Agent.instance.start
-end
-

data/lib/scout_rails/config.rb

@@ -1,34 +0,0 @@
-module ScoutRails
-  class Config
-    def initialize(config_path = nil)
-      @config_path = config_path
-    end
-    
-    def settings
-      return @settings if @settings
-      load_file
-    end
-    
-    def config_path
-      @config_path || File.join(ScoutRails::Agent.instance.environment.root,"config","scout_rails.yml")
-    end
-    
-    def config_file
-      File.expand_path(config_path)
-    end
-    
-    def load_file
-      if !File.exist?(config_file)
-        ScoutRails::Agent.instance.logger.warn "No config file found at [#{config_file}]."
-        @settings = {}
-      else
-        @settings = YAML.load(ERB.new(File.read(config_file)).result(binding))[ScoutRails::Agent.instance.environment.env] || {} 
-      end  
-    rescue Exception => e
-      ScoutRails::Agent.instance.logger.warn "Unable to load the config file."
-      ScoutRails::Agent.instance.logger.warn e.message
-      ScoutRails::Agent.instance.logger.warn e.backtrace
-      @settings = {}
-    end
-  end
-end

data/lib/scout_rails/version.rb

@@ -1,3 +0,0 @@
-module ScoutRails
-  VERSION = "1.0.4"
-end