scout_apm 2.1.32 → 2.2.0.pre0

data/lib/scout_apm/context.rb

@@ -75,10 +75,8 @@ module ScoutApm
     def value_valid?(key_value)
       # ensure one of our accepted types.
       value = key_value.values.last
-      if value.nil?
-        false # don't log this ... easy to happen
-      elsif !valid_type?([String, Symbol, Numeric, Time, Date, TrueClass, FalseClass],value)
-        ScoutApm::Agent.instance.logger.info "The value for [#{key_value.keys.first}] is not a valid type [#{value.class}]."
+      if !valid_type?([String, Symbol, Numeric, Time, Date, TrueClass, FalseClass],value)
+        ScoutApm::Agent.instance.logger.warn "The value for [#{key_value.keys.first}] is not a valid type [#{value.class}]."
         false
       else
         true
@@ -88,16 +86,14 @@ module ScoutApm
     # for consistently with #value_valid?, takes a hash eventhough the value isn't yet used.
     def key_valid?(key_value)
       key = key_value.keys.first
-      if key.nil?
-        false # don't log this ... easy to happen
       # ensure a string or a symbol
-      elsif !valid_type?([String, Symbol],key)
-        ScoutApm::Agent.instance.logger.info "The key [#{key}] is not a valid type [#{key.class}]."
+      if !valid_type?([String, Symbol],key)
+        ScoutApm::Agent.instance.logger.warn "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-]/)
-        ScoutApm::Agent.instance.logger.info "They key name [#{key}] is not valid."
+        ScoutApm::Agent.instance.logger.warn "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,9 +24,8 @@ module ScoutApm
     ]
 
     BACKGROUND_JOB_INTEGRATIONS = [
-      ScoutApm::BackgroundJobIntegrations::Resque.new,
       ScoutApm::BackgroundJobIntegrations::Sidekiq.new,
-      ScoutApm::BackgroundJobIntegrations::DelayedJob.new,
+      # ScoutApm::BackgroundJobIntegrations::DelayedJob.new
     ]
 
     FRAMEWORK_INTEGRATIONS = [
@@ -42,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
@@ -59,9 +63,7 @@ module ScoutApm
     end
 
     def application_name
-      Agent.instance.config.value("name") ||
-        framework_integration.application_name ||
-        "App"
+      Agent.instance.config.value("name") || framework_integration.application_name
     end
 
     def database_engine
@@ -85,16 +87,8 @@ module ScoutApm
                       end
     end
 
-    def scm_subdirectory
-      @scm_subdirectory ||= if Agent.instance.config.value('scm_subdirectory').empty?
-        ''
-      else
-        Agent.instance.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
@@ -116,10 +110,6 @@ module ScoutApm
       @hostname ||= Agent.instance.config.value("hostname") || platform_integration.hostname
     end
 
-    def git_revision
-      @git_revision ||= ScoutApm::GitRevision.new
-    end
-
     # Returns the whole integration object
     # This needs to be improved. Frequently, multiple app servers gem are present and which
     # ever is checked first becomes the designated app server.
@@ -153,9 +143,12 @@ module ScoutApm
       background_job_integration && background_job_integration.name
     end
 
-    # If both stdin & stdout are interactive and the Rails::Console constant is defined
-    def interactive?
-      defined?(::Rails::Console) && $stdout.isatty && $stdin.isatty
+    def deploy_integration
+      @deploy_integration ||= DEPLOY_INTEGRATIONS.detect{ |integration| integration.present? }
+    end
+
+    def deploy_integration?
+      !@deploy_integration.nil?
     end
 
     ### ruby checks

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
 

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>

data/lib/scout_apm/instant/middleware.rb

@@ -5,11 +5,6 @@ module ScoutApm
     class Page
       def initialize(html)
         @html = html
-
-        if html.is_a?(Array)
-          @html = html.inject("") { |memo, str| memo + str }
-        end
-
         @to_add_to_head = []
         @to_add_to_body = []
       end
@@ -46,204 +41,68 @@ module ScoutApm
     # Note that this middleware never even gets inserted unless Rails environment is development (See Railtie)
     class Middleware
       def initialize(app)
-        @app = app
+        ScoutApm::Agent.instance.logger.info("Activating Scout DevTrace because environment=development and dev_trace=true in scout_apm config")
+        @app        = app
       end
 
       def call(env)
-        rack_response = @app.call(env)
-        begin
-          DevTraceResponseManipulator.new(env, rack_response).call
-        rescue Exception => e
-          # If anything went wrong at all, just bail out and return the unmodified response.
-          ScoutApm::Agent.instance.logger.debug("DevTrace: Raised an exception: #{e.message}, #{e.backtrace}")
-          rack_response
-        end
-      end
-    end
-
-    class DevTraceResponseManipulator
-      attr_reader :rack_response
-      attr_reader :rack_status, :rack_headers, :rack_body
-      attr_reader :env
-
-      def initialize(env, rack_response)
-        @env = env
-        @rack_response = rack_response
-
-        @rack_status = rack_response[0]
-        @rack_headers = rack_response[1]
-        @rack_body = rack_response[2]
-      end
-
-      def call
-        return rack_response unless preconditions_met?
-
-        if ajax_request?
-          ScoutApm::Agent.instance.logger.debug("DevTrace: in middleware, dev_trace is active, and response has a body. This is either AJAX or JSON. Path=#{path}; ContentType=#{content_type}")
-          adjust_ajax_header
-        else
-          adjust_html_response
-        end
-
-        rebuild_rack_response
-      end
-
-      ###########################
-      #  Precondition checking  #
-      ###########################
-
-      def preconditions_met?
-        if dev_trace_disabled?
-          logger.debug("DevTrace: isn't activated via config. Try: SCOUT_DEV_TRACE=true rails server")
-          return false
-        end
-
-        # Don't attempt to instrument assets.
-        # Don't log this case, since it would be very noisy
-        logger.debug("DevTrace: dev asset ignored") and return false if development_asset?
-
-        # If we didn't have a tracked_request object, or we explicitly ignored
-        # this request, don't do any work.
-        logger.debug("DevTrace: no tracked request") and return false if tracked_request.nil? || tracked_request.ignoring_request?
-
-        # If we didn't get a trace, we can't show a trace...
-        if trace.nil?
-          logger.debug("DevTrace: in middleware, dev_trace is active, and response has a body, but no trace was found. Path=#{path}; ContentType=#{content_type}")
-          return false
-        end
-
-        true
-      end
-
-      def dev_trace_disabled?
-        ! ScoutApm::Agent.instance.config.value('dev_trace')
-      end
-
-      ########################
-      #  Response Injection  #
-      ########################
-
-      def rebuild_rack_response
-        [rack_status, rack_headers, rack_body]
-      end
-
-      def adjust_ajax_header
-        rack_headers['X-scoutapminstant'] = payload
-      end
-
-      def adjust_html_response
-        case true
-        when older_rails_response? then adjust_older_rails_response
-        when newer_rails_response? then adjust_newer_rails_response
-        when rack_proxy_response? then  adjust_rack_proxy_response
+        status, headers, response = @app.call(env)
+        path, content_type = env['PATH_INFO'], headers['Content-Type']
+        if ScoutApm::Agent.instance.config.value('dev_trace')
+          if response.respond_to?(:body)
+            req = ScoutApm::RequestManager.lookup
+            slow_converter = LayerConverters::SlowRequestConverter.new(req)
+            trace = slow_converter.call
+            if trace
+              metadata = {
+                  :app_root      => ScoutApm::Environment.instance.root.to_s,
+                  :unique_id     => env['action_dispatch.request_id'], # note, this is a different unique_id than what "normal" payloads use
+                  :agent_version => ScoutApm::VERSION,
+                  :platform      => "ruby",
+              }
+              hash = ScoutApm::Serializers::PayloadSerializerToJson.rearrange_slow_transaction(trace)
+              hash.merge!(metadata:metadata)
+              payload = ScoutApm::Serializers::PayloadSerializerToJson.jsonify_hash(hash)
+
+              if env['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest' || content_type.include?("application/json")
+                ScoutApm::Agent.instance.logger.debug("DevTrace: in middleware, dev_trace is active, and response has a body. This is either AJAX or JSON. Path=#{path}; ContentType=#{content_type}")
+                # Add the payload as a header if it's an AJAX call or JSON
+                headers['X-scoutapminstant'] = payload
+                [status, headers, response]
+              else
+                # otherwise, attempt to add it inline in the page, along with the appropriate JS & CSS. Note, if page doesn't have a head or body,
+                #duration = (req.root_layer.total_call_time*1000).to_i
+                apm_host=ScoutApm::Agent.instance.config.value("direct_host")
+                page = ScoutApm::Instant::Page.new(response.body)
+                page.add_to_head(ScoutApm::Instant::Util.read_asset("xmlhttp_instrumentation.html")) # This monkey-patches XMLHttpRequest. It could possibly be part of the main scout_instant.js too. Putting it here so it runs as soon as possible.
+                page.add_to_head("<link href='#{apm_host}/instant/scout_instant.css?cachebust=#{Time.now.to_i}' media='all' rel='stylesheet' />")
+                page.add_to_body("<script src='#{apm_host}/instant/scout_instant.js?cachebust=#{Time.now.to_i}'></script>")
+                page.add_to_body("<script>var scoutInstantPageTrace=#{payload};window.scoutInstant=window.scoutInstant('#{apm_host}', scoutInstantPageTrace)</script>")
+
+                if response.is_a?(ActionDispatch::Response)
+                  ScoutApm::Agent.instance.logger.debug("DevTrace: in middleware, dev_trace is active, and response has a body. This appears to be an HTML page and an ActionDispatch::Response. Path=#{path}; ContentType=#{content_type}")
+                  # preserve the ActionDispatch::Response when applicable
+                  response.body=[page.res]
+                  [status, headers, response]
+                else
+                  ScoutApm::Agent.instance.logger.debug("DevTrace: in middleware, dev_trace is active, and response has a body. This appears to be an HTML page but not an ActionDispatch::Response. Path=#{path}; ContentType=#{content_type}")
+                  # otherwise, just return an array
+                  [status, headers, [page.res]]
+                end
+              end
+            else
+              ScoutApm::Agent.instance.logger.debug("DevTrace: in middleware, dev_trace is active, and response has a body, but no trace was found. Path=#{path}; ContentType=#{content_type}")
+              [status, headers, response]
+            end
+          else
+            # don't log anything here - this is the path for all assets served in development, and the log would get noisy
+            [status, headers, response]
+          end
         else
-          # No action taken, we only adjust if we know exactly what we have.
-        end
-      end
-
-      def older_rails_response?
-        if defined?(ActionDispatch::Response)
-          return true if rack_body.is_a?(ActionDispatch::Response)
-        end
-      end
-
-      def newer_rails_response?
-        if defined?(ActionDispatch::Response::RackBody)
-          return true if rack_body.is_a?(ActionDispatch::Response::RackBody)
+          ScoutApm::Agent.instance.logger.debug("DevTrace: isn't activated via config. Try: SCOUT_DEV_TRACE=true rails server")
+          [status, headers, response]
         end
       end
-
-      def rack_proxy_response?
-        rack_body.is_a?(Rack::BodyProxy)
-      end
-
-      def adjust_older_rails_response
-        logger.debug("DevTrace: in middleware, dev_trace is active, and response has a (older) body. This appears to be an HTML page and an ActionDispatch::Response. Path=#{path}; ContentType=#{content_type}")
-        rack_body.body = [ html_manipulator.res ]
-      end
-
-      # Preserve the ActionDispatch::Response object we're working with
-      def adjust_newer_rails_response
-        logger.debug("DevTrace: in middleware, dev_trace is active, and response has a (newer) body. This appears to be an HTML page and an ActionDispatch::Response. Path=#{path}; ContentType=#{content_type}")
-        @rack_body = [ html_manipulator.res ]
-      end
-
-      def adjust_rack_proxy_response
-        logger.debug("DevTrace: in middleware, dev_trace is active, and response has a body. This appears to be an HTML page and an Rack::BodyProxy. Path=#{path}; ContentType=#{content_type}")
-        @rack_body = [ html_manipulator.res ]
-        @rack_headers.delete("Content-Length")
-      end
-
-      def html_manipulator
-        @html_manipulator ||=
-          begin
-            page = ScoutApm::Instant::Page.new(rack_body.body)
-
-            # This monkey-patches XMLHttpRequest. It could possibly be part of the main scout_instant.js too. Putting it here so it runs as soon as possible.
-            page.add_to_head(ScoutApm::Instant::Util.read_asset("xmlhttp_instrumentation.html"))
-
-            # Add a link to CSS, then JS
-            page.add_to_head("<link href='#{apm_host}/instant/scout_instant.css?cachebust=#{Time.now.to_i}' media='all' rel='stylesheet' />")
-            page.add_to_body("<script src='#{apm_host}/instant/scout_instant.js?cachebust=#{Time.now.to_i}'></script>")
-            page.add_to_body("<script>var scoutInstantPageTrace=#{payload};window.scoutInstant=window.scoutInstant('#{apm_host}', scoutInstantPageTrace)</script>")
-
-            page
-          end
-      end
-
-      def ajax_request?
-        env['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest' || content_type.include?("application/json")
-      end
-
-      def development_asset?
-        !rack_body.respond_to?(:body)
-      end
-
-      def path
-        env['PATH_INFO']
-      end
-
-      def content_type
-        rack_headers['Content-Type']
-      end
-
-      ##############################
-      #  APM Helpers & Shorthands  #
-      ##############################
-
-      def logger
-        ScoutApm::Agent.instance.logger
-      end
-
-      def tracked_request
-        @tracked_request ||= ScoutApm::RequestManager.lookup
-      end
-
-      def apm_host
-        ScoutApm::Agent.instance.config.value("direct_host")
-      end
-
-      def trace
-        @trace ||= LayerConverters::SlowRequestConverter.new(tracked_request).call
-      end
-
-      def payload
-        @payload ||=
-          begin
-            metadata = {
-              :app_root      => ScoutApm::Environment.instance.root.to_s,
-              :unique_id     => env['action_dispatch.request_id'], # note, this is a different unique_id than what "normal" payloads use
-              :agent_version => ScoutApm::VERSION,
-              :platform      => "ruby",
-            }
-
-            hash = ScoutApm::Serializers::PayloadSerializerToJson.
-              rearrange_slow_transaction(trace).
-              merge!(:metadata => metadata)
-            ScoutApm::Serializers::PayloadSerializerToJson.jsonify_hash(hash)
-          end
-      end
-
     end
   end
-end
+end