scout_apm 0.1.3.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6dd9fa6823ce48d2b2b36ae4238cfaa3152bfd08
-  data.tar.gz: c0916b57ea440cedaf275792089bedf20249ffe9
+  metadata.gz: eadc6cf693f387c94fdbbaa5bc96a759c80be140
+  data.tar.gz: e6c9465cde1d1589f72e6c46f95a9e45ba54f627
 SHA512:
-  metadata.gz: d62355ce9a305aa40ecd58722b1c518a1dc2606e06aa3fd1101b73100bded03a48e51c2a2bcc54907f0eb5da5e3444bdb819cc420766e90823cca19f4d7344bc
-  data.tar.gz: 27c9bc33de0af9d4aff82503ad7e3bb1a8fde34a6448fba5ebe61b84f80d2354a517aecf7ddb7fcf48a059193c3027064c7a159223335156dc74a22cee798056
+  metadata.gz: 77a3ee7b7e4fd8b1c3ee62231d4566d1bf9937ea4d48498194b991d7ffb55782c13baaae1021aa127325dccc9ccd2a200722b5b5ae7a341825a2acf45f5c854b
+  data.tar.gz: 2aa25dca40e455d4463676c77f6bd105d07402c6358d9e479ba6033b143464e8d546ff39a4ea50e82f0b9e9c92959bb393f69ba9cec3d50ba3d35c67268591a9

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+# 0.1.4
+
+* Tweaks to Postgres query parsing
+* Fix for missing scout_apm.yml file causing rake commands to fail because of a missing log file.
+
 # 0.1.3.1
 
 * Adds Puma support

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+
+task :default => :test
+task :test do
+  $: << File.expand_path(File.dirname(__FILE__) + "/test")
+  Dir.glob('./test/**/*_test.rb').each { |file| require file }
+end
+

data/lib/scout_apm/agent.rb

@@ -6,8 +6,8 @@ module ScoutApm
   # saves tshe merged data to disk, and sends it to the Scout server.
   class Agent
     # see self.instance
-    @@instance = nil 
-    
+    @@instance = nil
+
     # Accessors below are for associated classes
     attr_accessor :store
     attr_accessor :layaway
@@ -18,31 +18,32 @@ module ScoutApm
     attr_accessor :log_file # path to the log file
     attr_accessor :options # options passed to the agent when +#start+ is called.
     attr_accessor :metric_lookup # Hash used to lookup metric ids based on their name and scope
-    
+
     # All access to the agent is thru this class method to ensure multiple Agent instances are not initialized per-Ruby process. 
     def self.instance(options = {})
       @@instance ||= self.new(options)
     end
-    
+
     # Note - this doesn't start instruments or the worker thread. This is handled via +#start+ as we don't 
     # want to start the worker thread or install instrumentation if (1) disabled for this environment (2) a worker thread shouldn't
     # be started (when forking).
     def initialize(options = {})
       @started = false
       @options ||= options
+      @config = ScoutApm::Config.new(options[:config_path])
+
       @store = ScoutApm::Store.new
       @layaway = ScoutApm::Layaway.new
-      @config = ScoutApm::Config.new(options[:config_path])
       @metric_lookup = Hash.new
-      @process_cpu=ScoutApm::Instruments::Process::ProcessCpu.new(environment.processors)
-      @process_memory=ScoutApm::Instruments::Process::ProcessMemory.new
+      @process_cpu = ScoutApm::Instruments::Process::ProcessCpu.new(environment.processors)
+      @process_memory = ScoutApm::Instruments::Process::ProcessMemory.new
       @capacity = ScoutApm::Capacity.new
     end
-    
+
     def environment
       @environment ||= ScoutApm::Environment.new
     end
-    
+
     # This is called via +ScoutApm::Agent.instance.start+ when ScoutApm is required in a Ruby application.
     # It initializes the agent and starts the worker thread (if appropiate).
     def start(options = {})
@@ -64,7 +65,7 @@ module ScoutApm
       end
       @started = true
       logger.info "Starting monitoring for [#{config.value('name')}]. Framework [#{environment.framework}] App Server [#{environment.app_server}]."
-      start_instruments
+      load_instruments
       if !start_background_worker?
         logger.debug "Not starting worker thread. Will start worker loops after forking."
         install_passenger_events if environment.app_server == :passenger
@@ -168,8 +169,8 @@ module ScoutApm
       end
     rescue
       logger.warn "Unable to install Puma worker loop: #{$!.message}"
-    end    
-    
+    end
+
     # Creates the worker thread. The worker thread is a loop that runs continuously. It sleeps for +Agent#period+ and when it wakes,
     # processes data, either saving it to disk or reporting to Scout.
     def start_background_worker
@@ -180,7 +181,7 @@ module ScoutApm
       end # thread new
       logger.debug "Done creating worker thread."
     end
-    
+
     # Called from #process_metrics, which is run via the background worker. 
     def run_samplers
       begin
@@ -203,9 +204,10 @@ module ScoutApm
         logger.debug e.backtrace.join("\n")
       end
     end
-    
+
     # Loads the instrumention logic.
     def load_instruments
+      logger.debug "Installing instrumentation"
       case environment.framework
       when :rails
         require File.expand_path(File.join(File.dirname(__FILE__),'instruments/rails/action_controller_instruments.rb'))
@@ -221,12 +223,5 @@ module ScoutApm
       logger.warn $!.message
       logger.warn $!.backtrace
     end
-    
-    # Injects instruments into the Ruby application.
-    def start_instruments
-      logger.debug "Installing instrumentation"
-      load_instruments
-    end
-    
   end # class Agent
-end # module ScoutApm
+end # module ScoutApm

data/lib/scout_apm/agent/logging.rb

@@ -6,11 +6,18 @@ module ScoutApm
       def default_log_path
         "#{environment.root}/log"
       end
-      
+
       def init_logger
-        @log_file = wants_stdout? ? STDOUT : "#{log_file_path}/scout_apm.log"
-        begin 
-          @logger = Logger.new(@log_file) 
+        begin
+          @log_file = wants_stdout? ? STDOUT : "#{log_file_path}/scout_apm.log"
+        rescue => e
+          puts "OHH NO"
+          puts e.message
+          puts e.backtrace.join("\n\t")
+        end
+
+        begin
+          @logger = Logger.new(@log_file)
           @logger.level = log_level
           apply_log_format
         rescue Exception => e
@@ -50,4 +57,4 @@ module ScoutApm
     end # module Logging
     include Logging
   end # class Agent
-end # moudle ScoutApm
+end # moudle ScoutApm

data/lib/scout_apm/agent/reporting.rb

@@ -23,7 +23,7 @@ module ScoutApm
             if meta.metric_name =~ /\AController/
               controller_count += stats.call_count
             end
-          end      
+          end
           payload = Marshal.dump(:metrics => metrics, :slow_transactions => slow_transactions)
           slow_transactions_kb = Marshal.dump(slow_transactions).size/1024 # just for performance debugging
           logger.debug "#{config.value('name')} Delivering total payload [#{payload.size/1024} KB] for #{controller_count} requests and slow transactions [#{slow_transactions_kb} KB] for #{slow_transactions.size} transactions of durations: #{slow_transactions.map(&:total_call_time).join(',')}."        
@@ -47,7 +47,7 @@ module ScoutApm
         logger.info $!.message
         logger.debug $!.backtrace
       end
-      
+
       # Before reporting, lookup metric_id for each MetricMeta. This speeds up 
       # reporting on the server-side.
       def add_metric_ids(metrics)
@@ -57,7 +57,7 @@ module ScoutApm
           end
         end
       end
-      
+
       def checkin_uri
         URI.parse("#{config.value('host')}/apps/checkin.scout?key=#{config.value('key')}&name=#{CGI.escape(config.value('name'))}")
       end
@@ -113,4 +113,4 @@ module ScoutApm
     end # module Reporting
     include Reporting
   end # class Agent
-end # module ScoutApm
+end # module ScoutApm

data/lib/scout_apm/config.rb

@@ -1,15 +1,22 @@
+require 'yaml'
+require 'erb'
+
+require 'scout_apm/environment'
+
 module ScoutApm
-  class Config   
+  class Config
     DEFAULTS =  {
         'host' => 'https://apm.scoutapp.com',
         'log_level' => 'info'
-    }
+    }.freeze
 
     def initialize(config_path = nil)
       @config_path = config_path
     end
-  
-    # Fetch a config value. It first attempts to fetch an ENV var prefixed with 'SCOUT_', then from the settings file.
+
+    # Fetch a config value.
+    # It first attempts to fetch an ENV var prefixed with 'SCOUT_',
+    # then from the settings file.
     def value(key)
       value = ENV['SCOUT_'+key.upcase] || settings[key]
       value.to_s.strip.length.zero? ? nil : value
@@ -18,33 +25,46 @@ module ScoutApm
     private
 
     def config_path
-      @config_path || File.join(ScoutApm::Agent.instance.environment.root,"config","scout_apm.yml")
+      @config_path || File.join(ScoutApm::Environment.new.root, "config", "scout_apm.yml")
     end
-    
+
     def config_file
       File.expand_path(config_path)
     end
 
     def settings
-      return @settings if @settings
-      load_file
+      @settings ||= load_file
+    end
+
+    def config_environment
+      @config_environment ||= ScoutApm::Environment.new.env
     end
-    
+
     def load_file
+      settings_hash = {}
       begin
-        if !File.exist?(config_file)
-          ScoutApm::Agent.instance.logger.warn "No config file found at [#{config_file}]."
-          @settings = {}
+        if File.exist?(config_file)
+          settings_hash = YAML.load(ERB.new(File.read(config_file)).result(binding))[config_environment] || {} 
         else
-          @settings = YAML.load(ERB.new(File.read(config_file)).result(binding))[ScoutApm::Agent.instance.environment.env] || {} 
-        end  
+          logger.warn "No config file found at [#{config_file}]."
+        end
       rescue Exception => e
-        ScoutApm::Agent.instance.logger.warn "Unable to load the config file."
-        ScoutApm::Agent.instance.logger.warn e.message
-        ScoutApm::Agent.instance.logger.warn e.backtrace
-        @settings = {}
+        logger.warn "Unable to load the config file."
+        logger.warn e.message
+        logger.warn e.backtrace
+      end
+      DEFAULTS.merge(settings_hash)
+    end
+
+    # if we error out early enough, we don't have access to ScoutApm's logger
+    # in that case, be silent unless ENV['SCOUT_DEBUG'] is set, then STDOUT it
+    def logger
+      if defined?(ScoutApm::Agent) && (apm_log = ScoutApm::Agent.instance.logger)
+        apm_log
+      else
+        require 'scout_apm/utils/null_logger'
+        ENV['SCOUT_DEBUG'] ? Logger.new(STDOUT) : ScoutApm::Utils::NullLogger.new
       end
-      @settings = DEFAULTS.merge(@settings)
     end
-  end # Config
-end # ScoutApm
+  end
+end

data/lib/scout_apm/environment.rb

@@ -3,13 +3,17 @@ module ScoutApm
   class Environment
     def env
       @env ||= case framework
-               when :rails then RAILS_ENV.dup
-               when :rails3_or_4 then Rails.env
+               when :rails
+                 RAILS_ENV.dup
+               when :rails3_or_4
+                 Rails.env
                when :sinatra
                  ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+               when :ruby
+                 ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
                end
     end
-    
+
     def framework
       @framework ||= case
                       when defined?(::Rails) && defined?(ActionController)
@@ -22,7 +26,29 @@ module ScoutApm
                       else :ruby
                       end
     end
-    
+
+    def database_engine
+      default = :mysql
+
+      if defined?(ActiveRecord::Base)
+        return default unless ActiveRecord::Base.connected?
+
+        case ActiveRecord::Base.connection.class.to_s
+        when "ActiveRecord::ConnectionAdapters::MysqlAdapter"
+          :mysql
+        when "ActiveRecord::ConnectionAdapters::PostgreSQLAdapter"
+          :postgres
+        when "ActiveRecord::ConnectionAdapters::SQLite3Adapter"
+          :sqlite
+        else
+          default
+        end
+      else
+        # TODO: detection outside of Rails
+        default
+      end
+    end
+
     def processors
       return @processors if @processors
       unless @processors
@@ -38,7 +64,7 @@ module ScoutApm
       end
       @processors
     end
-    
+
     def root
       if framework == :rails
         RAILS_ROOT.to_s
@@ -52,23 +78,23 @@ module ScoutApm
     end
 
     def heroku?
-      ENV['DYNO']      
+      ENV['DYNO']
     end
 
     def hostname
       heroku? ? ENV['DYNO'] : Socket.gethostname
     end
-    
+
     # This needs to be improved. Frequently, multiple app servers gem are present and which
-    # ever is checked first becomes the designated app server. 
-    # 
+    # ever is checked first becomes the designated app server.
+    #
     # I've put Thin and Webrick last as they are often used in development and included in Gemfiles 
     # but less likely used in production. 
     #
     # Next step: (1) list out all detected app servers (2) install hooks for those that need it (passenger, rainbows, unicorn). 
     #
     # Believe the biggest downside is the master process for forking app servers will get a background worker. Not sure how this will
-    # impact metrics (it shouldn't process requests). 
+    # impact metrics (it shouldn't process requests).
     def app_server
       @app_server ||= if passenger? then :passenger
                     elsif rainbows? then :rainbows
@@ -79,9 +105,8 @@ module ScoutApm
                     else nil
                     end
     end
-    
+
     ### app server related-checks
-    
     def thin?
       if defined?(::Thin) && defined?(::Thin::Server)
         # Ensure Thin is actually initialized. It could just be required and not running.
@@ -89,14 +114,14 @@ module ScoutApm
         false
       end
     end
-    
+
     # Called via +#forking?+ since Passenger forks. Adds an event listener to start the worker thread
     # inside the passenger worker process.
     # Background: http://www.modrails.com/documentation/Users%20guide%20Nginx.html#spawning%5Fmethods%5Fexplained
     def passenger?
       (defined?(::Passenger) && defined?(::Passenger::AbstractServer)) || defined?(::PhusionPassenger)
     end
-    
+
     def webrick?
       defined?(::WEBrick) && defined?(::WEBrick::VERSION)
     end
@@ -107,7 +132,7 @@ module ScoutApm
         false
       end
     end
-    
+
     def unicorn?
       if defined?(::Unicorn) && defined?(::Unicorn::HttpServer)
         # Ensure Unicorn is actually initialized. It could just be required and not running.
@@ -119,15 +144,15 @@ module ScoutApm
     def puma?
       defined?(::Puma) && File.basename($0) == 'puma'
     end
-    
+
     # If forking, don't start worker thread in the master process. Since it's started as a Thread, it won't survive
-    # the fork. 
+    # the fork.
     def forking?
       passenger? or unicorn? or rainbows? or puma?
     end
-    
+
     ### ruby checks
-    
+
     def rubinius?
       RUBY_VERSION =~ /rubinius/i
     end
@@ -135,11 +160,11 @@ module ScoutApm
     def jruby?
       defined?(JRuby)
     end
-    
+
     def ruby_19?
       defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" && RUBY_VERSION.match(/^1\.9/)
     end
-    
+
     ### framework checks
 
     def sinatra?
@@ -147,4 +172,4 @@ module ScoutApm
     end
 
   end # class Environemnt
-end
+end

data/lib/scout_apm/instruments/active_record_instruments.rb

@@ -1,65 +1,54 @@
-module ScoutApm::Instruments
-  # Contains ActiveRecord instrument, aliasing +ActiveRecord::ConnectionAdapters::AbstractAdapter#log+ calls
-  # to trace calls to the database. 
-  module ActiveRecordInstruments
-    def self.included(instrumented_class)
-      ScoutApm::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
-          alias_method :log, :log_with_scout_instruments
-          protected :log
+require 'scout_apm/utils/sql_sanitizer'
+
+module ScoutApm
+  module Instruments
+    # Contains ActiveRecord instrument, aliasing +ActiveRecord::ConnectionAdapters::AbstractAdapter#log+ calls
+    # to trace calls to the database. 
+    module ActiveRecordInstruments
+      def self.included(instrumented_class)
+        ScoutApm::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
+            alias_method :log, :log_with_scout_instruments
+            protected :log
+          end
+        end
+      end # self.included
+
+      def log_with_scout_instruments(*args, &block)
+        sql, name = args
+        self.class.instrument(scout_ar_metric_name(sql,name), :desc => Utils::SqlSanitizer.new(sql).to_s) do
+          log_without_scout_instruments(sql, name, &block)
         end
       end
-    end # self.included
-    
-    def log_with_scout_instruments(*args, &block)
-      sql, name = args
-      self.class.instrument(scout_ar_metric_name(sql,name), :desc => scout_sanitize_sql(sql)) do
-        log_without_scout_instruments(sql, name, &block)
-      end
-    end
-    
-    def scout_ar_metric_name(sql,name)
-      # sql: SELECT "places".* FROM "places"  ORDER BY "places"."position" ASC
-      # name: Place Load
-      if name && (parts = name.split " ") && parts.size == 2
-        model = parts.first
-        operation = parts.last.downcase
-        metric_name = case operation
-                      when 'load' then 'find'
-                      when 'indexes', 'columns' then nil # not under developer control
-                      when 'destroy', 'find', 'save', 'create', 'exists' then operation
-                      when 'update' then 'save'
-                      else
-                        if model == 'Join'
-                          operation
+
+      def scout_ar_metric_name(sql,name)
+        # sql: SELECT "places".* FROM "places"  ORDER BY "places"."position" ASC
+        # name: Place Load
+        if name && (parts = name.split " ") && parts.size == 2
+          model = parts.first
+          operation = parts.last.downcase
+          metric_name = case operation
+                        when 'load' then 'find'
+                        when 'indexes', 'columns' then nil # not under developer control
+                        when 'destroy', 'find', 'save', 'create', 'exists' then operation
+                        when 'update' then 'save'
+                        else
+                          if model == 'Join'
+                            operation
+                          end
                         end
-                      end
-        metric = "ActiveRecord/#{model}/#{metric_name}" if metric_name
-        metric = "ActiveRecord/SQL/other" if metric.nil?
-      else
-        metric = "ActiveRecord/SQL/Unknown"
+          metric = "ActiveRecord/#{model}/#{metric_name}" if metric_name
+          metric = "ActiveRecord/SQL/other" if metric.nil?
+        else
+          metric = "ActiveRecord/SQL/Unknown"
+        end
+        metric
       end
-      metric
-    end
-    
-    # Removes actual values from SQL. Used to both obfuscate the SQL and group 
-    # similar queries in the UI.
-    def scout_sanitize_sql(sql)
-      return nil if sql.length > 1000 # safeguard - don't sanitize large SQL statements
-      sql = sql.dup
-      sql.gsub!(/\\"/, '') # removing escaping double quotes
-      sql.gsub!(/\\'/, '') # removing escaping single quotes
-      sql.gsub!(/'(?:[^']|'')*'/, '?') # removing strings (single quote)
-      sql.gsub!(/"(?:[^"]|"")*"/, '?') # removing strings (double quote)
-      sql.gsub!(/\b\d+\b/, '?') # removing integers
-      sql.gsub!(/\?(,\?)+/,'?') # replace multiple ? w/a single ?
-      sql
-    end
-    
-  end # module ActiveRecordInstruments
-end # module Instruments
+    end # module ActiveRecordInstruments
+  end # module Instruments
+end
 
 def add_instruments
   if defined?(ActiveRecord) && defined?(ActiveRecord::Base)
@@ -82,4 +71,4 @@ if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i == 3 && ::Rails.respond_to?
   end
 else
   add_instruments
-end
+end

data/lib/scout_apm/utils/null_logger.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+module ScoutApm
+  module Utils
+    class NullLogger < Logger
+      def initialize(*args)
+      end
+
+      def add(*args, &block)
+      end
+    end
+  end
+end

data/lib/scout_apm/utils/sql_sanitizer.rb

@@ -0,0 +1,74 @@
+require 'scout_apm/environment'
+
+# Removes actual values from SQL. Used to both obfuscate the SQL and group
+# similar queries in the UI.
+module ScoutApm
+  module Utils
+    class SqlSanitizer
+      attr_reader :sql
+      attr_accessor :database_engine
+
+      def initialize(sql)
+        @sql = sql.dup
+        @database_engine = ScoutApm::Environment.new.database_engine
+      end
+
+      def to_s
+        return nil if sql.length > 1000 # safeguard - don't sanitize large SQL statements
+        case database_engine
+        when :postgres then to_s_postgres
+        when :mysql    then to_s_mysql
+        when :sqlite   then to_s_sqlite
+        end
+      end
+
+      private
+
+      MULTIPLE_SPACES    = %r|\s+|.freeze
+      MULTIPLE_QUESTIONS = /\?(,\?)+/.freeze
+      TRAILING_SPACES    = /\s+$/.freeze
+
+      PSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
+      PSQL_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
+      PSQL_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
+      PSQL_PLACEHOLDER = /\$\d+/.freeze
+
+      def to_s_postgres
+        sql.gsub!(PSQL_PLACEHOLDER, '?')
+        sql.gsub!(PSQL_VAR_INTERPOLATION, '')
+        sql.gsub!(PSQL_REMOVE_STRINGS, '?')
+        sql.gsub!(PSQL_REMOVE_INTEGERS, '?')
+        sql.gsub!(MULTIPLE_SPACES, ' ')
+        sql.gsub!(TRAILING_SPACES, '')
+        sql
+      end
+
+      MYSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
+      MYSQL_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
+      MYSQL_REMOVE_SINGLE_QUOTE_STRINGS = /'(?:[^']|'')*'/.freeze
+      MYSQL_REMOVE_DOUBLE_QUOTE_STRINGS = /"(?:[^"]|"")*"/.freeze
+
+      def to_s_mysql
+        sql.gsub!(MYSQL_VAR_INTERPOLATION, '')
+        sql.gsub!(MYSQL_REMOVE_SINGLE_QUOTE_STRINGS, '?')
+        sql.gsub!(MYSQL_REMOVE_DOUBLE_QUOTE_STRINGS, '?')
+        sql.gsub!(MYSQL_REMOVE_INTEGERS, '?')
+        sql.gsub!(MULTIPLE_QUESTIONS, '?')
+        sql.gsub!(TRAILING_SPACES, '')
+        sql
+      end
+
+      SQLITE_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
+      SQLITE_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
+      SQLITE_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
+
+      def to_s_sqlite
+        sql.gsub!(SQLITE_VAR_INTERPOLATION, '')
+        sql.gsub!(SQLITE_REMOVE_STRINGS, '?')
+        sql.gsub!(SQLITE_REMOVE_INTEGERS, '?')
+        sql.gsub!(MULTIPLE_SPACES, ' ')
+        sql.gsub!(TRAILING_SPACES, '')
+      end
+    end
+  end
+end

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "0.1.3.1"
+  VERSION = "0.1.4"
 end

data/scout_apm.gemspec

@@ -5,7 +5,7 @@ require "scout_apm/version"
 Gem::Specification.new do |s|
   s.name        = "scout_apm"
   s.version     = ScoutApm::VERSION
-  s.authors     = ["Derek Haynes",'Andre Lewis']
+  s.authors     = ["Derek Haynes", 'Andre Lewis']
   s.email       = ["support@scoutapp.com"]
   s.homepage    = "https://github.com/scoutapp/scout_apm_ruby"
   s.summary     = "Ruby application performance monitoring"
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib","data"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "m"
 end

data/test/data/config_test_1.yml

@@ -0,0 +1,21 @@
+common: &defaults
+  name: Scout APM
+  key: 000011110000
+  log_level: debug
+  monitor: true
+
+production:
+  <<: *defaults
+  name: APM Test Conf (Production)
+
+development:
+  <<: *defaults
+  name: APM Test Conf (Development)
+  host: http://localhost:3000
+  monitor: true
+
+test:
+  <<: *defaults
+  name: APM Test Conf (Test)
+  monitor: false
+

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/pride'
+
+require 'pry'
+
+Kernel.module_eval do
+  # Unset a constant without private access.
+  def self.const_unset(const)
+    self.instance_eval { remove_const(const) }
+  end
+end
+
+# require 'scout_apm'
+

data/test/unit/config_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+require 'scout_apm/config'
+
+class ConfigTest < Minitest::Test
+  def test_initalize_without_a_config
+    conf = ScoutApm::Config.new(nil)
+
+    # nil for random keys
+    assert_nil conf.value("log_file_path")
+
+    # but has values for defaulted keys
+    assert conf.value("host")
+
+    # and still reads from ENV
+    ENV['SCOUT_CONFIG_TEST_KEY'] = 'testval'
+    assert_equal 'testval', conf.value("config_test_key")
+  end
+
+  def test_loading_a_file
+    ENV['RACK_ENV'] = "production"
+    conf_file = File.expand_path("../../data/config_test_1.yml", __FILE__)
+    conf = ScoutApm::Config.new(conf_file)
+
+    assert_equal "debug", conf.value('log_level')
+    assert_equal "APM Test Conf (Production)", conf.value('name')
+  end
+end
+

data/test/unit/environment_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+require 'scout_apm/environment'
+
+class EnvironmentTest < Minitest::Test
+  def teardown
+    clean_fake_rails
+    clean_fake_sinatra
+  end
+
+  def test_framework_rails
+    fake_rails(2)
+    assert_equal :rails, ScoutApm::Environment.new.framework
+
+    clean_fake_rails
+    fake_rails(3)
+    assert_equal :rails3_or_4, ScoutApm::Environment.new.framework
+
+    clean_fake_rails
+    fake_rails(4)
+    assert_equal :rails3_or_4, ScoutApm::Environment.new.framework
+  end
+
+  def test_framework_sinatra
+    fake_sinatra
+    assert_equal :sinatra, ScoutApm::Environment.new.framework
+  end
+
+  def test_framework_ruby
+    assert_equal :ruby, ScoutApm::Environment.new.framework
+  end
+
+  ############################################################
+
+  def fake_rails(version)
+    Kernel.const_set("Rails", Module.new)
+    Kernel.const_set("ActionController", Module.new)
+    r = Kernel.const_get("Rails")
+    r.const_set("VERSION", Module.new)
+    v = r.const_get("VERSION")
+    v.const_set("MAJOR", version)
+
+    assert_equal version, Rails::VERSION::MAJOR
+  end
+
+  def clean_fake_rails
+    Kernel.const_unset("Rails") if defined?(Kernel::Rails)
+    Kernel.const_unset("ActionController") if defined?(Kernel::ActionController)
+  end
+
+  def fake_sinatra
+    Kernel.const_set("Sinatra", Module.new)
+    s = Kernel.const_get("Sinatra")
+    s.const_set("Base", Module.new)
+  end
+
+  def clean_fake_sinatra
+    Kernel.const_unset("Sinatra") if defined?(Kernel::Sinatra)
+  end
+end

data/test/unit/instruments/active_record_instruments_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+require 'scout_apm/instruments/active_record_instruments'
+
+class ActiveRecordInstrumentsTest < Minitest::Test
+end
+

data/test/unit/sql_sanitizer_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+require 'scout_apm/utils/sql_sanitizer'
+
+module ScoutApm
+  module Utils
+    class SqlSanitizerTest < Minitest::Test
+      # Too long, and we just bail out to prevent long running instrumentation
+      def test_long_sql
+        sql = " " * 1001
+        assert_nil SqlSanitizer.new(sql).to_s
+      end
+
+      def test_postgres_simple_select_of_first
+        sql = %q|SELECT  "users".* FROM "users"  ORDER BY "users"."id" ASC LIMIT 1|
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :postgres }
+        assert_equal %q|SELECT "users".* FROM "users" ORDER BY "users"."id" ASC LIMIT 1|, ss.to_s
+      end
+
+      def test_postgres_where
+        sql = %q|SELECT "users".* FROM "users" WHERE "users"."name" = $1  [["name", "chris"]]|
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :postgres }
+        assert_equal %q|SELECT "users".* FROM "users" WHERE "users"."name" = ?|, ss.to_s
+      end
+
+      def test_postgres_strips_literals
+        # Strip strings
+        sql = %q|SELECT "users".* FROM "users" INNER JOIN "blogs" ON "blogs"."user_id" = "users"."id" WHERE (blogs.title = 'hello world')|
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :postgres }
+        assert_equal %q|SELECT "users".* FROM "users" INNER JOIN "blogs" ON "blogs"."user_id" = "users"."id" WHERE (blogs.title = ?)|, ss.to_s
+
+        # Strip integers
+        sql = %q|SELECT "blogs".* FROM "blogs" WHERE (view_count > 10)|
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :postgres }
+        assert_equal %q|SELECT "blogs".* FROM "blogs" WHERE (view_count > ?)|, ss.to_s
+      end
+
+      def test_mysql_where
+        sql = %q|SELECT `users`.* FROM `users` WHERE `users`.`name` = ?  [["name", "chris"]]|
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :mysql }
+        assert_equal %q|SELECT `users`.* FROM `users` WHERE `users`.`name` = ?|, ss.to_s
+      end
+
+      def test_mysql_limit
+        sql = %q|SELECT  `blogs`.* FROM `blogs`  ORDER BY `blogs`.`id` ASC LIMIT 1|
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :mysql }
+        assert_equal %q|SELECT  `blogs`.* FROM `blogs`  ORDER BY `blogs`.`id` ASC LIMIT 1|, ss.to_s
+      end
+
+      def test_mysql_literals
+        sql = %q|SELECT `blogs`.* FROM `blogs` WHERE (title = 'abc')|
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :mysql }
+        assert_equal %q|SELECT `blogs`.* FROM `blogs` WHERE (title = ?)|, ss.to_s
+
+        sql = %q|SELECT `blogs`.* FROM `blogs` WHERE (title = "abc")|
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :mysql }
+        assert_equal %q|SELECT `blogs`.* FROM `blogs` WHERE (title = ?)|, ss.to_s
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 0.1.3.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,8 +9,50 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
-dependencies: []
+date: 2015-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: pry
+  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: m
+  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: Monitors Ruby apps and reports detailed metrics on performance to Scout.
 email:
 - support@scoutapp.com
@@ -49,8 +91,16 @@ files:
 - lib/scout_apm/stack_item.rb
 - lib/scout_apm/store.rb
 - lib/scout_apm/tracer.rb
+- lib/scout_apm/utils/null_logger.rb
+- lib/scout_apm/utils/sql_sanitizer.rb
 - lib/scout_apm/version.rb
 - scout_apm.gemspec
+- test/data/config_test_1.yml
+- test/test_helper.rb
+- test/unit/config_test.rb
+- test/unit/environment_test.rb
+- test/unit/instruments/active_record_instruments_test.rb
+- test/unit/sql_sanitizer_test.rb
 homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses: []
 metadata: {}
@@ -71,9 +121,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
-test_files: []
-has_rdoc: 
+test_files:
+- test/data/config_test_1.yml
+- test/test_helper.rb
+- test/unit/config_test.rb
+- test/unit/environment_test.rb
+- test/unit/instruments/active_record_instruments_test.rb
+- test/unit/sql_sanitizer_test.rb