scout_apm 5.3.1 → 5.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d15e4a9b9e98af3e71ba6dde0b666b8807b742f967e35fe36ebd747ae83483
-  data.tar.gz: f8e88492777b44cdc9362500b7ccdcb68daaa756d6c98ec2e114e231e240071d
+  metadata.gz: e1e83c44e949efe75ec1ee2c429b0596816c2b9f8e7c5416e7f3dd7243ef69c4
+  data.tar.gz: 9b8a870504f4b32729ddb85f999cf7af30f6aac4215d356caefda6db2349dfb8
 SHA512:
-  metadata.gz: bb7224bc3294417f72279a97713b9be39bd9657efa1b9c39fb969164f353cdd04c8ced4114e6b717d7ed315c86b5412d8591132f3adde543fb09f8ea908e0308
-  data.tar.gz: 354cd7af52c07bb78380614d7aafdde9942a1b3ea973ad0616df187a2f2048b3a04fee9cff737d836c14caef142fec31aafef22e5ee4dfeb2125d31c6ea39f70
+  metadata.gz: ac045625ade6b059933ce82b1eaa014be50ce2eea7db34fb1e8a1f94145810c814bb95ba4cb8b70858547a3aaddebc812c8b3986e753f2f2304a7ae477a70974
+  data.tar.gz: 19c81bacc7df78bbae4b6c9a03007a4ce84ce6c2de230e0e0e6b937e7b8ef4885788f70b36bebcd9cc192ae3aba3b0a7899830cf5ce20182fb95d19a4d2d1843

data/CHANGELOG.markdown

@@ -1,8 +1,16 @@
 # Unreleased
 
+# 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/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/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/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "5.3.1"
+  VERSION = "5.3.3"
 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/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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.3.1
+  version: 5.3.3
 platform: ruby
 authors:
 - Derek Haynes
 - Andre Lewis
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-18 00:00:00.000000000 Z
+date: 2022-12-09 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
@@ -478,7 +479,7 @@ homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -494,8 +495,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
 test_files: []