scout_apm 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e125a347fd3bbfa0b52f6dde597daf1dc95d97ba95cb6c44553bc36fae71b82
-  data.tar.gz: 9f0c708e386be527f255582195a791938c1663b418999816b79f25e4f7caaf6f
+  metadata.gz: b3dfd72cdc46892ac46a974e4e3947f81ac2ee6580bee96c0cc6ad845ce50ee7
+  data.tar.gz: 560fb31452b8c5b526bf77723d121d561096c759640c0266ba894ffe71901d99
 SHA512:
-  metadata.gz: d7e079bde40861cf673834ec606f8a09fc84bd4416eddccd22abd29d5cd64dbf071347d832549f840dd3b07026c8a3d4e6788f458587128482a1b44682479ec4
-  data.tar.gz: e20c7d5fadbfe008f1febb62e3e31e5aa23cc4410f02634329493b10159603fb467e4ae66d504709f247ff457b0bf5d386f62baa0835010e7e5a0954160f7b97
+  metadata.gz: 3958265f12804e22dbb4c75d3b03a6d4ad9f87ff989e5382f8d0b890d55c2c2505828cd4022fa7a965092bb7c0948a12baea760b0d15fd05f5ceef6d1a23f962
+  data.tar.gz: cb45c1255f16f299e7a8cc67c93efd21fd7912682c4d4ed2030498be069022f2cf8811a987bbec0c22ff28150d57ff95222ed0771e0c2758bbba057b1805d4a8

data/.github/workflows/test.yml

@@ -19,13 +19,6 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - ruby: 2.1
-            gemfile: gems/rails3.gemfile
-          - ruby: 2.2
-          - ruby: 2.3
-            gemfile: gems/sqlite3-1.3.gemfile
-          - ruby: 2.4
-            gemfile: gems/sqlite3-1.3.gemfile
           - ruby: 2.5
           - ruby: 2.6
           - ruby: 2.6
@@ -51,13 +44,15 @@ jobs:
             test_features: "sidekiq_install"
           - ruby: 3.1
           - ruby: 3.2
+            gemfile: gems/sqlite3-v2.gemfile
+          - ruby: 3.3
+            gemfile: gems/sqlite3-v2.gemfile
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
       SCOUT_TEST_FEATURES: ${{ matrix.test_features }}
       SCOUT_USE_PREPEND: ${{ matrix.prepend }}
 
-    # https://github.com/ruby/setup-ruby/issues/496
-    runs-on: ${{ matrix.ruby == '2.2' && 'ubuntu-20.04' || 'ubuntu-latest' }}
+    runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4

data/CHANGELOG.markdown

@@ -1,5 +1,10 @@
 # Unreleased
 
+# 5.5.0
+- Fix undeclared logger in grape instruments (#510)
+- Drop guaranteed support for Rubies <= 2.4
+- Instrument Resque without relying on forking per job (#514)
+
 # 5.4.0
 * Add support for GoodJob (#506)
 * Add support for Solid Queue (#508)
@@ -668,7 +673,7 @@ reusing that version number to avoid confusion.
 
 # 1.2.12
 
-* Add uri_reporting option to report bare path (as opposed to fullpath). Default is 'fullpath'; set to 'path' to avoid exposing URL parameters.  
+* Add uri_reporting option to report bare path (as opposed to fullpath). Default is 'fullpath'; set to 'path' to avoid exposing URL parameters.
 
 # 1.2.11
 

data/gems/{sqlite3-1.3.gemfile → sqlite3-v2.gemfile}

@@ -1,3 +1,3 @@
 eval_gemfile("../Gemfile")
 
-gem "sqlite3", "~> 1.3.5"
+gem "sqlite3", ">= 2.1"

data/lib/scout_apm/agent.rb

@@ -208,7 +208,7 @@ module ScoutApm
 
       @error_service_background_worker = ScoutApm::BackgroundWorker.new(context, ERROR_SEND_FREQUENCY)
       @error_service_background_worker_thread = Thread.new do
-        @error_service_background_worker.start { 
+        @error_service_background_worker.start {
           periodic_work.run
         }
       end

data/lib/scout_apm/background_job_integrations/resque.rb

@@ -7,8 +7,7 @@ module ScoutApm
 
       def present?
         defined?(::Resque) &&
-          ::Resque.respond_to?(:before_first_fork) &&
-          ::Resque.respond_to?(:after_fork)
+          ::Resque.respond_to?(:before_first_fork)
       end
 
       # Lies. This forks really aggressively, but we have to do handling
@@ -19,13 +18,14 @@ module ScoutApm
       end
 
       def install
-        install_before_fork
-        install_after_fork
+        install_before_first_fork
+        install_instruments
       end
 
-      def install_before_fork
+      def install_before_first_fork
         ::Resque.before_first_fork do
           begin
+            # Don't check fork_per_job here in case some workers fork_per_job and some don't.
             if ScoutApm::Agent.instance.context.config.value('start_resque_server_instrument')
               ScoutApm::Agent.instance.start
               ScoutApm::Agent.instance.context.start_remote_server!(bind, port)
@@ -33,31 +33,14 @@ module ScoutApm
               logger.info("Not starting remote server due to 'start_resque_server_instrument' setting")
             end
           rescue Errno::EADDRINUSE
-            ScoutApm::Agent.instance.context.logger.warn "Error while Installing Resque Instruments, Port #{port} already in use. Set via the `remote_agent_port` configuration option"
+            logger.warn "Error while Installing Resque Instruments, Port #{port} already in use. Set via the `remote_agent_port` configuration option"
           rescue => e
-            ScoutApm::Agent.instance.context.logger.warn "Error while Installing Resque before_first_fork: #{e.inspect}"
+            logger.warn "Error while Installing Resque before_first_fork: #{e.inspect}"
           end
         end
       end
 
-      def install_after_fork
-        ::Resque.after_fork do
-          begin
-            ScoutApm::Agent.instance.context.become_remote_client!(bind, port)
-            inject_job_instrument
-          rescue => e
-            ScoutApm::Agent.instance.context.logger.warn "Error while Installing Resque after_fork: #{e.inspect}"
-          end
-        end
-      end
-
-      # Insert ourselves into the point when resque turns a string "TestJob"
-      # into the class constant TestJob, and insert our instrumentation plugin
-      # into that constantized class
-      #
-      # This automates away any need for the user to insert our instrumentation into
-      # each of their jobs
-      def inject_job_instrument
+      def install_instruments
         ::Resque::Job.class_eval do
           def payload_class_with_scout_instruments
             klass = payload_class_without_scout_instruments
@@ -80,9 +63,12 @@ module ScoutApm
       end
 
       def config
-        @config || ScoutApm::Agent.instance.context.config
+        @config ||= ScoutApm::Agent.instance.context.config
+      end
+
+      def logger
+        @logger ||= ScoutApm::Agent.instance.context.logger
       end
     end
   end
 end
-

data/lib/scout_apm/instruments/grape.rb

@@ -53,7 +53,7 @@ module ScoutApm
                   self.options[:path].first,
           ].compact.map{ |n| n.to_s }.join("/")
         rescue => e
-          logger.info("Error getting Grape Endpoint Name. Error: #{e.message}. Options: #{self.options.inspect}")
+          ScoutApm::Agent.instance.context.logger.info("Error getting Grape Endpoint Name. Error: #{e.message}. Options: #{self.options.inspect}")
           name = "Grape/Unknown"
         end
 

data/lib/scout_apm/instruments/resque.rb

@@ -1,6 +1,15 @@
 module ScoutApm
   module Instruments
     module Resque
+      def before_perform_become_client(*args)
+        # Don't become remote client if explicitly disabled or if forking is disabled to force synchronous recording.
+        if config.value('start_resque_server_instrument') && forking?
+          ScoutApm::Agent.instance.context.become_remote_client!(bind, port)
+        else
+          logger.debug("Not becoming remote client due to 'start_resque_server_instrument' setting or 'fork_per_job' setting")
+        end
+      end
+
       def around_perform_with_scout_instruments(*args)
         job_name = self.to_s
         queue = find_queue
@@ -17,7 +26,6 @@ module ScoutApm
           started_queue = true
           req.start_layer(ScoutApm::Layer.new('Job', job_name))
           started_job = true
-
           yield
         rescue => e
           req.error!
@@ -33,7 +41,28 @@ module ScoutApm
         return queue if self.respond_to?(:queue)
         return "unknown"
       end
+
+      private
+
+      def bind
+        config.value("remote_agent_host")
+      end
+
+      def port
+        config.value("remote_agent_port")
+      end
+
+      def config
+        @config ||= ScoutApm::Agent.instance.context.config
+      end
+
+      def logger
+        @logger ||= ScoutApm::Agent.instance.context.logger
+      end
+
+      def forking?
+        @forking ||= ENV["FORK_PER_JOB"] != "false"
+      end
     end
   end
 end
-

data/lib/scout_apm/utils/installed_gems.rb

@@ -12,7 +12,8 @@ module ScoutApm
       end
 
       def run
-        Bundler.rubygems.all_specs.map {|spec| [spec.name, spec.version.to_s] }
+        specs = Bundler.rubygems.public_send(Bundler.rubygems.respond_to?(:installed_specs) ? :installed_specs : :all_specs)
+        specs.map { |spec| [spec.name, spec.version.to_s] }
       rescue => e
         logger.warn("Couldn't fetch Gem information: #{e.message}")
         []

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "5.4.0"
+  VERSION = "5.5.0"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Derek Haynes
 - Andre Lewis
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2025-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -240,7 +239,7 @@ files:
 - gems/rails5.gemfile
 - gems/rails6.gemfile
 - gems/sidekiq.gemfile
-- gems/sqlite3-1.3.gemfile
+- gems/sqlite3-v2.gemfile
 - gems/typhoeus.gemfile
 - lib/scout_apm.rb
 - lib/scout_apm/agent.rb
@@ -489,7 +488,6 @@ homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -505,8 +503,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby application performance monitoring
 test_files: []