scout_apm 2.6.10 → 3.0.0.pre0

data/lib/scout_apm/context.rb

@@ -5,33 +5,17 @@
 # For misc context, use @Context#add@.
 module ScoutApm
   class Context
-    attr_reader :context
-
-    def initialize(context)
-      @context = context
+    def initialize
       @extra = {}
       @user = {}
     end
 
-    def logger
-      context.logger
-    end
-
     # Generates a hash representation of the Context.
     # Example: {:monthly_spend => 100, :user => {:ip => '127.0.0.1'}}
     def to_hash
       @extra.merge({:user => @user})
     end
 
-    def to_flat_hash
-      h = to_hash
-      user = h.delete(:user)
-      if user
-        user.each { |k,v| h["user_#{k}"] = v}
-      end
-      h
-    end
-
     def self.current
       RequestManager.lookup.context
     end
@@ -94,7 +78,7 @@ module ScoutApm
       if value.nil?
         false # don't log this ... easy to happen
       elsif !valid_type?([String, Symbol, Numeric, Time, Date, TrueClass, FalseClass],value)
-        logger.info "The value for [#{key_value.keys.first}] is not a valid type [#{value.class}]."
+        ScoutApm::Agent.instance.logger.info "The value for [#{key_value.keys.first}] is not a valid type [#{value.class}]."
         false
       else
         true
@@ -108,12 +92,12 @@ module ScoutApm
         false # don't log this ... easy to happen
       # ensure a string or a symbol
       elsif !valid_type?([String, Symbol],key)
-        logger.info "The key [#{key}] is not a valid type [#{key.class}]."
+        ScoutApm::Agent.instance.logger.info "The key [#{key}] is not a valid type [#{key.class}]."
         return false
       end
       # only alphanumeric, dash, and underscore allowed.
       if key.to_s.match(/[^\w-]/)
-        logger.info "They key name [#{key}] is not valid."
+        ScoutApm::Agent.instance.logger.info "They key name [#{key}] is not valid."
         return false
       end
       true

data/lib/scout_apm/deploy_integrations/capistrano_2.cap

@@ -0,0 +1,12 @@
+namespace :scout_apm do
+  namespace :deploy do
+    task :starting do
+      # Warn if missing scout apm deploy creds?
+    end
+    task :finished do
+      ScoutApm::Agent.instance.deploy_integration.report
+    end
+  end
+end
+
+after 'deploy:finished', 'scout_apm:deploy:finished'

data/lib/scout_apm/deploy_integrations/capistrano_2.rb

@@ -0,0 +1,83 @@
+require 'scout_apm'
+
+module ScoutApm
+  module DeployIntegrations
+    class Capistrano2
+      attr_reader :logger
+
+      def initialize(logger)
+        @logger = logger
+        @cap = defined?(Capistrano::Configuration) ? ObjectSpace.each_object(Capistrano::Configuration).map.first : nil rescue nil
+      end
+
+      def name
+        :capistrano_2
+      end
+
+      def version
+        present? ? Capistrano::VERSION : nil
+      end
+
+      def present?
+        if !@cap.nil? && @cap.is_a?(Capistrano::Configuration)
+          require 'capistrano/version'
+          defined?(Capistrano::VERSION) && Gem::Dependency.new('', '~> 2.0').match?('', Capistrano::VERSION.to_s)
+        else
+          return false
+        end
+        return true
+      rescue
+        return false
+      end
+
+      def install
+        logger.debug "Initializing Capistrano2 Deploy Integration."
+        @cap.load File.expand_path("../capistrano_2.cap", __FILE__)
+      end
+
+      def root
+        '.'
+      end
+
+      def env
+        @cap.fetch(:stage)
+      end
+
+      def found?
+        true
+      end
+
+      def report
+        if reporter.can_report?
+          data = deploy_data
+          logger.debug "Sending deploy hook data: #{data}"
+          payload = ScoutApm::Serializers::DeploySerializer.serialize(data)
+          reporter.report(payload, ScoutApm::Serializers::DeploySerializer::HTTP_HEADERS)
+        else
+          logger.warn "Unable to post deploy hook data"
+        end
+      end
+
+      def reporter
+        @reporter ||= ScoutApm::Reporter.new(:deploy_hook, ScoutApm::Agent.instance.config, @logger)
+      end
+
+      def deploy_data
+        {:revision => current_revision, :branch => branch, :deployed_by => deployed_by}
+      end
+
+      def branch
+        @cap.fetch(:branch)
+      end
+
+      def current_revision
+        @cap.fetch(:current_revision) || `git rev-list --max-count=1 --abbrev-commit --abbrev=12 #{branch}`.chomp
+      end
+
+      def deployed_by
+        ScoutApm::Agent.instance.config.value('deployed_by')
+      end
+
+    end
+  end
+end

data/lib/scout_apm/deploy_integrations/capistrano_3.cap

@@ -0,0 +1,12 @@
+namespace :scout_apm do
+  namespace :deploy do
+    task :starting do
+      # Warn if missing scout apm deploy creds?
+    end
+    task :finished do
+      ScoutApm::Agent.instance.deploy_integration.report
+    end
+  end
+end
+
+after 'deploy:finished', 'scout_apm:deploy:finished'

data/lib/scout_apm/deploy_integrations/capistrano_3.rb

@@ -0,0 +1,88 @@
+require 'scout_apm'
+
+module ScoutApm
+  module DeployIntegrations
+    class Capistrano3
+      attr_reader :logger
+
+      def initialize(logger)
+        @logger = logger
+        @cap = Rake.application rescue nil
+      end
+
+      def name
+        :capistrano_3
+      end
+
+      def version
+        present? ? Capistrano::VERSION : nil
+      end
+
+      def present?
+        if !@cap.nil? && @cap.is_a?(Capistrano::Application)
+          require 'capistrano/version'
+          defined?(Capistrano::VERSION) && Gem::Dependency.new('', '~> 3.0').match?('', Capistrano::VERSION.to_s)
+        else
+          return false
+        end
+      rescue
+        return false
+      end
+
+      def install
+        logger.debug "Initializing Capistrano3 Deploy Integration."
+        load File.expand_path("../capistrano_3.cap", __FILE__)
+      end
+
+      def root
+        '.'
+      end
+
+      def env
+        @cap.fetch(:stage).to_s
+      end
+
+      def found?
+        true
+      end
+
+      def report
+        if reporter.can_report?
+          data = deploy_data
+          logger.debug "Sending deploy hook data: #{data}"
+          payload = ScoutApm::Serializers::DeploySerializer.serialize(data)
+          reporter.report(payload, ScoutApm::Serializers::DeploySerializer::HTTP_HEADERS)
+        else
+          logger.warn "Unable to post deploy hook data"
+        end
+      end
+
+      def reporter
+        config =  if env == '' 
+                    ScoutApm::Agent.instance.config
+                  else
+                    ScoutApm::Config.with_file(nil, {:file => { :environment => env }}) # instantiate our own config, with an overridden environment for the deploy-to app name instead of deploy-from app name)
+                  end
+
+        @reporter ||= ScoutApm::Reporter.new(:deploy_hook, config, @logger)
+      end
+
+      def deploy_data
+        {:revision => current_revision, :branch => branch, :deployed_by => deployed_by}
+      end
+
+      def branch
+        @cap.fetch(:branch)
+      end
+
+      def current_revision
+        @cap.fetch(:current_revision) || `git rev-list --max-count=1 --abbrev-commit --abbrev=12 #{branch}`.chomp
+      end
+
+      def deployed_by
+        ScoutApm::Agent.instance.config.value('deployed_by')
+      end
+
+    end
+  end
+end

data/lib/scout_apm/environment.rb

@@ -24,12 +24,8 @@ module ScoutApm
     ]
 
     BACKGROUND_JOB_INTEGRATIONS = [
-      ScoutApm::BackgroundJobIntegrations::Resque.new,
       ScoutApm::BackgroundJobIntegrations::Sidekiq.new,
-      ScoutApm::BackgroundJobIntegrations::Shoryuken.new,
-      ScoutApm::BackgroundJobIntegrations::Sneakers.new,
-      ScoutApm::BackgroundJobIntegrations::DelayedJob.new,
-      ScoutApm::BackgroundJobIntegrations::Que.new,
+      # ScoutApm::BackgroundJobIntegrations::DelayedJob.new
     ]
 
     FRAMEWORK_INTEGRATIONS = [
@@ -45,8 +41,13 @@ module ScoutApm
       ScoutApm::PlatformIntegrations::Server.new,
     ]
 
+    DEPLOY_INTEGRATIONS = [
+      ScoutApm::DeployIntegrations::Capistrano3.new(STDOUT_LOGGER),
+      # ScoutApm::DeployIntegrations::Capistrano2.new(STDOUT_LOGGER),
+    ]
+
     def env
-      @env ||= framework_integration.env
+      @env ||= deploy_integration? ? deploy_integration.env : framework_integration.env
     end
 
     def framework
@@ -62,9 +63,7 @@ module ScoutApm
     end
 
     def application_name
-      Agent.instance.context.config.value("name") ||
-        framework_integration.application_name ||
-        "App"
+      Agent.instance.config.value("name") || framework_integration.application_name
     end
 
     def database_engine
@@ -88,20 +87,12 @@ module ScoutApm
                       end
     end
 
-    def scm_subdirectory
-      @scm_subdirectory ||= if Agent.instance.context.config.value('scm_subdirectory').empty?
-        ''
-      else
-        Agent.instance.context.config.value('scm_subdirectory').sub(/^\//, '') # Trim any leading slash
-      end
-    end
-
     def root
-      @root ||= framework_root
+      @root ||= deploy_integration? ? deploy_integration.root : framework_root
     end
 
     def framework_root
-      if override_root = Agent.instance.context.config.value("application_root")
+      if override_root = Agent.instance.config.value("application_root")
         return override_root
       end
       if framework == :rails
@@ -116,11 +107,7 @@ module ScoutApm
     end
 
     def hostname
-      @hostname ||= Agent.instance.context.config.value("hostname") || platform_integration.hostname
-    end
-
-    def git_revision
-      @git_revision ||= ScoutApm::GitRevision.new(Agent.instance.context)
+      @hostname ||= Agent.instance.config.value("hostname") || platform_integration.hostname
     end
 
     # Returns the whole integration object
@@ -144,17 +131,24 @@ module ScoutApm
       app_server_integration.forking? || (background_job_integration && background_job_integration.forking?)
     end
 
-    def background_job_integrations
-      if Agent.instance.context.config.value("enable_background_jobs")
-        @background_job_integrations ||= BACKGROUND_JOB_INTEGRATIONS.select {|integration| integration.present?}
+    def background_job_integration
+      if Agent.instance.config.value("enable_background_jobs")
+        @background_job_integration ||= BACKGROUND_JOB_INTEGRATIONS.detect {|integration| integration.present?}
       else
-        []
+        nil
       end
     end
 
-    # If both stdin & stdout are interactive and the Rails::Console constant is defined
-    def interactive?
-      defined?(::Rails::Console) && $stdout.isatty && $stdin.isatty
+    def background_job_name
+      background_job_integration && background_job_integration.name
+    end
+
+    def deploy_integration
+      @deploy_integration ||= DEPLOY_INTEGRATIONS.detect{ |integration| integration.present? }
+    end
+
+    def deploy_integration?
+      !@deploy_integration.nil?
     end
 
     ### ruby checks
@@ -168,23 +162,15 @@ module ScoutApm
     end
 
     def ruby_19?
-      return @ruby_19 if defined?(@ruby_19)
-      @ruby_19 = defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" && RUBY_VERSION.match(/^1\.9/)
+      @ruby_19 ||= defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" && RUBY_VERSION.match(/^1\.9/)
     end
 
     def ruby_187?
-      return @ruby_187 if defined?(@ruby_187)
-      @ruby_187 = defined?(RUBY_VERSION) && RUBY_VERSION.match(/^1\.8\.7/)
+      @ruby_187 ||= defined?(RUBY_VERSION) && RUBY_VERSION.match(/^1\.8\.7/)
     end
 
     def ruby_2?
-      return @ruby_2 if defined?(@ruby_2)
-      @ruby_2 = defined?(RUBY_VERSION) && RUBY_VERSION.match(/^2/)
-    end
-
-    # Returns true if this Ruby version supports Module#prepend.
-    def supports_module_prepend?
-      ruby_2?
+      @ruby_2 ||= defined?(RUBY_VERSION) && RUBY_VERSION.match(/^2/)
     end
 
     # Returns a string representation of the OS (ex: darwin, linux)

data/lib/scout_apm/fake_store.rb

@@ -17,15 +17,6 @@ module ScoutApm
     def track_one!(type, name, value, options={})
     end
 
-    def track_trace!(trace, type)
-    end
-
-    def track_histograms!(histograms, options={})
-    end
-
-    def track_db_query_metrics!(db_query_metric_set, options={})
-    end
-
     def track_slow_transaction!(slow_transaction)
     end
 
@@ -40,8 +31,5 @@ module ScoutApm
 
     def add_sampler(sampler)
     end
-
-    def tick!
-    end
   end
 end

data/lib/scout_apm/framework_integrations/rails_2.rb

@@ -15,8 +15,7 @@ module ScoutApm
 
       def present?
         defined?(::Rails) &&
-          defined?(::Rails::VERSION) &&
-            defined?(ActionController) &&
+          defined?(ActionController) &&
           Rails::VERSION::MAJOR < 3
       end
 

data/lib/scout_apm/framework_integrations/rails_3_or_4.rb

@@ -15,8 +15,7 @@ module ScoutApm
 
       def present?
         defined?(::Rails) &&
-          defined?(::Rails::VERSION) &&
-            defined?(ActionController) &&
+          defined?(ActionController) &&
           Rails::VERSION::MAJOR >= 3
       end
 
@@ -48,7 +47,6 @@ module ScoutApm
           when "sqlite"     then :sqlite
           when "mysql"      then :mysql
           when "mysql2"     then :mysql
-          when "sqlserver"  then :sqlserver
           else default
           end
         else
@@ -57,21 +55,12 @@ module ScoutApm
         end
       end
 
-      # Note, this code intentionally avoids `.respond_to?` because of an
-      # infinite loop created by the Textacular gem (tested against 3.2.2 of
-      # that gem), which some customers have installed.
-      #
-      # The loop was:
-      #   - Ask for database adapter
-      #   - Do .respond_to? on AR::Base to look for connection_config (which isn't present on some versions of rails)
-      #   - Textacular gem has a monkey-patch that queries the columns of the db
-      #     This obtains a connection, and runs a query.
-      #   - Scout tries to run SQLSanitizer against the query, which needs the database adapter.
-      #   - Goes back to first step.
-      #
-      # We avoid this issue by not calling .respond_to? here, and instead using the less optimal `rescue nil` approach
       def raw_database_adapter
-        adapter = ActiveRecord::Base.connection_config[:adapter].to_s rescue nil
+        adapter = if ActiveRecord::Base.respond_to?(:connection_config)
+                    ActiveRecord::Base.connection_config[:adapter].to_s
+                  else
+                    nil
+                  end
 
         if adapter.nil?
           adapter = ActiveRecord::Base.configurations[env]["adapter"]

data/lib/scout_apm/framework_integrations/sinatra.rb

@@ -25,7 +25,7 @@ module ScoutApm
           "Sinatra"
         end
       rescue => e
-        ScoutApm::Agent.instance.context.logger.debug "Failed getting Sinatra Application Name: #{e.message}\n#{e.backtrace.join("\n\t")}"
+        ScoutApm::Agent.instance.logger.debug "Failed getting Sinatra Application Name: #{e.message}\n#{e.backtrace.join("\n\t")}"
         "Sinatra"
       end
 

data/lib/scout_apm/histogram.rb

@@ -90,11 +90,7 @@ module ScoutApm
     def combine!(other)
       mutex.synchronize do
         other.mutex.synchronize do
-          @bins = (other.bins + @bins).
-            group_by {|b| b.value }.
-            map {|val, bs| [val, bs.inject(0) {|sum, b| sum + b.count }] }.
-            map {|val, sum| HistogramBin.new(val,sum) }.
-            sort_by { |b| b.value }
+          @bins = (other.bins + @bins).sort_by {|b| b.value }
           @total += other.total
           trim
           self
@@ -104,12 +100,7 @@ module ScoutApm
 
     def as_json
       mutex.synchronize do
-        bins.map{ |b|
-          [
-            ScoutApm::Utils::Numbers.round(b.value, 4),
-            b.count
-          ]
-        }
+        bins.map{|b| [b.value, b.count]}
       end
     end
 
@@ -171,7 +162,7 @@ module ScoutApm
       bins.slice!(minDeltaIndex - 1, 2)
       bins.insert(minDeltaIndex - 1, mergedBin)
     rescue => e
-      ScoutApm::Agent.instance.context.logger.info("Error in NumericHistogram#trim_one. #{e.message}, #{e.backtrace}, #{self.inspect}")
+      ScoutApm::Agent.instance.logger.info("Error in NumericHistogram#trim_one. #{e.message}, #{e.backtrace}, #{self.inspect}")
       raise
     end
   end

data/lib/scout_apm/instant/assets/xmlhttp_instrumentation.html

@@ -3,7 +3,7 @@
   (function(){var open=window.XMLHttpRequest.prototype.open;var send=window.XMLHttpRequest.prototype.send;function openReplacement(method,url,async,user,password){this._url=url;return open.apply(this,arguments);}
     function sendReplacement(data){if(this.onload){this._onload=this.onload;}
       this.onload=onLoadReplacement;return send.apply(this,arguments);}
-    function onLoadReplacement(){if(this._url.startsWith(window.location.protocol+"//"+window.location.host)||!this._url.startsWith("http")){try{var traceText=this.getResponseHeader("X-scoutapminstant");if(traceText){setTimeout(function(){window.scoutInstant("addTrace",traceText)},0);}}catch(e){console.debug("Problem getting X-scoutapminstant header");}}
+    function onLoadReplacement(){if(this._url.startsWith(window.location.protocol+"//"+window.location.host)||!this._url.startsWith("http")){try{traceText=this.getResponseHeader("X-scoutapminstant");if(traceText){setTimeout(function(){window.scoutInstant("addTrace",traceText)},0);}}catch(e){console.debug("Problem getting X-scoutapminstant header");}}
       if(this._onload){return this._onload.apply(this,arguments);}}
     window.XMLHttpRequest.prototype.open=openReplacement;window.XMLHttpRequest.prototype.send=sendReplacement;})();
-</script>
+</script>