scout_apm 5.3.8 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eb7dc8091eba4caa3dfb078b44636de67c94abc26646c05c14339e77ba0b58a
-  data.tar.gz: 7e7a596d825cf2c648470f6e867ea2c5cc3eb9112b813b4b4ca4dcf873a2b98c
+  metadata.gz: b3dfd72cdc46892ac46a974e4e3947f81ac2ee6580bee96c0cc6ad845ce50ee7
+  data.tar.gz: 560fb31452b8c5b526bf77723d121d561096c759640c0266ba894ffe71901d99
 SHA512:
-  metadata.gz: 9964722b976e23fc9a629cdb010079f4781e10764226bb8eeb9d6da4439612d20fe21c9fa13f8e1a7fbe8db268ff15005599d102893ee5ed44388ef686874b44
-  data.tar.gz: 1b9a9a0847c9f688fe34068cd68e0cd9d4bcac0e70eb3a59c507a2671d03aa2ac30bb7a8a1eea9f1df6d9ec5e4a4a713046707fe60702ff06b353df634e5cce2
+  metadata.gz: 3958265f12804e22dbb4c75d3b03a6d4ad9f87ff989e5382f8d0b890d55c2c2505828cd4022fa7a965092bb7c0948a12baea760b0d15fd05f5ceef6d1a23f962
+  data.tar.gz: cb45c1255f16f299e7a8cc67c93efd21fd7912682c4d4ed2030498be069022f2cf8811a987bbec0c22ff28150d57ff95222ed0771e0c2758bbba057b1805d4a8

data/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release Gem
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+# Directly from https://github.com/rubygems/release-gem/tree/v1
+# Predicated on Tag Ruleset preventing arbitrary tag creation and
+# requiring checks to pass for commit before tag creation
+jobs:
+  push:
+    name: Push gem to RubyGems.org
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: write # IMPORTANT: this permission is required for `rake release` to push the release tag
+
+    steps:
+      # Set up
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@v1

data/.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
@@ -19,11 +19,6 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - ruby: 2.1
-            gemfile: gems/rails3.gemfile
-          - ruby: 2.2
-          - ruby: 2.3
-          - ruby: 2.4
           - ruby: 2.5
           - ruby: 2.6
           - ruby: 2.6
@@ -31,9 +26,6 @@ jobs:
             test_features: "typhoeus"
           - ruby: 2.6
             gemfile: gems/octoshark.gemfile
-          - ruby: 2.6
-            gemfile: gems/rails3.gemfile
-            bundler: 1.17.3
           - ruby: 2.7
           - ruby: 2.7
             prepend: true
@@ -52,16 +44,18 @@ 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@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true

data/CHANGELOG.markdown

@@ -1,5 +1,14 @@
 # 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)
+
 # 5.3.8
 * Avoid inaccurate websocket queue time capturing (#494)
 
@@ -664,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-v2.gemfile

@@ -0,0 +1,3 @@
+eval_gemfile("../Gemfile")
+
+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/good_job.rb

@@ -0,0 +1,49 @@
+module ScoutApm
+  module BackgroundJobIntegrations
+    class GoodJob
+      UNKNOWN_QUEUE_PLACEHOLDER = 'default'.freeze
+      attr_reader :logger
+
+      def name
+        :good_job
+      end
+
+      def present?
+        defined?(::GoodJob::VERSION)
+      end
+
+      def forking?
+        false
+      end
+
+      def install
+        ActiveSupport.on_load(:active_job) do
+          include ScoutApm::Tracer
+
+          around_perform do |job, block|
+            # I have a sneaking suspicion there is a better way to handle Agent starting
+            # Maybe hook into GoodJob lifecycle events?
+            req = ScoutApm::RequestManager.lookup
+            latency = Time.now - (job.scheduled_at || job.enqueued_at) rescue 0
+            req.annotate_request(queue_latency: latency)
+
+            begin
+              req.start_layer ScoutApm::Layer.new("Queue", job.queue_name.presence || UNKNOWN_QUEUE_PLACEHOLDER)
+              started_queue = true # Following Convention
+              req.start_layer ScoutApm::Layer.new("Job", job.class.name)
+              started_job = true # Following Convention
+
+              block.call
+            rescue
+              req.error!
+              raise
+            ensure
+              req.stop_layer if started_job
+              req.stop_layer if started_queue
+            end
+          end
+        end
+      end
+    end
+  end
+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/background_job_integrations/solid_queue.rb

@@ -0,0 +1,47 @@
+module ScoutApm
+  module BackgroundJobIntegrations
+    class SolidQueue
+      UNKNOWN_QUEUE_PLACEHOLDER = 'default'.freeze
+      attr_reader :logger
+
+      def name
+        :solid_queue
+      end
+
+      def present?
+        defined?(::SolidQueue::VERSION)
+      end
+
+      def forking?
+        false
+      end
+
+      def install
+        ActiveSupport.on_load(:active_job) do
+          include ScoutApm::Tracer
+
+          around_perform do |job, block|
+            req = ScoutApm::RequestManager.lookup
+            latency = Time.now - (job.scheduled_at || job.enqueued_at) rescue 0
+            req.annotate_request(queue_latency: latency)
+
+            begin
+              req.start_layer ScoutApm::Layer.new("Queue", job.queue_name.presence || UNKNOWN_QUEUE_PLACEHOLDER)
+              started_queue = true # Following Convention
+              req.start_layer ScoutApm::Layer.new("Job", job.class.name)
+              started_job = true # Following Convention
+
+              block.call
+            rescue
+              req.error!
+              raise
+            ensure
+              req.stop_layer if started_job
+              req.stop_layer if started_queue
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/environment.rb

@@ -31,6 +31,8 @@ module ScoutApm
       ScoutApm::BackgroundJobIntegrations::DelayedJob.new,
       ScoutApm::BackgroundJobIntegrations::Que.new,
       ScoutApm::BackgroundJobIntegrations::Faktory.new,
+      ScoutApm::BackgroundJobIntegrations::GoodJob.new,
+      ScoutApm::BackgroundJobIntegrations::SolidQueue.new,
     ]
 
     FRAMEWORK_INTEGRATIONS = [

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.3.8"
+  VERSION = "5.5.0"
 end

data/lib/scout_apm.rb

@@ -67,6 +67,8 @@ require 'scout_apm/background_job_integrations/shoryuken'
 require 'scout_apm/background_job_integrations/sneakers'
 require 'scout_apm/background_job_integrations/que'
 require 'scout_apm/background_job_integrations/legacy_sneakers'
+require 'scout_apm/background_job_integrations/good_job'
+require 'scout_apm/background_job_integrations/solid_queue'
 
 require 'scout_apm/framework_integrations/rails_2'
 require 'scout_apm/framework_integrations/rails_3_or_4'

data/scout_apm.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   # tests. Specific versions are pulled in using specific gemfiles, e.g.
   # `gems/rails3.gemfile`.
   s.add_development_dependency "activerecord"
-  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "sqlite3",  "~> 1.4"
 
   s.add_development_dependency "rubocop"
   s.add_development_dependency "guard"

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.3.8
+  version: 5.5.0
 platform: ruby
 authors:
 - Derek Haynes
 - Andre Lewis
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-03 00:00:00.000000000 Z
+date: 2025-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -141,16 +140,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +215,7 @@ extensions:
 - ext/rusage/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -239,6 +239,7 @@ files:
 - gems/rails5.gemfile
 - gems/rails6.gemfile
 - gems/sidekiq.gemfile
+- gems/sqlite3-v2.gemfile
 - gems/typhoeus.gemfile
 - lib/scout_apm.rb
 - lib/scout_apm/agent.rb
@@ -254,12 +255,14 @@ files:
 - lib/scout_apm/auto_instrument/rails.rb
 - lib/scout_apm/background_job_integrations/delayed_job.rb
 - lib/scout_apm/background_job_integrations/faktory.rb
+- lib/scout_apm/background_job_integrations/good_job.rb
 - lib/scout_apm/background_job_integrations/legacy_sneakers.rb
 - lib/scout_apm/background_job_integrations/que.rb
 - lib/scout_apm/background_job_integrations/resque.rb
 - lib/scout_apm/background_job_integrations/shoryuken.rb
 - lib/scout_apm/background_job_integrations/sidekiq.rb
 - lib/scout_apm/background_job_integrations/sneakers.rb
+- lib/scout_apm/background_job_integrations/solid_queue.rb
 - lib/scout_apm/background_recorder.rb
 - lib/scout_apm/background_worker.rb
 - lib/scout_apm/bucket_name_splitter.rb
@@ -485,7 +488,6 @@ homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -501,78 +503,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby application performance monitoring
-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/hash_shorthand_controller-instrumented.rb
-- test/unit/auto_instrument/hash_shorthand_controller.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/action_view_test.rb
-- test/unit/instruments/active_record_test.rb
-- test/unit/instruments/fixtures/test/_test_partial.html.erb
-- test/unit/instruments/fixtures/test/_test_partial_collection.html.erb
-- test/unit/instruments/fixtures/test_view.html.erb
-- 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
+test_files: []