scout_apm 5.3.1 → 5.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d15e4a9b9e98af3e71ba6dde0b666b8807b742f967e35fe36ebd747ae83483
-  data.tar.gz: f8e88492777b44cdc9362500b7ccdcb68daaa756d6c98ec2e114e231e240071d
+  metadata.gz: 656e36a7b9a11b5870058c46b31e8227c628691f8ab7f7d4de991c3e89b5f13d
+  data.tar.gz: 5f27c0af5b3f864a96ea65944c6655106a86aa96dbf489083b1c3a178322d827
 SHA512:
-  metadata.gz: bb7224bc3294417f72279a97713b9be39bd9657efa1b9c39fb969164f353cdd04c8ced4114e6b717d7ed315c86b5412d8591132f3adde543fb09f8ea908e0308
-  data.tar.gz: 354cd7af52c07bb78380614d7aafdde9942a1b3ea973ad0616df187a2f2048b3a04fee9cff737d836c14caef142fec31aafef22e5ee4dfeb2125d31c6ea39f70
+  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
@@ -37,29 +37,31 @@ jobs:
           - ruby: 2.7
           - ruby: 2.7
             prepend: true
-          - ruby: 3.0
-          - ruby: 3.0
+          - ruby: "3.0"
+          - ruby: "3.0"
             prepend: true
-          - ruby: 3.0
+          - ruby: "3.0"
             gemfile: gems/instruments.gemfile
             test_features: "instruments"
-          - ruby: 3.0
+          - ruby: "3.0"
             gemfile: gems/instruments.gemfile
             prepend: true
             test_features: "instruments"
-          - ruby: 3.0
+          - 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,8 +1,25 @@
 # 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)

data/gems/sidekiq.gemfile

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

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)

data/lib/scout_apm/instruments/active_record.rb

@@ -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/net_http.rb

@@ -60,7 +60,7 @@ module ScoutApm
 
     module NetHttpInstrumentationPrepend
       def request(request, *args, &block)
-        self.class.instrument("HTTP", "request", :ignore_children => true, :desc => request_scout_description(args.first)) do
+        self.class.instrument("HTTP", "request", :ignore_children => true, :desc => request_scout_description(request)) do
           super(request, *args, &block)
         end
       end

data/lib/scout_apm/instruments/redis.rb

@@ -17,7 +17,7 @@ module ScoutApm
       end
 
       def install(prepend:)
-        if defined?(::Redis) && defined?(::Redis::Client)
+        if defined?(::Redis) && defined?(::Redis::Client) && ::Redis::Client.instance_methods(false).include?(:call)
           @installed = true
 
           logger.info "Instrumenting Redis. Prepend: #{prepend}"

data/lib/scout_apm/instruments/redis5.rb

@@ -0,0 +1,59 @@
+module ScoutApm
+    module Instruments
+      class Redis5
+        attr_reader :context
+  
+        def initialize(context)
+          @context = context
+          @installed = false
+        end
+  
+        def logger
+          context.logger
+        end
+  
+        def installed?
+          @installed
+        end
+  
+        def install(prepend:)
+          if defined?(::Redis) && defined?(::Redis::Client) && ::Redis::Client.instance_methods(false).include?(:call_v)
+            @installed = true
+  
+            logger.info "Instrumenting Redis5. Prepend: #{prepend}"
+  
+            if prepend
+              ::Redis::Client.send(:include, ScoutApm::Tracer)
+              ::Redis::Client.send(:prepend, Redis5ClientInstrumentationPrepend)
+            else
+              ::Redis::Client.class_eval do
+                include ScoutApm::Tracer
+  
+                def call_with_scout_instruments(args, &block)
+                  command = args.first rescue "Unknown"
+  
+                  self.class.instrument("Redis", command) do
+                    call_without_scout_instruments(args, &block)
+                  end
+                end
+  
+                alias_method :call_without_scout_instruments, :call_v
+                alias_method :call_v, :call_with_scout_instruments
+              end
+            end
+          end
+        end
+      end
+  
+      module Redis5ClientInstrumentationPrepend
+        def call(args, &block)
+          command = args.first rescue "Unknown"
+  
+          self.class.instrument("Redis", command) do
+            super(args, &block)
+          end
+        end
+      end
+    end
+  end
+  

data/lib/scout_apm/layer_converters/external_service_converter.rb

@@ -53,7 +53,7 @@ module ScoutApm
       rescue
         # Do nothing
       ensure
-        domain = DEFAULT_DOMAIN if domain.to_s.blank?
+        domain = DEFAULT_DOMAIN if (domain.nil? || domain.empty?)
         domain
       end
 

data/lib/scout_apm/server_integrations/puma.rb

@@ -23,8 +23,36 @@ module ScoutApm
         defined?(::Puma) && (File.basename($0) =~ /\Apuma/)
       end
 
+      # Puma::UserFileDefaultOptions exposes `options` based on three underlying
+      # hashes: user_options, file_options, and default_options. While getting an `options`
+      # key consults all three underlying hashes, setting an `options` key only sets the
+      # user_options hash:
+      #
+      #    def [](key)
+      #      fetch(key)
+      #    end
+      #
+      #    def []=(key, value)
+      #      user_options[key] = value
+      #    end
+      #
+      #    def fetch(key, default_value = nil)
+      #      return user_options[key]    if user_options.key?(key)
+      #      return file_options[key]    if file_options.key?(key)
+      #      return default_options[key] if default_options.key?(key)
+      #
+      #      default_value
+      #    end
+      #
+      # Because of this, we can't read options[:before_worker_boot], modify, and then re-set
+      # options[:before_worker_boot], since doing so could cause duplication if `before_worker_boot`
+      # exists on the other two underlying hashes (file_options, default_options).
+      #
+      # To get around this, we explicitly read from `user_options` only, and still set using `options[]=`,
+      # which Puma allows for setting `user_options`.
+      #
       def install
-        old = ::Puma.cli_config.options[:before_worker_boot] || []
+        old = ::Puma.cli_config.options.user_options[:before_worker_boot] || []
         new = Array(old) + [Proc.new do
           logger.info "Installing Puma worker loop."
           ScoutApm::Agent.instance.start_background_worker

data/lib/scout_apm/slow_request_policy.rb

@@ -14,7 +14,7 @@ module ScoutApm
 
     def add_default_policies
       add(SlowPolicy::SpeedPolicy.new(context))
-      add(SlowPolicy::PercentilePolicy.new(context))
+      add(SlowPolicy::PercentPolicy.new(context))
       add(SlowPolicy::AgePolicy.new(context))
       add(SlowPolicy::PercentilePolicy.new(context))
     end

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "5.3.1"
+  VERSION = "5.3.5"
 end

data/lib/scout_apm.rb

@@ -87,6 +87,7 @@ require 'scout_apm/instruments/moped'
 require 'scout_apm/instruments/mongoid'
 require 'scout_apm/instruments/memcached'
 require 'scout_apm/instruments/redis'
+require 'scout_apm/instruments/redis5'
 require 'scout_apm/instruments/influxdb'
 require 'scout_apm/instruments/elasticsearch'
 require 'scout_apm/instruments/active_record'

data/test/test_helper.rb

@@ -65,6 +65,32 @@ class FakeEnvironment
   end
 end
 
+def fake_rails(version)
+  Kernel.const_set("Rails", Module.new)
+  Kernel.const_set("ActionController", Module.new)
+  r = Kernel.const_get("Rails")
+  r.const_set("VERSION", Module.new)
+  v = r.const_get("VERSION")
+  v.const_set("MAJOR", version)
+
+  assert_equal version, Rails::VERSION::MAJOR
+end
+
+def clean_fake_rails
+  Kernel.send(:remove_const, "Rails") if defined?(Kernel::Rails)
+  Kernel.send(:remove_const, "ActionController") if defined?(Kernel::ActionController)
+end
+
+def fake_sinatra
+  Kernel.const_set("Sinatra", Module.new)
+  s = Kernel.const_get("Sinatra")
+  s.const_set("Base", Module.new)
+end
+
+def clean_fake_sinatra
+  Kernel.const_unset("Sinatra") if defined?(Kernel::Sinatra)
+end
+
 # Helpers available to all tests
 class Minitest::Test
   def setup

data/test/unit/environment_test.rb

@@ -29,32 +29,4 @@ class EnvironmentTest < Minitest::Test
   def test_framework_ruby
     assert_equal :ruby, ScoutApm::Environment.send(:new).framework
   end
-
-  ############################################################
-
-  def fake_rails(version)
-    Kernel.const_set("Rails", Module.new)
-    Kernel.const_set("ActionController", Module.new)
-    r = Kernel.const_get("Rails")
-    r.const_set("VERSION", Module.new)
-    v = r.const_get("VERSION")
-    v.const_set("MAJOR", version)
-
-    assert_equal version, Rails::VERSION::MAJOR
-  end
-
-  def clean_fake_rails
-    Kernel.send(:remove_const, "Rails") if defined?(Kernel::Rails)
-    Kernel.send(:remove_const, "ActionController") if defined?(Kernel::ActionController)
-  end
-
-  def fake_sinatra
-    Kernel.const_set("Sinatra", Module.new)
-    s = Kernel.const_get("Sinatra")
-    s.const_set("Base", Module.new)
-  end
-
-  def clean_fake_sinatra
-    Kernel.const_unset("Sinatra") if defined?(Kernel::Sinatra)
-  end
 end

data/test/unit/instruments/active_record_test.rb

@@ -24,6 +24,36 @@ class ActiveRecordTest < Minitest::Test
   class User < ActiveRecord::Base
   end
 
+  class DumbRailsConfig
+    def self.after_initialize; end
+  end
+
+  def test_old_rails_initialization
+    recorder = FakeRecorder.new
+    agent_context.recorder = recorder
+    old_rails_version = (1..2).to_a.sample
+    fake_rails(old_rails_version)
+
+    ::Rails.expects(:configuration).never
+
+    instrument = ScoutApm::Instruments::ActiveRecord.new(agent_context)
+    instrument.install(prepend: false)
+    clean_fake_rails
+  end
+
+  def test_modern_rails_initialization
+    recorder = FakeRecorder.new
+    agent_context.recorder = recorder
+    modern_rails_version = (3..7).to_a.sample
+    fake_rails(modern_rails_version)
+
+    ::Rails.expects(:configuration).returns(DumbRailsConfig).once
+
+    instrument = ScoutApm::Instruments::ActiveRecord.new(agent_context)
+    instrument.install(prepend: false)
+    clean_fake_rails
+  end
+
   def test_instrumentation
     recorder = FakeRecorder.new
     agent_context.recorder = recorder

data/test/unit/instruments/redis_test.rb

@@ -1,23 +1,23 @@
 if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
   require 'test_helper'
 
-  require 'scout_apm/instruments/redis'
+  require 'scout_apm/instruments/redis5'
 
   require 'redis'
 
   class RedisTest < Minitest::Test
     def setup
       @context = ScoutApm::AgentContext.new
-      @instance = ScoutApm::Instruments::Redis.new(@context)
+      @instance = ScoutApm::Instruments::Redis5.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)
+        assert ::Redis::Client.ancestors.include?(ScoutApm::Instruments::Redis5ClientInstrumentationPrepend)
       else
-        assert_equal false, ::Redis::Client.ancestors.include?(ScoutApm::Instruments::RedisClientInstrumentationPrepend)
+        assert_equal false, ::Redis::Client.ancestors.include?(ScoutApm::Instruments::Redis5ClientInstrumentationPrepend)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.3.1
+  version: 5.3.5
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-18 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -319,6 +319,7 @@ files:
 - lib/scout_apm/instruments/process/process_memory.rb
 - lib/scout_apm/instruments/rails_router.rb
 - lib/scout_apm/instruments/redis.rb
+- lib/scout_apm/instruments/redis5.rb
 - lib/scout_apm/instruments/resque.rb
 - lib/scout_apm/instruments/samplers.rb
 - lib/scout_apm/instruments/sinatra.rb
@@ -494,8 +495,72 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
 summary: Ruby application performance monitoring
-test_files: []
+test_files:
+- test/data/config_test_1.yml
+- test/test_helper.rb
+- 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
+- test/unit/background_job_integrations/sidekiq_test.rb
+- test/unit/config_test.rb
+- test/unit/context_test.rb
+- test/unit/db_query_metric_set_test.rb
+- test/unit/db_query_metric_stats_test.rb
+- test/unit/environment_test.rb
+- test/unit/error_service/error_buffer_test.rb
+- test/unit/error_service/ignored_exceptions_test.rb
+- test/unit/extensions/periodic_callbacks_test.rb
+- test/unit/extensions/transaction_callbacks_test.rb
+- test/unit/external_service_metric_set_test.rb
+- test/unit/external_service_metric_stats_test.rb
+- test/unit/fake_store_test.rb
+- test/unit/git_revision_test.rb
+- 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
+- test/unit/layer_converters/depth_first_walker_test.rb
+- test/unit/layer_converters/metric_converter_test.rb
+- test/unit/layer_converters/stubs.rb
+- test/unit/limited_layer_test.rb
+- test/unit/logger_test.rb
+- test/unit/metric_set_test.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
+- test/unit/slow_request_policy_test.rb
+- test/unit/sql_sanitizer_test.rb
+- test/unit/store_test.rb
+- test/unit/tracer_test.rb
+- test/unit/tracked_request_test.rb
+- test/unit/transaction_test.rb
+- test/unit/transaction_time_consumed_test.rb
+- test/unit/utils/active_record_metric_name_test.rb
+- test/unit/utils/backtrace_parser_test.rb
+- test/unit/utils/numbers_test.rb
+- test/unit/utils/scm.rb