scout_apm 5.1.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a569967a27143fe36a506e8757eeda10f2de6cf85567cb2af8c08993b558abb
-  data.tar.gz: 49a5277948f6dab053268af7f912f8905b78d2173c79cfb1c3e9a87288e33113
+  metadata.gz: 4a454dcd926d9c3d9a9432c43ee101bfb9305b2ed181193d55a51fd8d525f3d8
+  data.tar.gz: 9bfdbfb6852b7b933f83f947cb225fe1096083c6a4fe44a0620ff888ee01e26d
 SHA512:
-  metadata.gz: 523767ea43b634748ff16ee974fd6bb659ddced673fbd9106e6f3a07ed8e9d78ec30b88094dac2aff4a374af719691249534aa471a7fc993813018d92bf71333
-  data.tar.gz: f67a78084a1280b497422f4dc35ea3ed5afb1cfbde55c79c4020b11e407674f803ea8d1dec8803bb6bf1fcc8a4e11ac728621cf2f45b8d2d35956497d55a78d7
+  metadata.gz: 29012317cfdcb2958395ca541ec628d4f8d3d2ee5278428075930be30cb9fa445c23463cc11f32dab39649a5b34fd6caf6f981eee7c5c88ef1ade39c36e5806d
+  data.tar.gz: a45e503bcd08fa16cbc885133efcc2bbea64bf76eff6a9de7d5c35a7ddce4ea5a059904c902de6afacba0daba5128b62ce477565aecf2512391962cfea729623

data/.github/workflows/test.yml

@@ -35,11 +35,26 @@ jobs:
             gemfile: gems/rails3.gemfile
             bundler: 1.17.3
           - ruby: 2.7
+          - ruby: 2.7
+            prepend: true
+          - ruby: 3.0
+          - ruby: 3.0
+            prepend: true
+          - ruby: 3.0
+            gemfile: gems/instruments.gemfile
+            test_features: "instruments"
+          - ruby: 3.0
+            gemfile: gems/instruments.gemfile
+            prepend: true
+            test_features: "instruments"
           - ruby: 3.0
+            gemfile: gems/sidekiq.gemfile
+            test_features: "sidekiq_install"
 
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
       SCOUT_TEST_FEATURES: ${{ matrix.test_features }}
+      SCOUT_USE_PREPEND: ${{ matrix.prepend }}
 
     runs-on: ubuntu-latest
 

data/CHANGELOG.markdown

@@ -1,5 +1,21 @@
 # Unreleased
 
+# 5.3.0
+
+* Add configuraiton option to use `Module#prepend` instead of `Module#alias_method` (default)
+  for instrumentation (#448). The default method for instrumentation has not changed, but
+  configuration options were added to allow switching to `Module#prepend` for most
+  instrumentation. Refer to the documentation for more information:
+  [Library Instrumentation Method](https://scoutapm.com/docs/ruby/configuration#library-instrumentation-method)
+
+# 5.2.0
+
+* Use Sidekiq lifecycle hooks to start Scout agent on Sidekiq start. (#449)
+
+# 5.1.1
+
+* Improvements to SqlServer scrubbing in SqlSanitizer (#422)
+
 # 5.1.0
 
 * Specify correct (MIT) license in Gemspec (#430)

data/gems/instruments.gemfile

@@ -0,0 +1,6 @@
+eval_gemfile("../Gemfile")
+
+gem 'httpclient'
+gem 'http'
+gem 'redis'
+gem 'moped'

data/gems/sidekiq.gemfile

@@ -0,0 +1,4 @@
+eval_gemfile("../Gemfile")
+
+# https://github.com/scoutapp/scout_apm_ruby/issues/449
+gem 'sidekiq', '>= 6.5.0'

data/lib/scout_apm/background_job_integrations/sidekiq.rb

@@ -37,17 +37,11 @@ module ScoutApm
       end
 
       def install_processor
-        require 'sidekiq/processor' # sidekiq v4 has not loaded this file by this point
-
-        ::Sidekiq::Processor.class_eval do
-          def initialize_with_scout(*args)
+        ::Sidekiq.configure_server do |config|
+          config.on(:startup) do
             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

data/lib/scout_apm/config.rb

@@ -35,7 +35,13 @@ require 'scout_apm/environment'
 # start_resque_server_instrument - Used in special situations with certain Resque installs
 # timeline_traces - true/false to enable sending of of the timeline trace format.
 # auto_instruments - true/false whether to install autoinstruments. Only installed if on a supported Ruby version.
-# auto_instruments_ignore - An array of file names to exclude from autoinstruments (Ex: ['application_controller']).
+# auto_instruments_ignore  - An array of file names to exclude from autoinstruments (Ex: ['application_controller']).
+# use_prepend              - Whether to apply instrumentation using Module#Prepend instead
+#                            of Module#alias_method (Default: false)
+# alias_method_instruments - If `use_prepend` is true, continue to use Module#alias_method for
+#                            any instruments listed in this array. Default: []
+# prepend_instruments      - If `use_prepend` is false, force using Module#prepend for any
+#                            instruments listed in this array. Default: []
 #
 # Any of these config settings can be set with an environment variable prefixed
 # by SCOUT_ and uppercasing the key: SCOUT_LOG_LEVEL for instance.
@@ -85,6 +91,9 @@ module ScoutApm
         'timeline_traces',
         'auto_instruments',
         'auto_instruments_ignore',
+        'use_prepend',
+        'alias_method_instruments',
+        'prepend_instruments',
 
         # Error Service Related Configuration
         'errors_enabled',
@@ -189,6 +198,9 @@ module ScoutApm
       'timeline_traces' => BooleanCoercion.new,
       'auto_instruments' => BooleanCoercion.new,
       'auto_instruments_ignore' => JsonCoercion.new,
+      'use_prepend' => BooleanCoercion.new,
+      'alias_method_instruments' => JsonCoercion.new,
+      'prepend_instruments' => JsonCoercion.new,
       'errors_enabled' => BooleanCoercion.new,
       'errors_ignored_exceptions' => JsonCoercion.new,
       'errors_filtered_params' => JsonCoercion.new,
@@ -305,6 +317,9 @@ module ScoutApm
         'timeline_traces' => true,
         'auto_instruments' => false,
         'auto_instruments_ignore' => [],
+        'use_prepend' => false,
+        'alias_method_instruments' => [],
+        'prepend_instruments' => [],
         'ssl_cert_file' => File.join( File.dirname(__FILE__), *%w[.. .. data cacert.pem] ),
         'errors_enabled' => false,
         'errors_ignored_exceptions' => %w(ActiveRecord::RecordNotFound ActionController::RoutingError),

data/lib/scout_apm/instrument_manager.rb

@@ -50,6 +50,23 @@ module ScoutApm
       (config.value("disabled_instruments") || []).include?(instrument_short_name)
     end
 
+    def prepend_for_instrument?(instrument_klass)
+      instrument_short_name = instrument_klass.name.split("::").last
+
+      # `use_prepend` defaults to false, which means we use `alias_method` by default.
+      # If `use_prepend` is `true`, then we should default to using `prepend` unless
+      # the instrument is explicitly listed in the `alias_method_instruments` config array.
+      if config.value("use_prepend")
+        return false if (config.value("alias_method_instruments") || []).include?(instrument_short_name)
+        return true
+      else
+        # `use_prepend` is false, but we should use `prepend` if the instrument is
+        # explicitly listed in the `prepend_instruments` array.
+        return true if (config.value("prepend_instruments") || []).include?(instrument_short_name)
+        return false
+      end
+    end
+
     private
 
     def install_instrument(instrument_klass)
@@ -62,7 +79,7 @@ module ScoutApm
 
       instance = instrument_klass.new(context)
       @installed_instruments << instance
-      instance.install
+      instance.install(prepend: prepend_for_instrument?(instrument_klass))
     end
 
     def already_installed?(instrument_klass)

data/lib/scout_apm/instruments/action_controller_rails_2.rb

@@ -16,7 +16,7 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(::ActionController) && defined?(::ActionController::Base)
           @installed = true
 

data/lib/scout_apm/instruments/action_controller_rails_3_rails4.rb

@@ -21,7 +21,7 @@ module ScoutApm
         @installed = true
       end
 
-      def install
+      def install(prepend:)
         if !defined?(::ActiveSupport)
           return
         end

data/lib/scout_apm/instruments/action_view.rb

@@ -29,7 +29,7 @@ module ScoutApm
         context.environment.supports_module_prepend?
       end
 
-      def install
+      def install(prepend:)
         return unless defined?(::ActionView) && defined?(::ActionView::PartialRenderer)
 
         if prependable?

data/lib/scout_apm/instruments/active_record.rb

@@ -50,7 +50,7 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if install_via_after_initialize?
           Rails.configuration.after_initialize do
             add_instruments

data/lib/scout_apm/instruments/elasticsearch.rb

@@ -18,66 +18,115 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(::Elasticsearch) &&
             defined?(::Elasticsearch::Transport) &&
             defined?(::Elasticsearch::Transport::Client)
 
           @installed = true
 
-          logger.info "Instrumenting Elasticsearch"
+          logger.info "Instrumenting Elasticsearch. Prepend: #{prepend}"
 
-          ::Elasticsearch::Transport::Client.class_eval do
-            include ScoutApm::Tracer
+          if prepend
+            ::Elasticsearch::Transport::Client.send(:include, ScoutApm::Tracer)
+            ::Elasticsearch::Transport::Client.send(:prepend, ElasticsearchTransportClientInstrumentationPrepend)
+          else
+            ::Elasticsearch::Transport::Client.class_eval do
+              include ScoutApm::Tracer
 
-            def perform_request_with_scout_instruments(*args, &block)
-              name = _sanitize_name(args[1])
+              def perform_request_with_scout_instruments(*args, &block)
+                name = _sanitize_name(args[1])
 
-              self.class.instrument("Elasticsearch", name, :ignore_children => true) do
-                perform_request_without_scout_instruments(*args, &block)
+                self.class.instrument("Elasticsearch", name, :ignore_children => true) do
+                  perform_request_without_scout_instruments(*args, &block)
+                end
               end
-            end
 
-            alias_method :perform_request_without_scout_instruments, :perform_request
-            alias_method :perform_request, :perform_request_with_scout_instruments
-
-            def _sanitize_name(name)
-              name = name.split("/").last.gsub(/^_/, '')
-              allowed_names = ["bench",
-                               "bulk",
-                               "count",
-                               "exists",
-                               "explain",
-                               "field_stats",
-                               "health",
-                               "mget",
-                               "mlt",
-                               "mpercolate",
-                               "msearch",
-                               "mtermvectors",
-                               "percolate",
-                               "query",
-                               "scroll",
-                               "search_shards",
-                               "source",
-                               "suggest",
-                               "template",
-                               "termvectors",
-                               "update",
-                               "search", ]
-
-              if allowed_names.include?(name)
-                name
-              else
+              alias_method :perform_request_without_scout_instruments, :perform_request
+              alias_method :perform_request, :perform_request_with_scout_instruments
+
+              def _sanitize_name(name)
+                name = name.split("/").last.gsub(/^_/, '')
+                allowed_names = ["bench",
+                                "bulk",
+                                "count",
+                                "exists",
+                                "explain",
+                                "field_stats",
+                                "health",
+                                "mget",
+                                "mlt",
+                                "mpercolate",
+                                "msearch",
+                                "mtermvectors",
+                                "percolate",
+                                "query",
+                                "scroll",
+                                "search_shards",
+                                "source",
+                                "suggest",
+                                "template",
+                                "termvectors",
+                                "update",
+                                "search", ]
+
+                if allowed_names.include?(name)
+                  name
+                else
+                  "Unknown"
+                end
+              rescue
                 "Unknown"
               end
-            rescue
-              "Unknown"
             end
           end
         end
       end
     end
+
+    module ElasticsearchTransportClientInstrumentationPrepend
+      def perform_request(*args, &block)
+        name = _sanitize_name(args[1])
+
+        self.class.instrument("Elasticsearch", name, :ignore_children => true) do
+          super(*args, &block)
+        end
+      end
+
+      def _sanitize_name(name)
+        name = name.split("/").last.gsub(/^_/, '')
+        allowed_names = ["bench",
+                        "bulk",
+                        "count",
+                        "exists",
+                        "explain",
+                        "field_stats",
+                        "health",
+                        "mget",
+                        "mlt",
+                        "mpercolate",
+                        "msearch",
+                        "mtermvectors",
+                        "percolate",
+                        "query",
+                        "scroll",
+                        "search_shards",
+                        "source",
+                        "suggest",
+                        "template",
+                        "termvectors",
+                        "update",
+                        "search", ]
+
+        if allowed_names.include?(name)
+          name
+        else
+          "Unknown"
+        end
+      rescue
+        "Unknown"
+      end
+    end
   end
 end
 

data/lib/scout_apm/instruments/grape.rb

@@ -16,7 +16,7 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(::Grape) && defined?(::Grape::Endpoint)
           @installed = true
 

data/lib/scout_apm/instruments/http.rb

@@ -16,33 +16,53 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(::HTTP) && defined?(::HTTP::Client)
           @installed = true
 
-          logger.info "Instrumenting HTTP::Client"
+          logger.info "Instrumenting HTTP::Client. Prepend: #{prepend}"
 
-          ::HTTP::Client.class_eval do
-            include ScoutApm::Tracer
+          if prepend
+            ::HTTP::Client.send(:include, ScoutApm::Tracer)
+            ::HTTP::Client.send(:prepend, HTTPInstrumentationPrepend)
+          else
+            ::HTTP::Client.class_eval do
+              include ScoutApm::Tracer
 
-            def request_with_scout_instruments(verb, uri, opts = {})
-              self.class.instrument("HTTP", verb, :ignore_children => true, :desc => request_scout_description(verb, uri)) do
-                request_without_scout_instruments(verb, uri, opts)
+              def request_with_scout_instruments(verb, uri, opts = {})
+                self.class.instrument("HTTP", verb, :ignore_children => true, :desc => request_scout_description(verb, uri)) do
+                  request_without_scout_instruments(verb, uri, opts)
+                end
               end
-            end
 
-            def request_scout_description(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 request_scout_description(verb, uri)
+                max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
+                (String(uri).split('?').first)[0..(max_length - 1)]
+              rescue
+                ""
+              end
 
-            alias request_without_scout_instruments request
-            alias request request_with_scout_instruments
+              alias request_without_scout_instruments request
+              alias request request_with_scout_instruments
+            end
           end
         end
       end
     end
+
+    module HTTPInstrumentationPrepend
+      def request(verb, uri, opts = {})
+        self.class.instrument("HTTP", verb, :ignore_children => true, :desc => request_scout_description(verb, uri)) do
+          super(verb, uri, opts)
+        end
+      end
+
+      def request_scout_description(verb, uri)
+        max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
+        (String(uri).split('?').first)[0..(max_length - 1)]
+      rescue
+        ""
+      end
+    end
   end
 end

data/lib/scout_apm/instruments/http_client.rb

@@ -16,33 +16,52 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(::HTTPClient)
           @installed = true
 
-          logger.info "Instrumenting HTTPClient"
+          logger.info "Instrumenting HTTPClient. Prepend: #{prepend}"
 
-          ::HTTPClient.class_eval do
-            include ScoutApm::Tracer
+          if prepend
+            ::HTTPClient.send(:include, ScoutApm::Tracer)
+            ::HTTPClient.send(:prepend, HttpClientInstrumentationPrepend)
+          else
+            ::HTTPClient.class_eval do
+              include ScoutApm::Tracer
 
-            def request_with_scout_instruments(*args, &block)
+              def request_with_scout_instruments(*args, &block)
 
-              method = args[0].to_s
-              url = args[1]
+                method = args[0].to_s
+                url = args[1]
 
-              max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
-              url = url && url.to_s[0..(max_length - 1)]
+                max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
+                url = url && url.to_s[0..(max_length - 1)]
 
-              self.class.instrument("HTTP", method, :desc => url) do
-                request_without_scout_instruments(*args, &block)
+                self.class.instrument("HTTP", method, :desc => url) do
+                  request_without_scout_instruments(*args, &block)
+                end
               end
-            end
 
-            alias request_without_scout_instruments request
-            alias request request_with_scout_instruments
+              alias request_without_scout_instruments request
+              alias request request_with_scout_instruments
+            end
           end
         end
       end
     end
+
+    module HttpClientInstrumentationPrepend
+      def request(*args, &block)
+        method = args[0].to_s
+        url = args[1]
+
+        max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
+        url = url && url.to_s[0..(max_length - 1)]
+
+        self.class.instrument("HTTP", method, :desc => url) do
+          super(request, *args, &block)
+        end
+      end
+    end
   end
 end

data/lib/scout_apm/instruments/influxdb.rb

@@ -16,11 +16,11 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(::InfluxDB)
           @installed = true
 
-          logger.debug "Instrumenting InfluxDB"
+          logger.debug "Instrumenting InfluxDB."
 
           ::InfluxDB::Client.class_eval do
             include ScoutApm::Tracer

data/lib/scout_apm/instruments/memcached.rb

@@ -16,28 +16,43 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(::Dalli) && defined?(::Dalli::Client)
           @installed = true
 
-          logger.info "Instrumenting Memcached"
+          logger.info "Instrumenting Memcached. Prepend: #{prepend}"
 
-          ::Dalli::Client.class_eval do
-            include ScoutApm::Tracer
+          if prepend
+            ::Dalli::Client.send(:include, ScoutApm::Tracer)
+            ::Dalli::Client.send(:prepend, MemcachedInstrumentationPrepend)
+          else
+            ::Dalli::Client.class_eval do
+              include ScoutApm::Tracer
 
-            def perform_with_scout_instruments(*args, &block)
-              command = args.first rescue "Unknown"
+              def perform_with_scout_instruments(*args, &block)
+                command = args.first rescue "Unknown"
 
-              self.class.instrument("Memcached", command) do
-                perform_without_scout_instruments(*args, &block)
+                self.class.instrument("Memcached", command) do
+                  perform_without_scout_instruments(*args, &block)
+                end
               end
-            end
 
-            alias_method :perform_without_scout_instruments, :perform
-            alias_method :perform, :perform_with_scout_instruments
+              alias_method :perform_without_scout_instruments, :perform
+              alias_method :perform, :perform_with_scout_instruments
+            end
           end
         end
       end
     end
+
+    module MemcachedInstrumentationPrepend
+      def perform(*args, &block)
+        command = args.first rescue "Unknown"
+
+        self.class.instrument("Memcached", command) do
+          super(*args, &block)
+        end
+      end
+    end
   end
 end

data/lib/scout_apm/instruments/middleware_detailed.rb

@@ -24,7 +24,7 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(ActionDispatch) && defined?(ActionDispatch::MiddlewareStack) && defined?(ActionDispatch::MiddlewareStack::Middleware)
           @installed = true
 

data/lib/scout_apm/instruments/middleware_summary.rb

@@ -21,7 +21,7 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(ActionDispatch) && defined?(ActionDispatch::MiddlewareStack)
           @installed = true
 

data/lib/scout_apm/instruments/mongoid.rb

@@ -16,7 +16,7 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         @installed = true
 
         # Mongoid versions that use Moped should instrument Moped.

data/lib/scout_apm/instruments/moped.rb

@@ -16,32 +16,37 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(::Moped)
           @installed = true
 
-          logger.info "Instrumenting Moped"
+          logger.info "Instrumenting Moped. Prepend: #{prepend}"
 
-          ::Moped::Node.class_eval do
-            include ScoutApm::Tracer
+          if prepend
+            ::Moped::Node.send(:include, ScoutApm::Tracer)
+            ::Moped::Node.send(:prepend, MopedInstrumentationPrepend)
+          else
+            ::Moped::Node.class_eval do
+              include ScoutApm::Tracer
 
-            def process_with_scout_instruments(operation, &callback)
-              if operation.respond_to?(:collection)
-                collection = operation.collection
-                name = "Process/#{collection}/#{operation.class.to_s.split('::').last}"
-                self.class.instrument("MongoDB", name, :annotate_layer => { :query => scout_sanitize_log(operation.log_inspect) }) do
-                  process_without_scout_instruments(operation, &callback)
+              def process_with_scout_instruments(operation, &callback)
+                if operation.respond_to?(:collection)
+                  collection = operation.collection
+                  name = "Process/#{collection}/#{operation.class.to_s.split('::').last}"
+                  self.class.instrument("MongoDB", name, :annotate_layer => { :query => scout_sanitize_log(operation.log_inspect) }) do
+                    process_without_scout_instruments(operation, &callback)
+                  end
                 end
               end
-            end
-            alias_method :process_without_scout_instruments, :process
-            alias_method :process, :process_with_scout_instruments
-
-            # replaces values w/ ?
-            def scout_sanitize_log(log)
-              return nil if log.length > 1000 # safeguard - don't sanitize large SQL statements
-              log.gsub(/(=>")((?:[^"]|"")*)"/) do
-                $1 + '?' + '"'
+              alias_method :process_without_scout_instruments, :process
+              alias_method :process, :process_with_scout_instruments
+
+              # replaces values w/ ?
+              def scout_sanitize_log(log)
+                return nil if log.length > 1000 # safeguard - don't sanitize large SQL statements
+                log.gsub(/(=>")((?:[^"]|"")*)"/) do
+                  $1 + '?' + '"'
+                end
               end
             end
           end
@@ -49,6 +54,26 @@ module ScoutApm
       end
 
     end
+
+    module MopedInstrumentationPrepend
+      def process(operation, &callback)
+        if operation.respond_to?(:collection)
+          collection = operation.collection
+          name = "Process/#{collection}/#{operation.class.to_s.split('::').last}"
+          self.class.instrument("MongoDB", name, :annotate_layer => { :query => scout_sanitize_log(operation.log_inspect) }) do
+            super(operation, &callback)
+          end
+        end
+      end
+
+      # replaces values w/ ?
+      def scout_sanitize_log(log)
+        return nil if log.length > 1000 # safeguard - don't sanitize large SQL statements
+        log.gsub(/(=>")((?:[^"]|"")*)"/) do
+          $1 + '?' + '"'
+        end
+      end
+    end
   end
 end
 

data/lib/scout_apm/instruments/net_http.rb

@@ -16,41 +16,69 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(::Net) && defined?(::Net::HTTP)
           @installed = true
 
-          logger.info "Instrumenting Net::HTTP"
+          logger.info "Instrumenting Net::HTTP. Prepend: #{prepend}"
 
-          ::Net::HTTP.class_eval do
-            include ScoutApm::Tracer
+          if prepend
+            ::Net::HTTP.send(:include, ScoutApm::Tracer)
+            ::Net::HTTP.send(:prepend, NetHttpInstrumentationPrepend)
+          else
+            ::Net::HTTP.class_eval do
+              include ScoutApm::Tracer
 
-            def request_with_scout_instruments(*args, &block)
-              self.class.instrument("HTTP", "request", :ignore_children => true, :desc => request_scout_description(args.first)) do
-                request_without_scout_instruments(*args, &block)
+              def request_with_scout_instruments(*args, &block)
+                self.class.instrument("HTTP", "request", :ignore_children => true, :desc => request_scout_description(args.first)) do
+                  request_without_scout_instruments(*args, &block)
+                end
               end
-            end
 
-            def request_scout_description(req)
-              path = req.path
-              path = path.path if path.respond_to?(:path)
+              def request_scout_description(req)
+                path = req.path
+                path = path.path if path.respond_to?(:path)
+
+                # Protect against a nil address value
+                if @address.nil?
+                  return "No Address Found"
+                end
 
-              # Protect against a nil address value
-              if @address.nil?
-                return "No Address Found"
+                max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
+                (@address + path.split('?').first)[0..(max_length - 1)]
+              rescue
+                ""
               end
 
-              max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
-              (@address + path.split('?').first)[0..(max_length - 1)]
-            rescue
-              ""
+              alias request_without_scout_instruments request
+              alias request request_with_scout_instruments
             end
-
-            alias request_without_scout_instruments request
-            alias request request_with_scout_instruments
           end
         end
       end
     end
+
+    module NetHttpInstrumentationPrepend
+      def request(request, *args, &block)
+        self.class.instrument("HTTP", "request", :ignore_children => true, :desc => request_scout_description(args.first)) do
+          super(request, *args, &block)
+        end
+      end
+
+      def request_scout_description(req)
+        path = req.path
+        path = path.path if path.respond_to?(:path)
+
+        # Protect against a nil address value
+        if @address.nil?
+          return "No Address Found"
+        end
+
+        max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
+        (@address + path.split('?').first)[0..(max_length - 1)]
+      rescue
+        ""
+      end
+    end
   end
 end

data/lib/scout_apm/instruments/rails_router.rb

@@ -16,7 +16,7 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(ActionDispatch) && defined?(ActionDispatch::Routing) && defined?(ActionDispatch::Routing::RouteSet)
           @installed = true
 

data/lib/scout_apm/instruments/redis.rb

@@ -16,28 +16,43 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(::Redis) && defined?(::Redis::Client)
           @installed = true
 
-          logger.info "Instrumenting Redis"
+          logger.info "Instrumenting Redis. Prepend: #{prepend}"
 
-          ::Redis::Client.class_eval do
-            include ScoutApm::Tracer
+          if prepend
+            ::Redis::Client.send(:include, ScoutApm::Tracer)
+            ::Redis::Client.send(:prepend, RedisClientInstrumentationPrepend)
+          else
+            ::Redis::Client.class_eval do
+              include ScoutApm::Tracer
 
-            def call_with_scout_instruments(*args, &block)
-              command = args.first.first rescue "Unknown"
+              def call_with_scout_instruments(*args, &block)
+                command = args.first.first rescue "Unknown"
 
-              self.class.instrument("Redis", command) do
-                call_without_scout_instruments(*args, &block)
+                self.class.instrument("Redis", command) do
+                  call_without_scout_instruments(*args, &block)
+                end
               end
-            end
 
-            alias_method :call_without_scout_instruments, :call
-            alias_method :call, :call_with_scout_instruments
+              alias_method :call_without_scout_instruments, :call
+              alias_method :call, :call_with_scout_instruments
+            end
           end
         end
       end
     end
+
+    module RedisClientInstrumentationPrepend
+      def call(*args, &block)
+        command = args.first.first rescue "Unknown"
+
+        self.class.instrument("Redis", command) do
+          super(*args, &block)
+        end
+      end
+    end
   end
 end

data/lib/scout_apm/instruments/sinatra.rb

@@ -15,7 +15,7 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(::Sinatra) && defined?(::Sinatra::Base) && ::Sinatra::Base.private_method_defined?(:dispatch!)
           @installed = true
 

data/lib/scout_apm/instruments/typhoeus.rb

@@ -16,7 +16,7 @@ module ScoutApm
         @installed
       end
 
-      def install
+      def install(prepend:)
         if defined?(::Typhoeus)
           @installed = true
 

data/lib/scout_apm/store.rb

@@ -217,6 +217,7 @@ module ScoutApm
 
     def initialize(timestamp, context)
       @timestamp = timestamp
+      @context = context
 
       @request_traces = ScoredItemSet.new(context.config.value('max_traces'))
       @job_traces = ScoredItemSet.new(context.config.value('max_traces'))
@@ -230,6 +231,11 @@ module ScoutApm
       @jobs = Hash.new
     end
 
+    def logger
+      @context.logger
+    end
+    private :logger
+
     # Merges another StoreReportingPeriod into this one
     def merge(other)
       self.

data/lib/scout_apm/utils/sql_sanitizer.rb

@@ -34,7 +34,8 @@ module ScoutApm
       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_EXECUTESQL = /EXEC sp_executesql (N')?/.freeze
+      SQLSERVER_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
       SQLSERVER_REMOVE_INTEGERS = /(?<!LIMIT )\b(?<!@)\d+\b/.freeze
       SQLSERVER_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
 
@@ -67,7 +68,8 @@ module ScoutApm
       private
 
       def to_s_sqlserver
-        sql.gsub!(SQLSERVER_EXECUTESQL, '\1')
+        sql.gsub!(SQLSERVER_REMOVE_EXECUTESQL, '')
+        sql.gsub!(SQLSERVER_REMOVE_STRINGS, '?')
         sql.gsub!(SQLSERVER_REMOVE_INTEGERS, '?')
         sql.gsub!(SQLSERVER_IN_CLAUSE, 'IN (?)')
         sql

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "5.1.0"
+  VERSION = "5.3.0"
 end

data/test/unit/background_job_integrations/sidekiq_test.rb

@@ -3,8 +3,25 @@ require 'scout_apm/request_manager'
 require 'scout_apm/background_job_integrations/sidekiq'
 
 class SidekiqTest < Minitest::Test
+  SidekiqIntegration = ScoutApm::BackgroundJobIntegrations::Sidekiq
   SidekiqMiddleware = ScoutApm::BackgroundJobIntegrations::SidekiqMiddleware
 
+  ########################################
+  # Install
+  ########################################
+  if (ENV["SCOUT_TEST_FEATURES"] || "").include?("sidekiq_install")
+    require 'sidekiq'
+
+    # Sidekiq::CLI needs to be defined in order for `Sidekiq.configure_server` to work
+    Sidekiq::CLI = nil
+
+    def test_starts_on_startup
+      ::ScoutApm::Agent.any_instance.expects(:start)
+      SidekiqIntegration.new.install
+      Sidekiq.options[:lifecycle_events][:startup].map(&:call)
+    end
+  end
+
   ########################################
   # Middleware
   ########################################

data/test/unit/instruments/active_record_test.rb

@@ -29,7 +29,7 @@ class ActiveRecordTest < Minitest::Test
     agent_context.recorder = recorder
 
     instrument = ScoutApm::Instruments::ActiveRecord.new(agent_context)
-    instrument.install
+    instrument.install(prepend: false)
 
     ScoutApm::Tracer.instrument("Controller", "foo/bar") do
       user = User.create

data/test/unit/instruments/http_client_test.rb

@@ -0,0 +1,24 @@
+if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
+  require 'test_helper'
+
+  require 'scout_apm/instruments/http_client'
+
+  require 'httpclient'
+
+  class HttpClientTest < Minitest::Test
+    def setup
+      @context = ScoutApm::AgentContext.new
+      @instance = ScoutApm::Instruments::HttpClient.new(@context)
+      @instrument_manager = ScoutApm::InstrumentManager.new(@context)
+      @instance.install(prepend: @instrument_manager.prepend_for_instrument?(@instance.class))
+    end
+
+    def test_installs_using_proper_method
+      if @instrument_manager.prepend_for_instrument?(@instance.class) == true
+        assert ::HTTPClient.ancestors.include?(ScoutApm::Instruments::HttpClientInstrumentationPrepend)
+      else
+        assert_equal false, ::HTTPClient.ancestors.include?(ScoutApm::Instruments::HttpClientInstrumentationPrepend)
+      end
+    end
+  end
+end

data/test/unit/instruments/http_test.rb

@@ -0,0 +1,24 @@
+if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
+  require 'test_helper'
+
+  require 'scout_apm/instruments/http'
+
+  require 'http'
+
+  class HttpTest < Minitest::Test
+    def setup
+      @context = ScoutApm::AgentContext.new
+      @instance = ScoutApm::Instruments::HTTP.new(@context)
+      @instrument_manager = ScoutApm::InstrumentManager.new(@context)
+      @instance.install(prepend: @instrument_manager.prepend_for_instrument?(@instance.class))
+    end
+
+    def test_installs_using_proper_method
+      if @instrument_manager.prepend_for_instrument?(@instance.class) == true
+        assert ::HTTP::Client.ancestors.include?(ScoutApm::Instruments::HTTPInstrumentationPrepend)
+      else
+        assert_equal false, ::HTTP::Client.ancestors.include?(ScoutApm::Instruments::HTTPInstrumentationPrepend)
+      end
+    end
+  end
+end

data/test/unit/instruments/moped_test.rb

@@ -0,0 +1,24 @@
+if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
+  require 'test_helper'
+
+  require 'scout_apm/instruments/moped'
+
+  require 'moped'
+
+  class MopedTest < Minitest::Test
+    def setup
+      @context = ScoutApm::AgentContext.new
+      @instance = ScoutApm::Instruments::Moped.new(@context)
+      @instrument_manager = ScoutApm::InstrumentManager.new(@context)
+      @instance.install(prepend: @instrument_manager.prepend_for_instrument?(@instance.class))
+    end
+
+    def test_installs_using_proper_method
+      if @instrument_manager.prepend_for_instrument?(@instance.class) == true
+        assert ::Moped::Node.ancestors.include?(ScoutApm::Instruments::MopedInstrumentationPrepend)
+      else
+        assert_equal false, ::Moped::Node.ancestors.include?(ScoutApm::Instruments::MopedInstrumentationPrepend)
+      end
+    end
+  end
+end

data/test/unit/instruments/net_http_test.rb

@@ -7,7 +7,9 @@ require 'addressable/uri'
 class NetHttpTest < Minitest::Test
   def setup
     @context = ScoutApm::AgentContext.new
-    ScoutApm::Instruments::NetHttp.new(@context).install
+    @instance = ScoutApm::Instruments::NetHttp.new(@context)
+    @instrument_manager = ScoutApm::InstrumentManager.new(@context)
+    @instance.install(prepend: @instrument_manager.prepend_for_instrument?(@instance.class))
   end
 
   def test_request_scout_description_for_uri
@@ -24,4 +26,12 @@ class NetHttpTest < Minitest::Test
     req = Net::HTTP::Get.new(Addressable::URI.parse('http://example.org/here'))
     assert_equal '/here', Net::HTTP.new('').request_scout_description(req)
   end
+
+  def test_installs_using_proper_method
+    if @instrument_manager.prepend_for_instrument?(@instance.class) == true
+      assert Net::HTTP.ancestors.include?(ScoutApm::Instruments::NetHttpInstrumentationPrepend)
+    else
+      assert_equal false, Net::HTTP.ancestors.include?(ScoutApm::Instruments::NetHttpInstrumentationPrepend)
+    end
+  end
 end

data/test/unit/instruments/redis_test.rb

@@ -0,0 +1,24 @@
+if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
+  require 'test_helper'
+
+  require 'scout_apm/instruments/redis'
+
+  require 'redis'
+
+  class RedisTest < Minitest::Test
+    def setup
+      @context = ScoutApm::AgentContext.new
+      @instance = ScoutApm::Instruments::Redis.new(@context)
+      @instrument_manager = ScoutApm::InstrumentManager.new(@context)
+      @instance.install(prepend: @instrument_manager.prepend_for_instrument?(@instance.class))
+    end
+
+    def test_installs_using_proper_method
+      if @instrument_manager.prepend_for_instrument?(@instance.class) == true
+        assert ::Redis::Client.ancestors.include?(ScoutApm::Instruments::RedisClientInstrumentationPrepend)
+      else
+        assert_equal false, ::Redis::Client.ancestors.include?(ScoutApm::Instruments::RedisClientInstrumentationPrepend)
+      end
+    end
+  end
+end

data/test/unit/instruments/typhoeus_test.rb

@@ -10,7 +10,7 @@ if (ENV["SCOUT_TEST_FEATURES"] || "").include?("typhoeus")
       @context = ScoutApm::AgentContext.new
       @recorder = FakeRecorder.new
       ScoutApm::Agent.instance.context.recorder = @recorder
-      ScoutApm::Instruments::Typhoeus.new(@context).install
+      ScoutApm::Instruments::Typhoeus.new(@context).install(prepend: false)
     end
 
     def test_instruments_typhoeus_hydra

data/test/unit/sql_sanitizer_test.rb

@@ -123,27 +123,27 @@ module ScoutApm
       end
 
       def test_sqlserver_integers
-        skip "SQLServer Support requires Ruby 1.9+ For Regexes"
-
         sql = "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"
         ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :sqlserver }
-        assert_equal %q|SELECT  [users].* FROM [users] WHERE (age > ?)  ORDER BY [users].[id] ASC OFFSET ? ROWS FETCH NEXT @0 ROWS ONLY|, ss.to_s
+        assert_equal "SELECT  [users].* FROM [users] WHERE (age > ?)  ORDER BY [users].[id] ASC OFFSET ? ROWS FETCH NEXT @0 ROWS ONLY?@0 int', @0 = ?", ss.to_s
       end
 
       def test_sqlserver_strings
-        skip "SQLServer Support requires Ruby 1.9+ For Regexes"
+        sql = "EXEC sp_executesql N'SELECT  [users].* FROM [users] WHERE first_name = N'john' AND last_name = N'doe' ORDER BY [users].[id] ASC OFFSET 0 ROWS FETCH NEXT @0 ROWS ONLY', N'@0 int', @0 = 10"
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :sqlserver }
+        assert_equal "SELECT  [users].* FROM [users] WHERE first_name = N? AND last_name = N? ORDER BY [users].[id] ASC OFFSET ? ROWS FETCH NEXT @0 ROWS ONLY?@0 int', @0 = ?", ss.to_s
+      end
 
-        sql = "EXEC sp_executesql N'SELECT  [users].* FROM [users] WHERE [users].[email] = @0  ORDER BY [users].[id] ASC OFFSET 0 ROWS FETCH NEXT @1 ROWS ONLY', N'@0 nvarchar(4000), @1 int', @0 = N'foo', @1 = 10"
+      def test_sqlserver_strings_no_executesql
+        sql = "EXEC Authenticate @username = N'abraham.lincoln', @password = N'somepassword!', @token = NULL, @app_name = N'Central Auth Service', @log_login = true, @ip_address = N'127.0.0.1', @external_type = NULL, @external_success = NULL"
         ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :sqlserver }
-        assert_equal %q|SELECT  [users].* FROM [users] WHERE [users].[email] = @0  ORDER BY [users].[id] ASC OFFSET ? ROWS FETCH NEXT @1 ROWS ONLY|, ss.to_s
+        assert_equal "EXEC Authenticate @username = N?, @password = N?, @token = NULL, @app_name = N?, @log_login = true, @ip_address = N?, @external_type = NULL, @external_success = NULL", ss.to_s
       end
 
       def test_sqlserver_in_clause
-        skip "SQLServer Support requires Ruby 1.9+ For Regexes"
-
         sql = "EXEC sp_executesql N'SELECT  [users].* FROM [users] WHERE (id IN (1,2,3))  ORDER BY [users].[id] ASC OFFSET 0 ROWS FETCH NEXT @0 ROWS ONLY', N'@0 int', @0 = 10"
         ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :sqlserver }
-        assert_equal %q|SELECT  [users].* FROM [users] WHERE (id IN (?))  ORDER BY [users].[id] ASC OFFSET ? ROWS FETCH NEXT @0 ROWS ONLY|, ss.to_s
+        assert_equal "SELECT  [users].* FROM [users] WHERE (id IN (?))  ORDER BY [users].[id] ASC OFFSET ? ROWS FETCH NEXT @0 ROWS ONLY?@0 int', @0 = ?", ss.to_s
       end
 
       def test_scrubs_invalid_encoding

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2022-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -232,11 +232,13 @@ files:
 - ext/rusage/extconf.rb
 - ext/rusage/rusage.c
 - gems/README.md
+- gems/instruments.gemfile
 - gems/octoshark.gemfile
 - gems/rails3.gemfile
 - gems/rails4.gemfile
 - gems/rails5.gemfile
 - gems/rails6.gemfile
+- gems/sidekiq.gemfile
 - gems/typhoeus.gemfile
 - lib/scout_apm.rb
 - lib/scout_apm/agent.rb
@@ -440,8 +442,12 @@ files:
 - test/unit/histogram_test.rb
 - test/unit/ignored_uris_test.rb
 - test/unit/instruments/active_record_test.rb
+- test/unit/instruments/http_client_test.rb
+- test/unit/instruments/http_test.rb
+- test/unit/instruments/moped_test.rb
 - test/unit/instruments/net_http_test.rb
 - test/unit/instruments/percentile_sampler_test.rb
+- test/unit/instruments/redis_test.rb
 - test/unit/instruments/typhoeus_test.rb
 - test/unit/layaway_test.rb
 - test/unit/layer_children_set_test.rb