scout_apm 5.1.1 → 5.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a1da3776ca231a4d81c9ab5935e6b644ab46ae5609cef60402ccd5258e07795
-  data.tar.gz: f583776f39fa426aa43d1942bd83e4bcd23ca3a6f71a2e883df22a74cb2db868
+  metadata.gz: 656e36a7b9a11b5870058c46b31e8227c628691f8ab7f7d4de991c3e89b5f13d
+  data.tar.gz: 5f27c0af5b3f864a96ea65944c6655106a86aa96dbf489083b1c3a178322d827
 SHA512:
-  metadata.gz: bc2f10c76ea8abbb6f74cbe86cbd0e0d1265143a19008307609be35adb57737f474c9a2f59545e2f36b00b5006c5f1b9726f59e70c3e327e6487eb2445e07df6
-  data.tar.gz: 8863c891bbd5f1e87d56a06f8275cbcf711b15964116cbddbb648398825eed65fa6ce73cd3848815e8ab8a1eec1f8a2e4a878682e2d47d457778786532ee3db4
+  metadata.gz: b805ac798aa0f430182e31e9d4b3d924d20624a59406d333f8d8d02ead0d30bece36bf0b127b4b9e04a5cf149cc9e67621ab72f2143f7fcd5c03f70790fedf09
+  data.tar.gz: 6883c955de7003baeb2685c369f63532b45e1c25b5859067fdfb2112e31abae6f57e2dc44dd5b06f55d66f3a6b9b778904de864c45905a63cdd9516719d59367

data/.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
@@ -35,16 +35,33 @@ jobs:
             gemfile: gems/rails3.gemfile
             bundler: 1.17.3
           - ruby: 2.7
-          - ruby: 3.0
-
+          - 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"
+          - ruby: 3.1
+          - ruby: 3.2
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
       SCOUT_TEST_FEATURES: ${{ matrix.test_features }}
+      SCOUT_USE_PREPEND: ${{ matrix.prepend }}
 
-    runs-on: ubuntu-latest
+    # https://github.com/ruby/setup-ruby/issues/496
+    runs-on: ${{ matrix.ruby == '2.2' && 'ubuntu-20.04' || 'ubuntu-latest' }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true

data/CHANGELOG.markdown

@@ -1,5 +1,37 @@
 # Unreleased
 
+# 5.3.5
+* Fix adding instrumentation of ActiveRecord after configuration has initialized for Rails versions greater than 3. (#465)
+* Fix typo with double use of PercentilePolicy, instead of PercentPolicy, for scoring. (#468)
+* Fix span annotations/desc for external service requests with the use of prepend. (#471)
+* Fix ActiveSupport methods and replace them with non ActiveSupport methods. (#474)
+
+# 5.3.4
+Unused.
+
+# 5.3.3
+
+* Fix double firing of Puma `on_worker_boot` when preloading. (#463)
+
+# 5.3.2
+
+* Update redis instruments to support redis v5.0+ (#458)
+# 5.3.1
+
+* Fix typo in HTTPClient prepend instrumentation (#457)
+
+# 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)

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

@@ -35,6 +35,7 @@ module ScoutApm
       install_instrument(ScoutApm::Instruments::HTTP)
       install_instrument(ScoutApm::Instruments::Memcached)
       install_instrument(ScoutApm::Instruments::Redis)
+      install_instrument(ScoutApm::Instruments::Redis5)
       install_instrument(ScoutApm::Instruments::InfluxDB)
       install_instrument(ScoutApm::Instruments::Elasticsearch)
       install_instrument(ScoutApm::Instruments::Grape)
@@ -50,6 +51,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 +80,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
@@ -66,7 +66,7 @@ module ScoutApm
         defined?(::Rails) &&
           defined?(::Rails::VERSION) &&
           defined?(::Rails::VERSION::MAJOR) &&
-          ::Rails::VERSION::MAJOR.to_i == 3 &&
+          ::Rails::VERSION::MAJOR.to_i >= 3 &&
           ::Rails.respond_to?(:configuration)
       end
 

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(*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