scout_apm 5.4.0 → 5.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e125a347fd3bbfa0b52f6dde597daf1dc95d97ba95cb6c44553bc36fae71b82
-  data.tar.gz: 9f0c708e386be527f255582195a791938c1663b418999816b79f25e4f7caaf6f
+  metadata.gz: 9c929de92cd0a3b2690bac6ef665c8c4d7187dd3ecc838cc881033d8cf5c413c
+  data.tar.gz: 3148b06815beb3e506e271bb560fb700b5882d503c1a94f646011117ee424d9b
 SHA512:
-  metadata.gz: d7e079bde40861cf673834ec606f8a09fc84bd4416eddccd22abd29d5cd64dbf071347d832549f840dd3b07026c8a3d4e6788f458587128482a1b44682479ec4
-  data.tar.gz: e20c7d5fadbfe008f1febb62e3e31e5aa23cc4410f02634329493b10159603fb467e4ae66d504709f247ff457b0bf5d386f62baa0835010e7e5a0954160f7b97
+  metadata.gz: 28afece432426708eb8ce9bdb527dddd2820261574ca299887ba1294ecc98b34663c04dc15c9cf0ffb78f5211abb9b8d78ba6e202c7a6d28867edda65727b902
+  data.tar.gz: 3e81497fa32092e4f037d272ee1a76f555bd9a557c9855a304e96acc93cdedaf24e0a4b21d86e895dddb1db569ec35954cbff30340f8e9803b7d799b28866522

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
@@ -49,15 +42,23 @@ jobs:
           - ruby: "3.0"
             gemfile: gems/sidekiq.gemfile
             test_features: "sidekiq_install"
+          - ruby: "3.0"
+            gemfile: gems/sidekiq7.gemfile
+            test_features: "sidekiq_install"
+          - ruby: "3.3"
+            gemfile: gems/sidekiq8.gemfile
+            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,31 @@
 # Unreleased
 
+# 5.6.4
+- Use new ActiveJob class name and timestamp units for Sidekiq 8+ (#544)
+
+# 5.6.2
+- Fix deprecation warning for Sidekiq 7.1.5+ (#535)
+- Add support for Mongoid 8 and 9. Remove support for old versions. (#538)
+- Detect deployed SHA from Kamal (#528)
+
+# 5.6.1
+- Fix `job_sample_rate` and `endpoint_sample_rate` default configuration values (#529)
+
+# 5.6.0
+- New options for sampling and ignore configuration (#521)
+  - `sample_rate` - Set the rate at which requests are sampled globally (1-100, a percentage of requests to keep).
+  - `ignore_endpoints` - Ignore endpoints by regex matching prefix (Same as and replaces `ignore`)
+  - `sample_endpoints` - Sample endpoints by regex matching prefix (i.e. ['/foo:70']).
+  - `endpoint_sample_rate` - Set the rate at which all non-matching web requests are sampled.
+  - `ignore_jobs` - Ignore Jobs by explicit name match.
+  - `sample_jobs` - Sample Jobs by explicit name match (i.e. ['MyJob:70']).
+  - `job_sample_rate` - Set the rate at which all non-matching background jobs are sampled.
+
+# 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 +694,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/rails7.gemfile

@@ -0,0 +1,4 @@
+eval_gemfile("../Gemfile")
+
+gem "rails", "~> 7.0"
+gem "sqlite3", "~> 1.4"

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

@@ -1,3 +1,3 @@
 eval_gemfile("../Gemfile")
 
-gem "sqlite3", "~> 1.3.5"
+gem 'sidekiq', '~> 7.0'

data/gems/sidekiq8.gemfile

@@ -0,0 +1,4 @@
+eval_gemfile("../Gemfile")
+
+gem 'sqlite3', '~> 2.0'
+gem 'sidekiq', '~> 8.0'

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/agent_context.rb

@@ -91,6 +91,10 @@ module ScoutApm
       @logger ||= LoggerFactory.build(config, environment)
     end
 
+    def sampling
+      @sampling ||= ScoutApm::Sampling.new(config)
+    end
+
     def ignored_uris
       @ignored_uris ||= ScoutApm::IgnoredUris.new(config.value('ignore'))
     end

data/lib/scout_apm/auto_instrument/layer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ScoutApm
   def self.AutoInstrument(name, backtrace)

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/sidekiq.rb

@@ -69,8 +69,21 @@ module ScoutApm
         end
       end
 
+      def self.sidekiq_version_8?
+        if defined?(::Sidekiq::VERSION)
+          ::Sidekiq::VERSION.to_i >= 8
+        else
+          false
+        end
+      end
+
       UNKNOWN_CLASS_PLACEHOLDER = 'UnknownJob'.freeze
-      ACTIVE_JOB_KLASS = 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper'.freeze
+      # This name was changed in Sidekiq 8
+      ACTIVE_JOB_KLASS = if sidekiq_version_8?
+                          'Sidekiq::ActiveJob::Wrapper'.freeze
+                        else
+                          'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper'.freeze
+                        end
       DELAYED_WRAPPER_KLASS = 'Sidekiq::Extensions::DelayedClass'.freeze
 
 
@@ -119,7 +132,14 @@ module ScoutApm
       def latency(msg, time = Time.now.to_f)
         created_at = msg['enqueued_at'] || msg['created_at']
         if created_at
-          (time - created_at)
+          # Sidekiq 8+ uses milliseconds, older versions use seconds.
+          # Do it this way because downstream expects seconds.
+          if self.class.sidekiq_version_8?
+            # Convert milliseconds to seconds for consistency.
+            (time - (created_at.to_f / 1000.0))
+          else
+            (time - created_at)
+          end
         else
           0
         end

data/lib/scout_apm/config.rb

@@ -42,6 +42,13 @@ require 'scout_apm/environment'
 #                            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: []
+# ignore_endpoints         - An array of endpoints to ignore. These are matched as regular expressions. (supercedes 'ignore')
+# ignore_jobs              - An array of job names to ignore.
+# sample_rate              - Rate to sample entire application. An integer between 0 and 100. 0 means no traces are sent, 100 means all traces are sent.
+# sample_endpoints         - An array of endpoints to sample. These are matched as regular expressions with individual sample rate of 0 to 100.
+# sample_jobs              - An array of job names with individual sample rate of 0 to 100.
+# endpoint_sample_rate     - Rate to sample all endpoints. An integer between 0 and 100. 0 means no traces are sent, 100 means all traces are sent. (supercedes 'sample_rate')
+# job_sample_rate          - Rate to sample all jobs. An integer between 0 and 100. 0 means no traces are sent, 100 means all traces are sent. (supercedes 'sample_rate')
 #
 # Any of these config settings can be set with an environment variable prefixed
 # by SCOUT_ and uppercasing the key: SCOUT_LOG_LEVEL for instance.
@@ -67,6 +74,8 @@ module ScoutApm
         'host',
         'hostname',
         'ignore',
+        'ignore_endpoints',
+        'ignore_jobs',
         'key',
         'log_class',
         'log_file_path',
@@ -83,6 +92,11 @@ module ScoutApm
         'remote_agent_port',
         'report_format',
         'revision_sha',
+        'sample_rate',
+        'sample_endpoints',
+        'sample_jobs',
+        'endpoint_sample_rate',
+        'job_sample_rate',
         'scm_subdirectory',
         'start_resque_server_instrument',
         'ssl_cert_file',
@@ -170,6 +184,13 @@ module ScoutApm
       end
     end
 
+    class NullableIntegerCoercion
+      def coerce(val)
+        return val if val.nil?
+        val.to_i
+      end
+    end
+
     # Simply returns the passed in value, without change
     class NullCoercion
       def coerce(val)
@@ -184,6 +205,8 @@ module ScoutApm
       'dev_trace' => BooleanCoercion.new,
       'enable_background_jobs' => BooleanCoercion.new,
       'ignore' => JsonCoercion.new,
+      'ignore_endpoints' => JsonCoercion.new,
+      'ignore_jobs' => JsonCoercion.new,
       'max_traces' => IntegerCoercion.new,
       'monitor' => BooleanCoercion.new,
       'collect_remote_ip' => BooleanCoercion.new,
@@ -194,6 +217,11 @@ module ScoutApm
       'external_service_metric_report_limit' => IntegerCoercion.new,
       'instrument_http_url_length' => IntegerCoercion.new,
       'record_queue_time' => BooleanCoercion.new,
+      'sample_rate' => IntegerCoercion.new,
+      'sample_endpoints' => JsonCoercion.new,
+      'sample_jobs' => JsonCoercion.new,
+      'endpoint_sample_rate' => NullableIntegerCoercion.new,
+      'job_sample_rate' => NullableIntegerCoercion.new,
       'start_resque_server_instrument' => BooleanCoercion.new,
       'timeline_traces' => BooleanCoercion.new,
       'auto_instruments' => BooleanCoercion.new,
@@ -290,41 +318,48 @@ module ScoutApm
 
     class ConfigDefaults
       DEFAULTS = {
-        'compress_payload'       => true,
-        'detailed_middleware'    => false,
-        'dev_trace'              => false,
-        'direct_host'            => 'https://apm.scoutapp.com',
-        'disabled_instruments'   => [],
-        'enable_background_jobs' => true,
-        'host'                   => 'https://checkin.scoutapp.com',
-        'ignore'                 => [],
-        'log_level'              => 'info',
-        'max_traces'             => 10,
-        'profile'                => true, # for scoutprof
-        'report_format'          => 'json',
-        'scm_subdirectory'       => '',
-        'uri_reporting'          => 'full_path',
-        'remote_agent_host'      => '127.0.0.1',
-        'remote_agent_port'      => 7721, # picked at random
-        'database_metric_limit'  => 5000, # The hard limit on db metrics
-        'database_metric_report_limit' => 1000,
-        'external_service_metric_limit'  => 5000, # The hard limit on external service metrics
+        'compress_payload'                     => true,
+        'detailed_middleware'                  => false,
+        'dev_trace'                            => false,
+        'direct_host'                          => 'https://apm.scoutapp.com',
+        'disabled_instruments'                 => [],
+        'enable_background_jobs'               => true,
+        'host'                                 => 'https://checkin.scoutapp.com',
+        'ignore'                               => [],
+        'ignore_endpoints'                     => [],
+        'ignore_jobs'                          => [],
+        'log_level'                            => 'info',
+        'max_traces'                           => 10,
+        'profile'                              => true, # for scoutprof
+        'report_format'                        => 'json',
+        'scm_subdirectory'                     => '',
+        'uri_reporting'                        => 'full_path',
+        'remote_agent_host'                    => '127.0.0.1',
+        'remote_agent_port'                    => 7721, # picked at random
+        'database_metric_limit'                => 5000, # The hard limit on db metrics
+        'database_metric_report_limit'         => 1000,
+        'external_service_metric_limit'        => 5000, # The hard limit on external service metrics
         'external_service_metric_report_limit' => 1000,
-        'instrument_http_url_length' => 300,
-        'start_resque_server_instrument' => true, # still only starts if Resque is detected
-        'collect_remote_ip' => true,
-        'record_queue_time' => true,
-        '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),
-        'errors_filtered_params' => %w(password s3-key),
-        'errors_host' => 'https://errors.scoutapm.com',
+        'instrument_http_url_length'           => 300,
+        'sample_rate'                          => 100,
+        'sample_endpoints'                     => [],
+        'sample_jobs'                          => [],
+        'endpoint_sample_rate'                 => nil,
+        'job_sample_rate'                      => nil,
+        'start_resque_server_instrument'       => true, # still only starts if Resque is detected
+        'collect_remote_ip'                    => true,
+        'record_queue_time'                    => true,
+        '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),
+        'errors_filtered_params'               => %w(password s3-key),
+        'errors_host'                          => 'https://errors.scoutapm.com',
       }.freeze
 
       def value(key)

data/lib/scout_apm/error_service/sidekiq.rb

@@ -28,7 +28,7 @@ module ScoutApm
 
       def install_sidekiq_with_error_handler
         ::Sidekiq.configure_server do |config|
-          config.error_handlers << proc { |exception, job_info|
+          config.error_handlers << proc { |exception, job_info, sidekiq_config|
             context = ScoutApm::Agent.instance.context
 
             # Bail out early, and reraise if the error is not interesting.

data/lib/scout_apm/git_revision.rb

@@ -20,6 +20,7 @@ module ScoutApm
       detect_from_config     ||
       detect_from_heroku     ||
       detect_from_capistrano ||
+      detect_from_kamal ||
       detect_from_mina ||
       detect_from_git
     end
@@ -44,8 +45,13 @@ module ScoutApm
       nil
     end
 
+    # https://github.com/basecamp/kamal
+    def detect_from_kamal
+      ENV['KAMAL_VERSION']
+    end
+
     # https://github.com/mina-deploy/mina
-    def detect_from_mina 
+    def detect_from_mina
       File.read(File.join(app_root, '.mina_git_revision')).strip
     rescue
       logger.debug "Unable to detect Git Revision from Mina: #{$!.message}"

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/mongoid.rb

@@ -20,25 +20,12 @@ module ScoutApm
         @installed = true
 
         # Mongoid versions that use Moped should instrument Moped.
+        ### See moped instrument for Moped driven deploys
         if defined?(::Mongoid) and !defined?(::Moped)
-          logger.info "Instrumenting Mongoid 2.x"
           @installed = true
 
-          ### OLD (2.x) mongoids
-          if defined?(::Mongoid::Collection)
-            ::Mongoid::Collection.class_eval do
-              include ScoutApm::Tracer
-              (::Mongoid::Collections::Operations::ALL - [:<<, :[]]).each do |method|
-                instrument_method method, :type => "MongoDB", :name => '#{@klass}/' + method.to_s
-              end
-            end
-          end
-
-          ### See moped instrument for Moped driven deploys
-
-          ### 5.x Mongoid
-          if (mongoid_v5? || mongoid_v6? || mongoid_v7?) && defined?(::Mongoid::Contextual::Mongo)
-            logger.info "Instrumenting Mongoid 5.x/6.x/7.x"
+          if (mongoid_at_least_5?) && defined?(::Mongoid::Contextual::Mongo)
+            logger.info "Instrumenting Mongoid"
             # All the public methods from Mongoid::Contextual::Mongo.
             # TODO: Geo and MapReduce support (?). They are in other Contextual::* classes
             methods = [
@@ -88,31 +75,17 @@ module ScoutApm
                 ]
 
                 ::Mongoid::Contextual::Mongo.class_eval(with_scout_instruments)
+              else
+                logger.warn "Expected method #{method} not defined in Mongoid::Contextual::Mongo."
               end
             end
           end
         end
       end
 
-      def mongoid_v5?
-        if defined?(::Mongoid::VERSION)
-          ::Mongoid::VERSION =~ /\A5/
-        else
-          false
-        end
-      end
-
-      def mongoid_v6?
+      def mongoid_at_least_5?
         if defined?(::Mongoid::VERSION)
-          ::Mongoid::VERSION =~ /\A6/
-        else
-          false
-        end
-      end
-
-      def mongoid_v7?
-        if defined?(::Mongoid::VERSION)
-          ::Mongoid::VERSION =~ /\A7/
+          ::Mongoid::VERSION =~ /\A[56789]/
         else
           false
         end
@@ -134,4 +107,3 @@ module ScoutApm
     end
   end
 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/sampling.rb

@@ -0,0 +1,104 @@
+module ScoutApm
+  class Sampling
+    attr_reader :global_sample_rate, :sample_endpoints, :sample_uri_regex, :sample_jobs, :ignore_uri_regex, :ignore_jobs
+
+    def initialize(config)
+      @global_sample_rate = config.value('sample_rate')
+      # web endpoints matched prefix by regex
+      # jobs matched explicitly by name
+
+      # for now still support old config key ('ignore') for backwards compatibility
+      @ignore_endpoints = config.value('ignore').present? ? config.value('ignore') : config.value('ignore_endpoints')
+      @sample_endpoints = individual_sample_to_hash(config.value('sample_endpoints'))
+      @endpoint_sample_rate = config.value('endpoint_sample_rate')
+
+      @ignore_jobs = config.value('ignore_jobs')
+      @sample_jobs = individual_sample_to_hash(config.value('sample_jobs'))
+      @job_sample_rate = config.value('job_sample_rate')
+
+      log_string = "Sampling initialized with config: "
+      log_string += "global_sample_rate: #{@global_sample_rate.inspect}, "
+      log_string += "endpoint_sample_rate: #{@endpoint_sample_rate.inspect}, "
+      log_string += "sample_endpoints: #{@sample_endpoints.inspect}, "
+      log_string += "ignore_endpoints: #{@ignore_endpoints.inspect}, "
+      log_string += "job_sample_rate: #{@job_sample_rate.inspect}, "
+      log_string += "sample_jobs: #{@sample_jobs.inspect}, "
+      log_string += "ignore_jobs: #{@ignore_jobs.inspect}"
+      logger.info(log_string)
+    end
+
+    def drop_request?(transaction)
+      # Individual endpoint/job sampling takes precedence over ignoring.
+      # Individual endpoint/job sample rate always takes precedence over general endpoint/job rate.
+      # General endpoint/job rate always takes precedence over global sample rate
+      if transaction.job?
+        job_name = transaction.layer_finder.job.name
+        rate = job_sample_rate(job_name)
+        return sample?(rate) unless rate.nil?
+        return true if ignore_job?(job_name)
+        return sample?(@job_sample_rate) unless @job_sample_rate.nil?
+      elsif transaction.web?
+        uri = transaction.annotations[:uri]
+        rate = web_sample_rate(uri)
+        return sample?(rate) unless rate.nil?
+        return true if ignore_uri?(uri)
+        return sample?(@endpoint_sample_rate) unless @endpoint_sample_rate.nil?
+      end
+
+      # global sample check
+      if @global_sample_rate
+        return sample?(@global_sample_rate)
+      end
+
+      false # don't drop the request
+    end
+
+    def individual_sample_to_hash(sampling_config)
+      return nil if sampling_config.blank?
+      # config looks like ['/foo:50','/bar:100']. parse it into hash of string: integer
+      sample_hash = {}
+      sampling_config.each do |sample|
+        path, rate = sample.split(':')
+        sample_hash[path] = rate.to_i
+      end
+      sample_hash
+    end
+
+    def ignore_uri?(uri)
+      return false if @ignore_endpoints.blank?
+      @ignore_endpoints.each do |prefix|
+        return true if uri.start_with?(prefix)
+      end
+      false
+    end
+
+    def web_sample_rate(uri)
+      return nil if @sample_endpoints.blank?
+      @sample_endpoints.each do |prefix, rate|
+        return rate if uri.start_with?(prefix)
+      end
+      nil
+    end
+
+    def ignore_job?(job_name)
+      return false if @ignore_jobs.blank?
+      @ignore_jobs.include?(job_name)
+    end
+
+    def job_sample_rate(job_name)
+      return nil if @sample_jobs.blank?
+      @sample_jobs.fetch(job_name, nil)
+    end
+
+    def sample?(rate)
+      rand * 100 > rate
+    end
+
+    private
+
+    def logger
+      ScoutApm::Agent.instance.logger
+    end
+
+  end
+end

data/lib/scout_apm/tracked_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A TrackedRequest is a stack of layers, where completed layers (go into, then
 # come out of a layer) are forgotten as they finish. Layers are attached to
 # their children as the process goes, building a tree structure within the
@@ -303,7 +305,11 @@ module ScoutApm
       restore_from_dump! if @agent_context.nil?
 
       # Bail out early if the user asked us to ignore this uri
-      return if @agent_context.ignored_uris.ignore?(annotations[:uri])
+      # return if @agent_context.ignored_uris.ignore?(annotations[:uri])
+      if @agent_context.sampling.drop_request?(self)
+        logger.debug("Dropping request due to sampling")
+        return
+      end
 
       apply_name_override
 

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.6.4"
 end

data/lib/scout_apm.rb

@@ -111,6 +111,7 @@ require 'scout_apm/instruments/samplers'
 require 'scout_apm/app_server_load'
 
 require 'scout_apm/ignored_uris.rb'
+require 'scout_apm/sampling.rb'
 require 'scout_apm/utils/active_record_metric_name'
 require 'scout_apm/utils/backtrace_parser'
 require 'scout_apm/utils/installed_gems'

data/test/test_helper.rb

@@ -38,6 +38,10 @@ class FakeConfigOverlay
     @values[key]
   end
 
+  def values
+    @values
+  end
+
   def has_key?(key)
     @values.has_key?(key)
   end
@@ -169,3 +173,28 @@ end
 class Minitest::Test
   include CustomAsserts
 end
+
+class FakeTrackedRequest
+  def self.new_web_request(uri)
+    context = ScoutApm::Agent.instance.context
+    fake_store = ScoutApm::FakeStore.new
+    req = ScoutApm::TrackedRequest.new(context, fake_store)
+
+    first_layer = ScoutApm::Layer.new("Controller", "index")
+    req.start_layer(first_layer)
+    req.annotate_request(:uri => uri)
+
+    req
+  end
+
+  def self.new_job_request(job_name)
+    context = ScoutApm::Agent.instance.context
+    fake_store = ScoutApm::FakeStore.new
+    req = ScoutApm::TrackedRequest.new(context, fake_store)
+
+    first_layer = ScoutApm::Layer.new("Job", job_name)
+    req.start_layer(first_layer)
+
+    req
+  end
+end

data/test/unit/background_job_integrations/sidekiq_test.rb

@@ -18,7 +18,9 @@ class SidekiqTest < Minitest::Test
     def test_starts_on_startup
       ::ScoutApm::Agent.any_instance.expects(:start)
       SidekiqIntegration.new.install
-      Sidekiq.options[:lifecycle_events][:startup].map(&:call)
+      ::Sidekiq.configure_server do |config|
+        config[:lifecycle_events][:startup].map(&:call)
+      end
     end
   end
 
@@ -100,13 +102,21 @@ class SidekiqTest < Minitest::Test
   ########################################
   def test_latency_from_created_at
     # Created at time 80, but now it is 200. Latency was 120
-    msg = { 'created_at' => 80 }
+    msg = if SidekiqMiddleware.sidekiq_version_8?
+            { 'created_at' => 80000 } # milliseconds for Sidekiq 8+
+          else
+            { 'created_at' => 80 }
+          end
     assert_equal 120, SidekiqMiddleware.new.latency(msg, 200)
   end
 
   def test_latency_from_enqueued_at
     # Created at time 80, but now it is 200. Latency was 120
-    msg = { 'enqueued_at' => 80 }
+    msg = if SidekiqMiddleware.sidekiq_version_8?
+            { 'enqueued_at' => 80000 } # milliseconds for Sidekiq 8+
+          else
+            { 'enqueued_at' => 80 }
+          end
     assert_equal 120, SidekiqMiddleware.new.latency(msg, 200)
   end
 

data/test/unit/config_test.rb

@@ -72,6 +72,26 @@ class ConfigTest < Minitest::Test
     assert_equal ["a"], coercion.coerce(["a"])
   end
 
+  def test_integer_coercion
+    coercion = ScoutApm::Config::IntegerCoercion.new
+    assert_equal 1, coercion.coerce("1")
+    assert_equal 1, coercion.coerce(1)
+    assert_equal 0, coercion.coerce("0")
+    assert_equal 0, coercion.coerce(0)
+    assert_equal 0, coercion.coerce("")
+    assert_equal 0, coercion.coerce(nil)
+  end
+
+  def test_nullable_integer_coercion
+    coercion = ScoutApm::Config::NullableIntegerCoercion.new
+    assert_equal 1, coercion.coerce("1")
+    assert_equal 1, coercion.coerce(1)
+    assert_equal 0, coercion.coerce("0")
+    assert_equal 0, coercion.coerce(0)
+    assert_equal 0, coercion.coerce("")
+    assert_nil coercion.coerce(nil)
+  end
+
   def test_any_keys_found
     ENV.stubs(:has_key?).returns(nil)
 

data/test/unit/git_revision_test.rb

@@ -3,13 +3,75 @@ require 'test_helper'
 require 'scout_apm/git_revision'
 
 class GitRevisionTest < Minitest::Test
-  # TODO - other tests that would be nice:
-  # * ensure we only detect once, on initialize.
-  # * tests for reading cap files
+  def setup
+    @env = ENV.to_h
+  end
+
+  def teardown
+    ENV.replace(@env)
+  end
+
+  def test_sha_detected_once
+    ENV['HEROKU_SLUG_COMMIT'] = 'initial_slug'
+    revision = ScoutApm::GitRevision.new(ScoutApm::AgentContext.new)
+    assert_equal 'initial_slug', revision.sha
+
+    ENV['HEROKU_SLUG_COMMIT'] = 'new_slug'
+    assert_equal 'initial_slug', revision.sha
+  end
+
+  def test_sha_from_config
+    config = make_fake_config('revision_sha' => 'config_sha')
+    context = ScoutApm::AgentContext.new().tap { |c| c.config = config }
+    revision = ScoutApm::GitRevision.new(context)
+
+    assert_equal 'config_sha', revision.sha
+  end
 
   def test_sha_from_heroku
     ENV['HEROKU_SLUG_COMMIT'] = 'heroku_slug'
     revision = ScoutApm::GitRevision.new(ScoutApm::AgentContext.new)
     assert_equal 'heroku_slug', revision.sha
   end
+
+  def test_sha_from_capistrano
+    Dir.mktmpdir do |dir|
+      context = context_with_file_in_root(File.join(dir, 'REVISION'), 'capistrano_sha')
+      revision = ScoutApm::GitRevision.new(context)
+      assert_equal 'capistrano_sha', revision.sha
+    end
+  end
+
+  def test_sha_from_kamal
+    ENV['KAMAL_VERSION'] = 'kamal_sha'
+    revision = ScoutApm::GitRevision.new(ScoutApm::AgentContext.new)
+    assert_equal 'kamal_sha', revision.sha
+  end
+
+
+  def test_sha_from_mina
+    Dir.mktmpdir do |dir|
+      context = context_with_file_in_root(File.join(dir, '.mina_git_revision'), 'mina_sha')
+      revision = ScoutApm::GitRevision.new(context)
+      assert_equal 'mina_sha', revision.sha
+    end
+  end
+
+  def test_sha_from_git
+    short_sha = `git rev-parse --short HEAD`.strip
+    skip 'git not installed or not in a git repository' if short_sha.empty?
+
+    revision = ScoutApm::GitRevision.new(ScoutApm::AgentContext.new)
+    assert_equal short_sha, revision.sha
+  end
+
+  private
+
+  def context_with_file_in_root(file_name, contents)
+    config = make_fake_config({})
+    env = make_fake_environment(root: File.dirname(file_name))
+    File.write(file_name, contents)
+
+    ScoutApm::AgentContext.new().tap { |c| c.config = config; c.environment = env }
+  end
 end

data/test/unit/sampling_test.rb

@@ -0,0 +1,215 @@
+require 'test_helper'
+
+require 'scout_apm/sampling'
+
+class SamplingTest < Minitest::Test
+
+    def setup
+      @global_sample_config = FakeConfigOverlay.new(
+        {
+          'sample_rate' => 80,
+        }
+      )
+
+      @individual_config = FakeConfigOverlay.new(
+        {
+          'sample_endpoints' => ['/foo/bar:100', '/foo:50', '/bar/zap:80'],
+          'ignore_endpoints' => ['/baz'],
+          'sample_jobs' => ['joba:50'],
+          'ignore_jobs' => 'jobb,jobc',
+        }
+      )
+    end
+
+    def test_individual_sample_to_hash
+      sampling = ScoutApm::Sampling.new(@individual_config)
+      assert_equal({'/foo/bar' => 100, '/foo' => 50, '/bar/zap' => 80}, sampling.individual_sample_to_hash(@individual_config.value('sample_endpoints')))
+
+      sampling = ScoutApm::Sampling.new(@global_sample_config)
+      assert_nil sampling.individual_sample_to_hash(@global_sample_config.value('sample_endpoints'))
+    end
+
+    def test_uri_ignore
+      sampling = ScoutApm::Sampling.new(@individual_config)
+      assert_equal true, sampling.ignore_uri?('/baz/bap')
+      assert_equal false, sampling.ignore_uri?('/foo/far')
+    end
+
+    def test_uri_sample
+      sampling = ScoutApm::Sampling.new(@individual_config)
+      rate = sampling.web_sample_rate('/foo/far')
+      assert_equal 50, rate
+
+      rate = sampling.web_sample_rate('/bar')
+      assert_nil rate
+
+      rate = sampling.web_sample_rate('/baz/bap')
+      assert_nil rate
+
+      rate = sampling.web_sample_rate('/foo/bar/baz')
+      assert_equal 100, rate
+    end
+
+    def test_job_ignore
+      sampling = ScoutApm::Sampling.new(@individual_config)
+      assert_equal true, sampling.ignore_job?('jobb')
+      assert_equal false, sampling.ignore_job?('joba')
+    end
+
+    def test_job_sample
+      sampling = ScoutApm::Sampling.new(@individual_config)
+      assert_equal 50, sampling.job_sample_rate('joba')
+      assert_nil sampling.job_sample_rate('jobb')
+    end
+
+    def test_sample
+      sampling = ScoutApm::Sampling.new(@individual_config)
+      sampling.stub(:rand, 0.01) do
+        assert_equal(false, sampling.sample?(50))
+      end
+      sampling.stub(:rand, 0.99) do
+        assert_equal(true, sampling.sample?(50))
+      end
+    end
+
+    def test_old_ignore
+      config = FakeConfigOverlay.new({'ignore' => ['/foo', '/bar']})
+      sampling = ScoutApm::Sampling.new(config)
+      assert_equal true, sampling.ignore_uri?('/foo')
+      assert_equal true, sampling.ignore_uri?('/bar/bap')
+      assert_equal false, sampling.ignore_uri?('/baz')
+    end
+
+    def test_web_request_individual_sampling
+      sampling = ScoutApm::Sampling.new(@individual_config)
+
+      # should be ignored
+      transaction = FakeTrackedRequest.new_web_request('/baz/bap')
+      assert_equal true, sampling.drop_request?(transaction)
+
+      # should be kept
+      transaction = FakeTrackedRequest.new_web_request('/faz/bap')
+      assert_equal false, sampling.drop_request?(transaction)
+
+      transaction = FakeTrackedRequest.new_web_request('/foo/far')
+      sampling.stub(:rand, 0.01) do
+        assert_equal false, sampling.drop_request?(transaction)
+      end
+
+      # passes individual sample but caught by global rate
+      sampling.stub(:rand, 0.99) do
+        assert_equal true, sampling.drop_request?(transaction)
+      end
+    end
+
+    def test_web_reqeust_general_sampling
+      config = FakeConfigOverlay.new(@individual_config.values.merge({'endpoint_sample_rate' => 80}))
+      sampling = ScoutApm::Sampling.new(config)
+
+      transaction = FakeTrackedRequest.new_web_request('/foo/far')
+      transaction2 = FakeTrackedRequest.new_web_request('/ooo/oar')
+      # /foo/far sampled at 50 specifically, /ooo/oar caught by general endpoint rate of 80
+      sampling.stub(:rand, 0.01) do
+        assert_equal false, sampling.drop_request?(transaction)
+        assert_equal false, sampling.drop_request?(transaction2)
+      end
+
+      sampling.stub(:rand, 0.70) do
+        assert_equal true, sampling.drop_request?(transaction)
+        assert_equal false, sampling.drop_request?(transaction2)
+      end
+
+      sampling.stub(:rand, 0.99) do
+        assert_equal true, sampling.drop_request?(transaction)
+        assert_equal true, sampling.drop_request?(transaction2)
+      end
+    end
+
+    def test_web_request_with_global_sampling
+      config = FakeConfigOverlay.new(@individual_config.values.merge({'sample_rate' => 20}))
+      sampling = ScoutApm::Sampling.new(config)
+
+      # caught by individual rate
+      transaction = FakeTrackedRequest.new_web_request('/foo/far')
+      sampling.stub(:rand, 0.01) do
+        assert_equal false, sampling.drop_request?(transaction)
+      end
+
+      # passes individual rate (50) but caught by global rate (20)
+      sampling.stub(:rand, 0.30) do
+        assert_equal false, sampling.drop_request?(transaction)
+      end
+
+      # passes individual rate
+      sampling.stub(:rand, 0.99) do
+        assert_equal true, sampling.drop_request?(transaction)
+      end
+
+    end
+
+    def test_job_request_individual_sampling
+      sampling = ScoutApm::Sampling.new(@individual_config)
+
+      # should be ignored
+      transaction = FakeTrackedRequest.new_job_request('jobb')
+      assert_equal true, sampling.drop_request?(transaction)
+
+      # should be kept
+      transaction = FakeTrackedRequest.new_job_request('jobz')
+      assert_equal false, sampling.drop_request?(transaction)
+
+      # should be sampled if rand > 50
+      transaction = FakeTrackedRequest.new_job_request('joba')
+      sampling.stub(:rand, 0.01) do
+        assert_equal false, sampling.drop_request?(transaction)
+      end
+
+      sampling.stub(:rand, 0.99) do
+        assert_equal true, sampling.drop_request?(transaction)
+      end
+    end
+
+    def test_job_general_sampling
+      config = FakeConfigOverlay.new(@individual_config.values.merge({'job_sample_rate' => 80}))
+      sampling = ScoutApm::Sampling.new(config)
+
+      transaction = FakeTrackedRequest.new_job_request('joba')
+      transaction2 = FakeTrackedRequest.new_job_request('jobz')
+      # joba sampled at 50 specifically, jobz caught by general job rate of 80
+      sampling.stub(:rand, 0.01) do
+        assert_equal false, sampling.drop_request?(transaction)
+        assert_equal false, sampling.drop_request?(transaction2)
+      end
+
+      sampling.stub(:rand, 0.70) do
+        assert_equal true, sampling.drop_request?(transaction)
+        assert_equal false, sampling.drop_request?(transaction2)
+      end
+
+      sampling.stub(:rand, 0.99) do
+        assert_equal true, sampling.drop_request?(transaction)
+        assert_equal true, sampling.drop_request?(transaction2)
+      end
+    end
+
+    def test_job_request_global_sampling
+      config = FakeConfigOverlay.new(@individual_config.values.merge({'sample_rate' => 20}))
+      sampling = ScoutApm::Sampling.new(config)
+
+      # caught by individual rate
+      transaction = FakeTrackedRequest.new_job_request('joba')
+      sampling.stub(:rand, 0.01) do
+        assert_equal false, sampling.drop_request?(transaction)
+      end
+
+      # passes individual rate (50) but caught by global rate (20)
+      sampling.stub(:rand, 0.30) do
+        assert_equal false, sampling.drop_request?(transaction)
+      end
+
+      # passes individual rate
+      sampling.stub(:rand, 0.99) do
+        assert_equal true, sampling.drop_request?(transaction)
+      end
+    end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.6.4
 platform: ruby
 authors:
 - Derek Haynes
 - Andre Lewis
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2025-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -239,8 +238,11 @@ files:
 - gems/rails4.gemfile
 - gems/rails5.gemfile
 - gems/rails6.gemfile
+- gems/rails7.gemfile
 - gems/sidekiq.gemfile
-- gems/sqlite3-1.3.gemfile
+- gems/sidekiq7.gemfile
+- gems/sidekiq8.gemfile
+- gems/sqlite3-v2.gemfile
 - gems/typhoeus.gemfile
 - lib/scout_apm.rb
 - lib/scout_apm/agent.rb
@@ -366,6 +368,7 @@ files:
 - lib/scout_apm/reporting.rb
 - lib/scout_apm/request_histograms.rb
 - lib/scout_apm/request_manager.rb
+- lib/scout_apm/sampling.rb
 - lib/scout_apm/scored_item_set.rb
 - lib/scout_apm/serializers/app_server_load_serializer.rb
 - lib/scout_apm/serializers/db_query_serializer_to_json.rb
@@ -472,6 +475,7 @@ files:
 - test/unit/remote/route_test.rb
 - test/unit/remote/server_test.rb
 - test/unit/request_histograms_test.rb
+- test/unit/sampling_test.rb
 - test/unit/scored_item_set_test.rb
 - test/unit/serializers/payload_serializer_test.rb
 - test/unit/slow_request_policy_test.rb
@@ -489,7 +493,6 @@ homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -505,8 +508,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: []