scout_apm 5.5.0 → 5.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3dfd72cdc46892ac46a974e4e3947f81ac2ee6580bee96c0cc6ad845ce50ee7
-  data.tar.gz: 560fb31452b8c5b526bf77723d121d561096c759640c0266ba894ffe71901d99
+  metadata.gz: 351ed300191874b86b1c402a2696897d05006266c2c88716a15d8588aefa00b2
+  data.tar.gz: dcdc4fb47007eb665f7a4df6a3a9a7bcde78550656692fc5023020739b0974d9
 SHA512:
-  metadata.gz: 3958265f12804e22dbb4c75d3b03a6d4ad9f87ff989e5382f8d0b890d55c2c2505828cd4022fa7a965092bb7c0948a12baea760b0d15fd05f5ceef6d1a23f962
-  data.tar.gz: cb45c1255f16f299e7a8cc67c93efd21fd7912682c4d4ed2030498be069022f2cf8811a987bbec0c22ff28150d57ff95222ed0771e0c2758bbba057b1805d4a8
+  metadata.gz: 8fe62cd0646f58ad535d3912cf9c023fb8d7c52116dd30b3359e7f33f50f51ba3457090fe2df8f0bec5e5194b02bcccb44feaa466d76fa14938b91f11f1f74c0
+  data.tar.gz: cd20a788b47c33be24c8ee88eb00d443bf3d20990ba3fb769ca64353b14b090b931c121d6f07aa40bd366381f3f77646b41206e66cb9507cb204ee3eaadf62fe

data/CHANGELOG.markdown

@@ -1,5 +1,18 @@
 # Unreleased
 
+# 5.6.1
+- Fix `job_sample_rate` and `endpoint_sample_rate` default configuration values (#529)
+
+# 5.6.0
+- New options for sampling and ignore configurationn (#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

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/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/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

@@ -303,7 +303,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/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "5.5.0"
+  VERSION = "5.6.1"
 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/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_equal nil, coercion.coerce(nil)
+  end
+
   def test_any_keys_found
     ENV.stubs(:has_key?).returns(nil)
 

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_equal 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_equal nil, rate
+
+      rate = sampling.web_sample_rate('/baz/bap')
+      assert_equal 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_equal 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.5.0
+  version: 5.6.1
 platform: ruby
 authors:
 - Derek Haynes
 - Andre Lewis
 bindir: bin
 cert_chain: []
-date: 2025-01-02 00:00:00.000000000 Z
+date: 2025-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -365,6 +365,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
@@ -471,6 +472,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