scout_apm 4.0.1 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cce8f36675013a0c19a8fcc9c989c3cdb9ce200dbd9d80910ba0f1581a69e6b
-  data.tar.gz: adebeda03d35f00f36f0db73e78a205bd90646f6ab005270660cf7d86a4b685f
+  metadata.gz: 8b7247aa1c6545f1bad63c0f911359ba038686c9cf15b30d560ca887467956ef
+  data.tar.gz: 1fd60f4f23521c1274d27cbf710886bbb5af1baa922ddb3642254917c4db9061
 SHA512:
-  metadata.gz: fc9fc58ab95c94e5d904bc3b04c5d0a37be1cecb965d88cf994a652e46542457d298759f0a8cfce4040def439d77970a04f35d258b2b96546354ef46b93da42e
-  data.tar.gz: f1ab27e4646ccaa8a11220aff213d239b61434f2e511584e560c5234beec9b1746801a53898b49136097c814f726cf31b4d2dafbcaaf928910cd2204f51b5a84
+  metadata.gz: 1581588299fe697107ce3fd8be5575bd63dbc811cf1b6827e08e666ff7e24a9f857366592e632a441e53daea21914c9a9ec7dfdc8acaa1cfaabccde9636b3b56
+  data.tar.gz: 41c2b41c8e7875188f671b59ad23aa62974b2e0c2ae3d08e93366e81158809b14b8b4c8f217c198e39d311ec8ef1921ec672da726a095702c1b7d7521ab0f7f3

data/.github/workflows/test.yml

@@ -26,6 +26,9 @@ jobs:
           - ruby: 2.4
           - ruby: 2.5
           - ruby: 2.6
+          - ruby: 2.6
+            gemfile: gems/typhoeus.gemfile
+            test_features: "typhoeus"
           - ruby: 2.6
             gemfile: gems/octoshark.gemfile
           - ruby: 2.6
@@ -36,6 +39,7 @@ jobs:
 
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+      SCOUT_TEST_FEATURES: ${{ matrix.test_features }}
 
     runs-on: ubuntu-latest
 

data/.travis.yml

@@ -13,6 +13,9 @@ matrix:
     - rvm: 2.6
     - rvm: 2.7
     - rvm: 3.0
+    - rvm: 2.6
+      gemfile: gems/typhoeus.gemfile
+      env: "SCOUT_TEST_FEATURES=typhoeus"
     - rvm: 2.6
       gemfile: gems/octoshark.gemfile
     - rvm: 2.6

data/CHANGELOG.markdown

@@ -1,3 +1,38 @@
+# 4.1.1
+
+* Fix issue with Typheous Hydra instrument (#418)
+
+# 4.1.0
+
+* Preload Celluloid in Shoryuken instrumentation (#331)
+* Fix deprecation warning in Rails 6.1+ (#365)
+* Set Typheous's desc more directly (#392)
+* Delegate to ActiveRecord #log more intelligently (#394)
+* Don't delay starting agent when possible (#397)
+* Fix template naming issue in Rails 6+ (#399)
+* Avoid double-counting issue with AutoInstruments (#405)
+* Renaming test files for Remote::{Server|Route|Message} to be included in test run (#409)
+* More robust naming of Sidekiq jobs (#412)
+* Allow render_template instruments to work with older Rails (#413)
+* Fix function to manually capture exceptions (#415)
+* Enhance SQL Sanitization (#417)
+
+# 4.0.4
+
+* Add Faktory Support (#385)
+* Remove Regexp hack for 1.8.7 (no longer supported) (#384)
+* More robust DelayedJob detection (#382)
+* Fix kwargs handling in Tracing module (#381)
+
+# 4.0.3
+
+* Handle edge case with nil Typhoeus current-layer (#380)
+* Fix args passing to render_partial (#379)
+
+# 4.0.2
+
+* Add Typhoeus instrumentation (#376)
+
 # 4.0.1
 
 * Add support for Ruby 3.0 (#374)

data/gems/typhoeus.gemfile

@@ -0,0 +1,3 @@
+eval_gemfile("../Gemfile")
+
+gem 'typhoeus'

data/lib/scout_apm.rb

@@ -58,6 +58,7 @@ require 'scout_apm/server_integrations/webrick'
 require 'scout_apm/server_integrations/null'
 
 require 'scout_apm/background_job_integrations/sidekiq'
+require 'scout_apm/background_job_integrations/faktory'
 require 'scout_apm/background_job_integrations/delayed_job'
 require 'scout_apm/background_job_integrations/resque'
 require 'scout_apm/background_job_integrations/shoryuken'
@@ -78,6 +79,7 @@ require 'scout_apm/histogram'
 
 require 'scout_apm/instruments/net_http'
 require 'scout_apm/instruments/http_client'
+require 'scout_apm/instruments/typhoeus'
 require 'scout_apm/instruments/moped'
 require 'scout_apm/instruments/mongoid'
 require 'scout_apm/instruments/memcached'
@@ -191,6 +193,7 @@ require 'scout_apm/tasks/support'
 require 'scout_apm/extensions/config'
 require 'scout_apm/extensions/transaction_callback_payload'
 
+require 'scout_apm/error'
 require 'scout_apm/error_service'
 require 'scout_apm/error_service/middleware'
 require 'scout_apm/error_service/notifier'

data/lib/scout_apm/agent/preconditions.rb

@@ -27,10 +27,10 @@ module ScoutApm
         PRECONDITION_DETECTED_SERVER = {
           :message => proc {|environ| "Deferring agent start. Standing by for first request" },
           :check => proc { |context|
-            app_server_missing = !context.environment.app_server_integration(true).found?
-            background_job_missing = context.environment.background_job_integrations.length == 0
+            app_server_found = context.environment.app_server_integration(true).found?
+            background_job_integration_found = context.environment.background_job_integrations.length > 0
 
-            !app_server_missing && !background_job_missing
+            app_server_found || background_job_integration_found
           },
           :severity => :info,
         },

data/lib/scout_apm/auto_instrument/rails.rb

@@ -69,7 +69,6 @@ module ScoutApm
           end
 
           method_name = @method.last.children[0]
-          class_name = @scope.last.children[1]
           bt = ["#{file_name}:#{line}:in `#{method_name}'"]
 
           return [

data/lib/scout_apm/background_job_integrations/delayed_job.rb

@@ -11,7 +11,7 @@ module ScoutApm
       end
 
       def present?
-        defined?(::Delayed::Job)
+        defined?(::Delayed::Worker)
       end
 
       def forking?

data/lib/scout_apm/background_job_integrations/faktory.rb

@@ -0,0 +1,103 @@
+module ScoutApm
+  module BackgroundJobIntegrations
+    class Faktory
+      attr_reader :logger
+
+      def name
+        :faktory
+      end
+
+      def present?
+        defined?(::Faktory)
+      end
+
+      def forking?
+        false
+      end
+
+      def install
+        add_middleware
+        install_processor
+      end
+
+      def add_middleware
+        ::Faktory.configure_worker do |config|
+          config.worker_middleware do |chain|
+            chain.add FaktoryMiddleware
+          end
+        end
+      end
+
+      def install_processor
+        require 'faktory/processor' # sidekiq v4 has not loaded this file by this point
+
+        ::Faktory::Processor.class_eval do
+          def initialize_with_scout(*args)
+            agent = ::ScoutApm::Agent.instance
+            agent.start
+            initialize_without_scout(*args)
+          end
+
+          alias_method :initialize_without_scout, :initialize
+          alias_method :initialize, :initialize_with_scout
+        end
+      end
+    end
+
+    # We insert this middleware into the Sidekiq stack, to capture each job,
+    # and time them.
+    class FaktoryMiddleware
+      def call(worker_instance, job)
+        queue = job["queue"]
+
+        req = ScoutApm::RequestManager.lookup
+        req.annotate_request(:queue_latency => latency(job))
+
+        begin
+          req.start_layer(ScoutApm::Layer.new('Queue', queue))
+          started_queue = true
+          req.start_layer(ScoutApm::Layer.new('Job', job_class(job)))
+          started_job = true
+
+          yield
+        rescue
+          req.error!
+          raise
+        ensure
+          req.stop_layer if started_job
+          req.stop_layer if started_queue
+        end
+      end
+
+      UNKNOWN_CLASS_PLACEHOLDER = 'UnknownJob'.freeze
+      ACTIVE_JOB_KLASS = 'ActiveJob::QueueAdapters::FaktoryAdapter::JobWrapper'.freeze
+
+      def job_class(job)
+        job_class = job.fetch('jobtype', UNKNOWN_CLASS_PLACEHOLDER)
+
+        if job_class == ACTIVE_JOB_KLASS && job.key?('custom') && job['custom'].key?('wrapped')
+          begin
+            job_class = job['custom']['wrapped']
+          rescue
+            ACTIVE_JOB_KLASS
+          end
+        end
+
+        job_class
+      rescue
+        UNKNOWN_CLASS_PLACEHOLDER
+      end
+
+      def latency(job, time = Time.now)
+        created_at = Time.parse(job['enqueued_at'] || job['created_at'])
+        if created_at
+          (time - created_at)
+        else
+          0
+        end
+      rescue
+        0
+      end
+    end
+  end
+end

data/lib/scout_apm/background_job_integrations/shoryuken.rb

@@ -37,6 +37,8 @@ module ScoutApm
       end
 
       def install_processor
+        # celluloid has not loaded by this point and older versions of `shorykuen/processor` assume that it did
+        require 'celluloid' if defined?(::Shoryuken::VERSION) && ::Shoryuken::VERSION < '3'
         require 'shoryuken/processor' # sidekiq v4 has not loaded this file by this point
 
         ::Shoryuken::Processor.class_eval do

data/lib/scout_apm/background_job_integrations/sidekiq.rb

@@ -80,12 +80,23 @@ module ScoutApm
       DELAYED_WRAPPER_KLASS = 'Sidekiq::Extensions::DelayedClass'.freeze
 
 
+      # Capturing the class name is a little tricky, since we need to handle several cases:
+      # 1. ActiveJob, with the class in the key 'wrapped'
+      # 2. ActiveJob, but the 'wrapped' key is wrong (due to YAJL serializing weirdly), find it in args.job_class
+      # 3. DelayedJob wrapper, deserializing using YAML into the real object, which can be introspected
+      # 4. No wrapper, just sidekiq's class
       def job_class(msg)
         job_class = msg.fetch('class', UNKNOWN_CLASS_PLACEHOLDER)
 
-        if job_class == ACTIVE_JOB_KLASS && msg.key?('wrapped')
+        if job_class == ACTIVE_JOB_KLASS && msg.key?('wrapped') && msg['wrapped'].is_a?(String)
           begin
-            job_class = msg['wrapped']
+            job_class = msg['wrapped'].to_s
+          rescue
+            ACTIVE_JOB_KLASS
+          end
+        elsif job_class == ACTIVE_JOB_KLASS && msg.try(:[], 'args').try(:[], 'job_class')
+          begin
+            job_class = msg['args']['job_class'].to_s
           rescue
             ACTIVE_JOB_KLASS
           end

data/lib/scout_apm/environment.rb

@@ -30,6 +30,7 @@ module ScoutApm
       ScoutApm::BackgroundJobIntegrations::Sneakers.new,
       ScoutApm::BackgroundJobIntegrations::DelayedJob.new,
       ScoutApm::BackgroundJobIntegrations::Que.new,
+      ScoutApm::BackgroundJobIntegrations::Faktory.new,
     ]
 
     FRAMEWORK_INTEGRATIONS = [
@@ -197,7 +198,7 @@ module ScoutApm
       ruby_2? || ruby_3?
     end
 
-    # Returns true if this Ruby version supports Module#prepend.
+    # Returns true if this Ruby version makes positional and keyword arguments incompatible
     def supports_kwarg_delegation?
       ruby_3? || (ruby_2? && ruby_minor >= 7)
     end

data/lib/scout_apm/error_service.rb

@@ -16,7 +16,9 @@ module ScoutApm
     # Used internally by SidekiqException
     def self.capture(exception, params = {})
       return if disabled?
-      return if ScoutApm::Agent.instance.context.ignored_exceptions.ignore?(exception)
+
+      context = ScoutApm::Agent.instance.context
+      return if context.ignored_exceptions.ignore?(exception)
 
       context.errors_buffer.capture(exception, env)
     end

data/lib/scout_apm/error_service/middleware.rb

@@ -9,10 +9,10 @@ module ScoutApm
         begin
           response = @app.call(env)
         rescue Exception => exception
-          puts "[Scout Error Service] Caught Exception: #{exception.class.name}"
-
           context = ScoutApm::Agent.instance.context
 
+          context.logger.debug "[Scout Error Service] Caught Exception: #{exception.class.name}"
+
           # Bail out early, and reraise if the error is not interesting.
           if context.ignored_exceptions.ignored?(exception)
             raise

data/lib/scout_apm/error_service/payload.rb

@@ -12,7 +12,7 @@ module ScoutApm
       # TODO: Don't use to_json since it isn't supported in Ruby 1.8.7
       def serialize
         payload = as_json.to_json
-        context.logger.info(payload)
+        context.logger.debug(payload)
         payload
       end
 

data/lib/scout_apm/framework_integrations/rails_3_or_4.rb

@@ -71,7 +71,11 @@ module ScoutApm
       #
       # 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 = ActiveRecord::Base.connection_db_config.configuration_hash[:adapter] rescue nil
+
+        if adapter.nil?
+          adapter = ActiveRecord::Base.connection_config[:adapter].to_s rescue nil
+        end
 
         if adapter.nil?
           adapter = ActiveRecord::Base.configurations[env]["adapter"]

data/lib/scout_apm/ignored_uris.rb

@@ -4,7 +4,9 @@ module ScoutApm
     attr_reader :regex
 
     def initialize(prefixes)
-      regexes = Array(prefixes).map {|prefix| %r{\A#{prefix}} }
+      regexes = Array(prefixes).
+        reject{|prefix| prefix == ""}.
+        map {|prefix| %r{\A#{prefix}} }
       @regex = Regexp.union(*regexes)
     end
 

data/lib/scout_apm/instrument_manager.rb

@@ -30,6 +30,7 @@ module ScoutApm
       install_instrument(ScoutApm::Instruments::Moped)
       install_instrument(ScoutApm::Instruments::Mongoid)
       install_instrument(ScoutApm::Instruments::NetHttp)
+      install_instrument(ScoutApm::Instruments::Typhoeus)
       install_instrument(ScoutApm::Instruments::HttpClient)
       install_instrument(ScoutApm::Instruments::Memcached)
       install_instrument(ScoutApm::Instruments::Redis)

data/lib/scout_apm/instruments/action_controller_rails_3_rails4.rb

@@ -95,8 +95,11 @@ module ScoutApm
               req.instant_key = instant_key
             end
 
-            if current_layer && current_layer.type == "Controller"
-              # Don't start a new layer if ActionController::API or ActionController::Base handled it already.
+            # Don't start a new layer if ActionController::API or
+            # ActionController::Base handled it already. Needs to account for
+            # any layers started during a around_action (most likely
+            # AutoInstrument, but could be another custom instrument)
+            if current_layer && (current_layer.type == "Controller" || current_layer.type == "AutoInstrument" || req.web?)
               super
             else
               begin

data/lib/scout_apm/instruments/action_view.rb

@@ -83,7 +83,7 @@ module ScoutApm
           maybe_template = args[1]
 
           template_name = @template.virtual_path rescue nil        # Works on Rails 3.2 -> end of Rails 5 series
-          template_name ||= maybe_template.virtual_path rescue nil # Works on Rails 6 -> 6.0.3
+          template_name ||= maybe_template.virtual_path rescue nil # Works on Rails 6 -> 6.0.3.5
           template_name ||= "Unknown Partial"
 
           layer_name = template_name + "/Rendering"
@@ -105,7 +105,10 @@ module ScoutApm
         def collection_with_template(*args, **kwargs)
           req = ScoutApm::RequestManager.lookup
 
-          template_name = @template.virtual_path rescue "Unknown Collection"
+          maybe_template = args[1]
+
+          template_name = @template.virtual_path rescue nil # Works on Rails 3.2 -> end of Rails 5 series
+          template_name ||= maybe_template.virtual_path rescue nil # Works on Rails 6 -> 6.0.3.5
           template_name ||= "Unknown Collection"
           layer_name = template_name + "/Rendering"
 
@@ -126,10 +129,15 @@ module ScoutApm
       end
 
       module ActionViewTemplateRendererInstruments
-        def render_template(*args, **kwargs)
+        # Don't forward kwargs here, since Rails 3, 4, 5, 6 don't use them, and
+        # it causes annoyances in the instrumentation
+        def render_template(*args)
           req = ScoutApm::RequestManager.lookup
 
-          template_name = args[0].virtual_path rescue "Unknown"
+          maybe_template = args[1]
+
+          template_name = args[0].virtual_path rescue nil # Works on Rails 3.2 -> end of Rails 5 series
+          template_name ||= maybe_template.virtual_path rescue nil # Works on Rails 6 -> 6.1.3
           template_name ||= "Unknown"
           layer_name = template_name + "/Rendering"
 
@@ -138,11 +146,7 @@ module ScoutApm
 
           begin
             req.start_layer(layer)
-            if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?
-              super(*args, **kwargs)
-            else
-              super(*args)
-            end
+            super(*args)
           ensure
             req.stop_layer
           end

data/lib/scout_apm/instruments/active_record.rb

@@ -215,6 +215,7 @@ module ScoutApm
           end
         end
       end
+      ruby2_keywords :log if respond_to?(:ruby2_keywords, true)
     end
 
     module ActiveRecordInstruments
@@ -267,6 +268,7 @@ module ScoutApm
           end
         end
       end
+      ruby2_keywords :log if respond_to?(:ruby2_keywords, true)
     end
 
     ################################################################################

data/lib/scout_apm/instruments/typhoeus.rb

@@ -0,0 +1,90 @@
+module ScoutApm
+  module Instruments
+    class Typhoeus
+      attr_reader :context
+
+      def initialize(context)
+        @context = context
+        @installed = false
+      end
+
+      def logger
+        context.logger
+      end
+
+      def installed?
+        @installed
+      end
+
+      def install
+        if defined?(::Typhoeus)
+          @installed = true
+
+          logger.info "Instrumenting Typhoeus"
+
+          ::Typhoeus::Request.send(:prepend, TyphoeusInstrumentation)
+          ::Typhoeus::Hydra.send(:prepend, TyphoeusHydraInstrumentation)
+        end
+      end
+
+      module TyphoeusHydraInstrumentation
+        def run(*args, &block)
+          layer = ScoutApm::Layer.new("HTTP", "Hydra")
+          layer.desc = scout_desc
+
+          req = ScoutApm::RequestManager.lookup
+          req.start_layer(layer)
+
+          begin
+            super(*args, &block)
+          ensure
+            req.stop_layer
+          end
+        end
+
+        def scout_desc
+          "#{self.queued_requests.count} requests"
+        rescue
+          ""
+        end
+      end
+
+      module TyphoeusInstrumentation
+        def run(*args, &block)
+          layer = ScoutApm::Layer.new("HTTP", scout_request_verb)
+          layer.desc = scout_desc(scout_request_verb, scout_request_url)
+
+          req = ScoutApm::RequestManager.lookup
+          req.start_layer(layer)
+
+          begin
+            super(*args, &block)
+          ensure
+            req.stop_layer
+          end
+        end
+
+        def scout_desc(verb, uri)
+          max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
+          (String(uri).split('?').first)[0..(max_length - 1)]
+        rescue
+          ""
+        end
+
+        def scout_request_url
+          self.url
+        rescue
+          ""
+        end
+
+        def scout_request_verb
+          self.options[:method].to_s
+        rescue
+          ""
+        end
+
+      end
+
+    end
+  end
+end

data/lib/scout_apm/layer_converters/find_layer_by_type.rb

@@ -5,6 +5,10 @@
 #       show
 #       render :update
 #     end
+
+# This doesn't cache the negative result when searching for a controller / job,
+# so that we can ask again later after more of the request has occurred and
+# correctly find it.
 module ScoutApm
   module LayerConverters
     class FindLayerByType

data/lib/scout_apm/logger.rb

@@ -76,7 +76,7 @@ module ScoutApm
       klass = @opts.fetch(:logger_class, ::Logger)
       case klass
       when String
-        result = KlassHelper.lookup(klass)
+        result = Utils::KlassHelper.lookup(klass)
         if result == :missing_class
           ::Logger
         else

data/lib/scout_apm/serializers/payload_serializer_to_json.rb

@@ -45,31 +45,17 @@ module ScoutApm
           "{#{str_parts.join(",")}}"
         end
 
-        # Ruby 1.8.7 seems to be fundamentally different in how gsub or regexes
-        # work. This is a hack and will be removed as soon as we can drop
-        # support
-        if RUBY_VERSION == "1.8.7"
-          ESCAPE_MAPPINGS = {
-            "\b" => '\\b',
-            "\t" => '\\t',
-            "\n" => '\\n',
-            "\f" => '\\f',
-            "\r" => '\\r',
-            '"'  => '\\"',
-            '\\' => '\\\\',
-          }
-        else
-          ESCAPE_MAPPINGS = {
-            # Stackoverflow answer on gsub matches and backslashes - https://stackoverflow.com/a/4149087/2705125
-            '\\' => '\\\\\\\\',
-            "\b" => '\\b',
-            "\t" => '\\t',
-            "\n" => '\\n',
-            "\f" => '\\f',
-            "\r" => '\\r',
-            '"'  => '\\"',
-          }
-        end
+        ESCAPE_MAPPINGS = {
+          # Stackoverflow answer on gsub matches and backslashes
+          # https://stackoverflow.com/a/4149087/2705125
+          '\\' => '\\\\\\\\',
+          "\b" => '\\b',
+          "\t" => '\\t',
+          "\n" => '\\n',
+          "\f" => '\\f',
+          "\r" => '\\r',
+          '"'  => '\\"',
+        }
 
         def escape(string)
           ESCAPE_MAPPINGS.inject(string.to_s) {|s, (bad, good)| 

data/lib/scout_apm/tracer.rb

@@ -91,7 +91,7 @@ module ScoutApm
 
       def _instrumented_method_string(instrumented_name, uninstrumented_name, type, name, options={})
         method_str = <<-EOF
-        def #{instrumented_name}(*args, &block)
+        def #{instrumented_name}(*args#{", **kwargs" if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?}, &block)
           name = begin
                    "#{name}"
                  rescue => e
@@ -103,7 +103,7 @@ module ScoutApm
                                name,
                                {:scope => #{options[:scope] || false}}
                              ) do
-            #{uninstrumented_name}(*args, &block)
+            #{uninstrumented_name}(*args#{", **kwargs" if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?}, &block)
           end
         end
         EOF

data/lib/scout_apm/utils/sql_sanitizer.rb

@@ -5,12 +5,34 @@ require 'scout_apm/environment'
 module ScoutApm
   module Utils
     class SqlSanitizer
-      if ScoutApm::Environment.instance.ruby_187?
-        require 'scout_apm/utils/sql_sanitizer_regex_1_8_7'
-      else
-        require 'scout_apm/utils/sql_sanitizer_regex'
-      end
-      include ScoutApm::Utils::SqlRegex
+      MULTIPLE_SPACES    = %r|\s+|.freeze
+      MULTIPLE_QUESTIONS = /\?(,\?)+/.freeze
+
+      PSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*\z|.freeze
+      PSQL_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
+      PSQL_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
+      PSQL_AFTER_SELECT = /(?:SELECT\s+).*?(?:WHERE|FROM\z)/im.freeze # Should be everything between a FROM and a WHERE
+      PSQL_PLACEHOLDER = /\$\d+/.freeze
+      PSQL_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
+      PSQL_AFTER_FROM = /(?:FROM\s+).*?(?:WHERE|\z)/im.freeze # Should be everything between a FROM and a WHERE
+      PSQL_AFTER_JOIN = /(?:JOIN\s+).*?\z/im.freeze
+      PSQL_AFTER_WHERE = /(?:WHERE\s+).*?(?:SELECT|\z)/im.freeze
+      PSQL_AFTER_SET = /(?:SET\s+).*?(?:WHERE|\z)/im.freeze
+
+      MYSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
+      MYSQL_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
+      MYSQL_REMOVE_SINGLE_QUOTE_STRINGS = %r{'(?:\\'|[^']|'')*'}.freeze
+      MYSQL_REMOVE_DOUBLE_QUOTE_STRINGS = %r{"(?:\\"|[^"]|"")*"}.freeze
+      MYSQL_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
+
+      SQLITE_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
+      SQLITE_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
+      SQLITE_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
+
+      # => "EXEC sp_executesql N'SELECT  [users].* FROM [users] WHERE (age > 50)  ORDER BY [users].[id] ASC OFFSET 0 ROWS FETCH NEXT @0 ROWS ONLY', N'@0 int', @0 = 10"
+      SQLSERVER_EXECUTESQL = /EXEC sp_executesql N'(.*?)'.*/
+      SQLSERVER_REMOVE_INTEGERS = /(?<!LIMIT )\b(?<!@)\d+\b/.freeze
+      SQLSERVER_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
 
       attr_accessor :database_engine
 
@@ -50,7 +72,9 @@ module ScoutApm
       def to_s_postgres
         sql.gsub!(PSQL_PLACEHOLDER, '?')
         sql.gsub!(PSQL_VAR_INTERPOLATION, '')
+        # sql.gsub!(PSQL_REMOVE_STRINGS, '?')
         sql.gsub!(PSQL_AFTER_WHERE) {|c| c.gsub(PSQL_REMOVE_STRINGS, '?')}
+        sql.gsub!(PSQL_AFTER_JOIN) {|c| c.gsub(PSQL_REMOVE_STRINGS, '?')}
         sql.gsub!(PSQL_AFTER_SET) {|c| c.gsub(PSQL_REMOVE_STRINGS, '?')}
         sql.gsub!(PSQL_REMOVE_INTEGERS, '?')
         sql.gsub!(PSQL_IN_CLAUSE, 'IN (?)')

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "4.0.1"
+  VERSION = "4.1.1"
 end

data/test/unit/auto_instrument/anonymous_block_value.rb

@@ -0,0 +1,7 @@
+class TestController < ApplicationController
+  def index
+    quests = policy_scope(Quest.open)
+    quests.each { _1.current_user = current_user }
+    respond_with_proto quests
+  end
+end

data/test/unit/auto_instrument/hanging_method.rb

@@ -0,0 +1,6 @@
+class TestController < ApplicationController
+end
+
+def hanging_method
+  Test.first
+end

data/test/unit/auto_instrument_test.rb

@@ -51,4 +51,12 @@ class AutoInstrumentTest < Minitest::Test
     assert_equal instrumented_source("assignments"),
       normalize_backtrace(::ScoutApm::AutoInstrument::Rails.rewrite(source_path("assignments")))
   end
+
+  def test_hanging_method_rewrite
+    ::ScoutApm::AutoInstrument::Rails.rewrite(source_path("hanging_method"))
+  end
+
+  def test_anonymous_block_value
+    ::ScoutApm::AutoInstrument::Rails.rewrite(source_path("anonymous_block_value"))
+  end
 end if defined? ScoutApm::AutoInstrument

data/test/unit/ignored_uris_test.rb

@@ -13,4 +13,10 @@ class IgnoredUrlsTest < Minitest::Test
     i = ScoutApm::IgnoredUris.new(["/slow", "/health"])
     assert_equal false, i.ignore?("/users/2/health")
   end
+
+  def test_does_not_ignore_empty_string
+    i = ScoutApm::IgnoredUris.new(["", "/admin"])
+    assert_equal false, i.ignore?("/users/2/health")
+    assert_equal true, i.ignore?("/admin/dashboard")
+  end
 end

data/test/unit/instruments/typhoeus_test.rb

@@ -0,0 +1,42 @@
+if (ENV["SCOUT_TEST_FEATURES"] || "").include?("typhoeus")
+  require 'test_helper'
+
+  require 'scout_apm/instruments/typhoeus'
+
+  require 'typhoeus'
+
+  class TyphoeusTest < Minitest::Test
+    def setup
+      @context = ScoutApm::AgentContext.new
+      @recorder = FakeRecorder.new
+      ScoutApm::Agent.instance.context.recorder = @recorder
+      ScoutApm::Instruments::Typhoeus.new(@context).install
+    end
+
+    def test_instruments_typhoeus_hydra
+      hydra = Typhoeus::Hydra.new
+      2.times.map{ hydra.queue(Typhoeus::Request.new("example.com", followlocation: true)) }
+
+      assert_equal "2 requests", hydra.scout_desc
+
+      hydra.run
+      assert_equal "0 requests", hydra.scout_desc
+      assert_recorded(@recorder, "HTTP", "Hydra", "2 requests")
+    end
+
+    def test_instruments_typhoeus
+      Typhoeus.get("example.com", followlocation: true)
+      assert_recorded(@recorder, "HTTP", "get", "example.com")
+    end
+
+    private
+
+    def assert_recorded(recorder, type, name, desc = nil)
+      req = recorder.requests.first
+      assert req, "recorder recorded no layers"
+      assert_equal type, req.root_layer.type
+      assert_equal name, req.root_layer.name
+      assert_equal desc, req.root_layer.desc if !desc.nil?
+    end
+  end
+end

data/test/unit/remote/{test_server.rb → server_test.rb}

@@ -8,8 +8,11 @@ class TestRemoteServer < Minitest::Test
     logger_io = StringIO.new
     server = ScoutApm::Remote::Server.new(bind, port, router, Logger.new(logger_io))
 
+    # Cannot test this if we can't require webrick. Ruby 3 stopped including by default
+    skip unless server.require_webrick
+
     server.start
-    sleep 0.01 # Let the server finish starting. The assert should instead allow a time
+    sleep 0.05 # Let the server finish starting. The assert should instead allow a time
     assert server.running?
   end
 end

data/test/unit/sql_sanitizer_test.rb

@@ -38,9 +38,9 @@ module ScoutApm
       end
 
       def test_postgres_strips_subquery_strings
-        raw_sql = %q|"SELECT 'orgs'.* FROM "orgs" WHERE  "orgs"."name" = 'Scout' AND "orgs"."created_by_user_id" IN (SELECT 'users'.'id' FROM "users" WHERE (id > AVG(id)) AND "type" = 'USER' AND "created_at" BETWEEN '2019-04-17 12:28:00.000000' AND '2019-04-18 12:28:00.000000')"|
+        raw_sql = %q|"SELECT "orgs".* FROM "orgs" WHERE  "orgs"."name" = 'Scout' AND "orgs"."created_by_user_id" IN (SELECT "users"."id" FROM "users" WHERE (id > AVG(id)) AND "type" = 'USER' AND "created_at" BETWEEN '2019-04-17 12:28:00.000000' AND '2019-04-18 12:28:00.000000')"|
         sanitized_sql = SqlSanitizer.new(raw_sql).tap { |it| it.database_engine = :postgres}
-        expected_sql = %q|"SELECT 'orgs'.* FROM "orgs" WHERE "orgs"."name" = ? AND "orgs"."created_by_user_id" IN (SELECT 'users'.'id' FROM "users" WHERE (id > AVG(id)) AND "type" = ? AND "created_at" BETWEEN ? AND ?)"|
+        expected_sql = %q|"SELECT "orgs".* FROM "orgs" WHERE "orgs"."name" = ? AND "orgs"."created_by_user_id" IN (SELECT "users"."id" FROM "users" WHERE (id > AVG(id)) AND "type" = ? AND "created_at" BETWEEN ? AND ?)"|
         assert_equal expected_sql, sanitized_sql.to_s
       end
 
@@ -66,6 +66,21 @@ module ScoutApm
         end
       end
 
+      def test_postgres_inner_join_subquery
+        sql = %q{SELECT x AS y
+         FROM t1 
+         INNER JOIN (
+           SELECT id,
+           (ts_rank((to_tsvector('simple', coalesce("pg_search_documents"."content"::text, ''))), (to_tsquery('simple', 'xyz' || 'omg' || 'secret')), ?)) AS rank
+           FROM t2
+           WHERE name = 'literal') sub ON sub.id = t1.id WHERE age > 10}
+
+        expected = %q{SELECT x AS y FROM t1 INNER JOIN ( SELECT id, (ts_rank((to_tsvector(?, coalesce("pg_search_documents"."content"::text, ?))), (to_tsquery(?, ? || ? || ?)), ?)) AS rank FROM t2 WHERE name = ?) sub ON sub.id = t1.id WHERE age > ?}
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :postgres }
+
+        assert_equal expected, 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 }

data/test/unit/tracer_test.rb

@@ -65,6 +65,31 @@ class TracerTest < Minitest::Test
     assert_recorded(recorder, "Test", "name")
   end
 
+  if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?
+    def test_instrument_method_with_keyword_args
+      initial_value = Warning[:deprecated]
+      Warning[:deprecated] = true
+      recorder = FakeRecorder.new
+      ScoutApm::Agent.instance.context.recorder = recorder
+
+      klass = Class.new { include ScoutApm::Tracer }
+
+      invoked = false
+      klass.send(:define_method, :work) { |run:| invoked = true }
+      klass.instrument_method(:work, :type => "Test", :name => "name")
+
+      args = { run: false }
+      assert_output(nil, '') do
+        klass.new.work(**args)
+      end
+
+      assert invoked, "instrumented code was not invoked"
+      assert_recorded(recorder, "Test", "name")
+    ensure
+      Warning[:deprecated] = initial_value
+    end
+  end
+
   private
 
   def assert_recorded(recorder, type, name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.1
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-18 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -238,6 +238,7 @@ files:
 - gems/rails4.gemfile
 - gems/rails5.gemfile
 - gems/rails6.gemfile
+- gems/typhoeus.gemfile
 - lib/scout_apm.rb
 - lib/scout_apm/agent.rb
 - lib/scout_apm/agent/exit_handler.rb
@@ -251,6 +252,7 @@ files:
 - lib/scout_apm/auto_instrument/parser.rb
 - lib/scout_apm/auto_instrument/rails.rb
 - lib/scout_apm/background_job_integrations/delayed_job.rb
+- lib/scout_apm/background_job_integrations/faktory.rb
 - lib/scout_apm/background_job_integrations/legacy_sneakers.rb
 - lib/scout_apm/background_job_integrations/que.rb
 - lib/scout_apm/background_job_integrations/resque.rb
@@ -316,6 +318,7 @@ files:
 - lib/scout_apm/instruments/resque.rb
 - lib/scout_apm/instruments/samplers.rb
 - lib/scout_apm/instruments/sinatra.rb
+- lib/scout_apm/instruments/typhoeus.rb
 - lib/scout_apm/job_record.rb
 - lib/scout_apm/layaway.rb
 - lib/scout_apm/layaway_file.rb
@@ -396,8 +399,6 @@ files:
 - lib/scout_apm/utils/numbers.rb
 - lib/scout_apm/utils/scm.rb
 - lib/scout_apm/utils/sql_sanitizer.rb
-- lib/scout_apm/utils/sql_sanitizer_regex.rb
-- lib/scout_apm/utils/sql_sanitizer_regex_1_8_7.rb
 - lib/scout_apm/utils/time.rb
 - lib/scout_apm/utils/unique_id.rb
 - lib/scout_apm/version.rb
@@ -408,11 +409,13 @@ files:
 - test/tmp/README.md
 - test/unit/agent_context_test.rb
 - test/unit/agent_test.rb
+- test/unit/auto_instrument/anonymous_block_value.rb
 - test/unit/auto_instrument/assignments-instrumented.rb
 - test/unit/auto_instrument/assignments.rb
 - test/unit/auto_instrument/controller-ast.txt
 - test/unit/auto_instrument/controller-instrumented.rb
 - test/unit/auto_instrument/controller.rb
+- test/unit/auto_instrument/hanging_method.rb
 - test/unit/auto_instrument/rescue_from-instrumented.rb
 - test/unit/auto_instrument/rescue_from.rb
 - test/unit/auto_instrument_test.rb
@@ -433,6 +436,7 @@ files:
 - test/unit/instruments/active_record_test.rb
 - test/unit/instruments/net_http_test.rb
 - test/unit/instruments/percentile_sampler_test.rb
+- test/unit/instruments/typhoeus_test.rb
 - test/unit/layaway_test.rb
 - test/unit/layer_children_set_test.rb
 - test/unit/layer_converters/depth_first_walker_test.rb
@@ -441,9 +445,9 @@ files:
 - test/unit/limited_layer_test.rb
 - test/unit/logger_test.rb
 - test/unit/metric_set_test.rb
-- test/unit/remote/test_message.rb
-- test/unit/remote/test_router.rb
-- test/unit/remote/test_server.rb
+- test/unit/remote/message_test.rb
+- test/unit/remote/route_test.rb
+- test/unit/remote/server_test.rb
 - test/unit/request_histograms_test.rb
 - test/unit/scored_item_set_test.rb
 - test/unit/serializers/payload_serializer_test.rb

data/lib/scout_apm/utils/sql_sanitizer_regex.rb

@@ -1,32 +0,0 @@
-
-module ScoutApm
-  module Utils
-    module SqlRegex
-      MULTIPLE_SPACES    = %r|\s+|.freeze
-      MULTIPLE_QUESTIONS = /\?(,\?)+/.freeze
-
-      PSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*\z|.freeze
-      PSQL_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
-      PSQL_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
-      PSQL_PLACEHOLDER = /\$\d+/.freeze
-      PSQL_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
-      PSQL_AFTER_WHERE = /(?:WHERE\s+).*?(?:SELECT|\z)/im.freeze
-      PSQL_AFTER_SET = /(?:SET\s+).*?(?:WHERE|\z)/im.freeze
-
-      MYSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
-      MYSQL_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
-      MYSQL_REMOVE_SINGLE_QUOTE_STRINGS = %r{'(?:\\'|[^']|'')*'}.freeze
-      MYSQL_REMOVE_DOUBLE_QUOTE_STRINGS = %r{"(?:\\"|[^"]|"")*"}.freeze
-      MYSQL_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
-
-      SQLITE_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
-      SQLITE_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
-      SQLITE_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
-
-      # => "EXEC sp_executesql N'SELECT  [users].* FROM [users] WHERE (age > 50)  ORDER BY [users].[id] ASC OFFSET 0 ROWS FETCH NEXT @0 ROWS ONLY', N'@0 int', @0 = 10"
-      SQLSERVER_EXECUTESQL = /EXEC sp_executesql N'(.*?)'.*/
-      SQLSERVER_REMOVE_INTEGERS = /(?<!LIMIT )\b(?<!@)\d+\b/.freeze
-      SQLSERVER_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
-    end
-  end
-end

data/lib/scout_apm/utils/sql_sanitizer_regex_1_8_7.rb

@@ -1,32 +0,0 @@
-
-module ScoutApm
-  module Utils
-    module SqlRegex
-      MULTIPLE_SPACES    = %r|\s+|.freeze
-      MULTIPLE_QUESTIONS = /\?(,\?)+/.freeze
-
-      PSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
-      PSQL_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
-      PSQL_REMOVE_INTEGERS = /\b\d+\b/.freeze
-      PSQL_PLACEHOLDER = /\$\d+/.freeze
-      PSQL_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
-      PSQL_AFTER_WHERE = /(?:WHERE\s+).*?(?:SELECT|$)/i.freeze
-      PSQL_AFTER_SET = /(?:SET\s+).*?(?:WHERE|$)/i.freeze
-
-      MYSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
-      MYSQL_REMOVE_INTEGERS = /\b\d+\b/.freeze
-      MYSQL_REMOVE_SINGLE_QUOTE_STRINGS = /'(?:\\'|[^']|'')*'/.freeze
-      MYSQL_REMOVE_DOUBLE_QUOTE_STRINGS = /"(?:\\"|[^"]|"")*"/.freeze
-      MYSQL_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
-
-      SQLITE_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
-      SQLITE_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
-      SQLITE_REMOVE_INTEGERS = /\b\d+\b/.freeze
-
-      # This is not officially supported, but will do its best.
-      SQLSERVER_EXECUTESQL = /EXEC sp_executesql N'(.*?)'.*/
-      SQLSERVER_REMOVE_INTEGERS = /\b\d+\b/.freeze
-      SQLSERVER_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
-    end
-  end
-end