scout_apm 6.0.1 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f7da6e5dce565451022406d4bbf06ccba3eb60cca723d391886083584595ca8
-  data.tar.gz: a9001c043e9f4b7afb9c556474e0b50baecbb191a05bc3b308f85072443df914
+  metadata.gz: af813ad30f40b8cee3cb1e50c8b6ca311c8347d0431d18c6e5ce0939cda174e5
+  data.tar.gz: d9baccb3c23a1c45571503349ddbc4dc4de4f0e48fbf10ee7fd40ce7f7b76b2f
 SHA512:
-  metadata.gz: 39de9f2fe98871ab474a43c784c9db73a800832e5ac6757004036065c0ea9f68955f36e953fa36249d5ce7d78c289aa9e373d8f01fe83c22c6987bd149eeab34
-  data.tar.gz: 588d9fad7ad1fe3084ed28b2ce9565cda61eb694389bfefae3f065ace19f09b463c5de801766ab105540385350ed8d8ee2e6be545842794b8f60821cc2f0d5b1
+  metadata.gz: 1d08de0c4f24ca6d8385a381705134baff6c5b65463f4775d78eae4c03bdc91195acfb24edf666743cf2e3064b20780251f345b6b4e02ac658e7841633986f51
+  data.tar.gz: ef12b4f094e373c5769e79c55a047b1b90db1a236fdcce4a23aacd657b5703127b662549cc56e92f72172e4e5732c99a8f769376df0a231411dbcf3f7e71d253

data/CHANGELOG.markdown

@@ -1,7 +1,17 @@
+# 6.0.2
+- Fix `endpoint_sample_rate` and `job_sample_rate` to support float values 
+
 # 6.0.1
 - Fix capturing of job params for non ActiveJob
 
 # 6.0.0
+
+**Breaking Change**
+Sampling configuration options now take `float` arguments between `0.0` and `1.0`. This means
+you can now set sample rates lower than one. Backwards compatibility is maintained for
+existing config > 1 by converting to a percentage internally. **If your endpoint is
+sampled at exactly 1%, you must now set `0.01` instead of `1`.**
+
 - Add Prism AutoInstruments Support (#582) (#594)
 - Add OpenSearch instrumentation (#563)
 - Add HTTPX instrumentation (#588)

data/gems/sidekiq8.gemfile

@@ -2,3 +2,4 @@ eval_gemfile("../Gemfile")
 
 gem 'sqlite3', '~> 2.0'
 gem 'sidekiq', '~> 8.0'
+gem 'minitest-mock'

data/gems/sqlite3-v2.gemfile

@@ -1,3 +1,4 @@
 eval_gemfile("../Gemfile")
 
 gem "sqlite3", ">= 2.1"
+gem 'minitest-mock'

data/lib/scout_apm/config.rb

@@ -213,6 +213,8 @@ module ScoutApm
 
     class SampleRateCoercion
       def coerce(val)
+        return nil if val.nil?
+        return nil if val.to_s.strip.empty?
         v = val.to_f
         # Anything above 1 is assumed a percentage for backwards compat, so convert to a decimal
         if v > 1
@@ -252,8 +254,8 @@ module ScoutApm
       'sample_rate' => SampleRateCoercion.new,
       'sample_endpoints' => JsonCoercion.new,
       'sample_jobs' => JsonCoercion.new,
-      'endpoint_sample_rate' => NullableIntegerCoercion.new,
-      'job_sample_rate' => NullableIntegerCoercion.new,
+      'endpoint_sample_rate' => SampleRateCoercion.new,
+      'job_sample_rate' => SampleRateCoercion.new,
       'start_resque_server_instrument' => BooleanCoercion.new,
       'timeline_traces' => BooleanCoercion.new,
       'auto_instruments' => BooleanCoercion.new,

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "6.0.1"
+  VERSION = "6.0.2"
 end

data/test/test_helper.rb

@@ -3,7 +3,7 @@ require 'simplecov'
 SimpleCov.start
 
 require 'minitest/autorun'
-require 'minitest/unit'
+require 'minitest/mock'
 require 'minitest/pride'
 require 'mocha/minitest'
 require 'pry'

data/test/unit/config_test.rb

@@ -94,15 +94,24 @@ class ConfigTest < Minitest::Test
 
   def test_sample_rate_coercion
     coercion = ScoutApm::Config::SampleRateCoercion.new
+    # Preserves nil and empty strings
+    assert_nil coercion.coerce(nil)
+    assert_nil coercion.coerce("")
+    assert_nil coercion.coerce("  ")
+    # Float strings work
     assert_in_delta 1.0, coercion.coerce("1")
     assert_in_delta 0.015, coercion.coerce("1.5")
+    assert_in_delta 0.5, coercion.coerce("0.5")
+    assert_in_delta 0.01, coercion.coerce("0.01")
+    # Numbers work
     assert_in_delta 1.0, coercion.coerce(1)
     assert_in_delta 0.015, coercion.coerce(1.5)
     assert_in_delta 0.0, coercion.coerce("0")
     assert_in_delta 0.0, coercion.coerce(0)
-    assert_in_delta 0.0, coercion.coerce("")
-    assert_in_delta 0.0, coercion.coerce(nil)
-    assert_in_delta 0.5, coercion.coerce("0.5")
+    # Backwards compatibility: values > 1 treated as percentages
+    assert_in_delta 0.15, coercion.coerce("15")
+    assert_in_delta 0.15, coercion.coerce(15)
+    # Clamping
     assert_in_delta 0, coercion.coerce("-2.5")
   end
 
@@ -116,4 +125,52 @@ class ConfigTest < Minitest::Test
     conf = ScoutApm::Config.with_file(@context, "a_file_that_doesnt_exist.yml")
     assert conf.any_keys_found?
   end
+
+  def test_endpoint_sample_rate_from_env_with_float_string
+    ENV['SCOUT_ENDPOINT_SAMPLE_RATE'] = '0.01'
+    conf = ScoutApm::Config.without_file(@context)
+    assert_in_delta 0.01, conf.value('endpoint_sample_rate')
+  ensure
+    ENV.delete('SCOUT_ENDPOINT_SAMPLE_RATE')
+  end
+
+  def test_job_sample_rate_from_env_with_float_string
+    ENV['SCOUT_JOB_SAMPLE_RATE'] = '0.01'
+    conf = ScoutApm::Config.without_file(@context)
+    assert_in_delta 0.01, conf.value('job_sample_rate')
+  ensure
+    ENV.delete('SCOUT_JOB_SAMPLE_RATE')
+  end
+
+  def test_endpoint_sample_rate_backwards_compat_with_percentage
+    # Values > 1 should be treated as percentages for backwards compatibility
+    ENV['SCOUT_ENDPOINT_SAMPLE_RATE'] = '15'
+    conf = ScoutApm::Config.without_file(@context)
+    assert_in_delta 0.15, conf.value('endpoint_sample_rate')
+  ensure
+    ENV.delete('SCOUT_ENDPOINT_SAMPLE_RATE')
+  end
+
+  def test_job_sample_rate_backwards_compat_with_percentage
+    # Values > 1 should be treated as percentages for backwards compatibility
+    ENV['SCOUT_JOB_SAMPLE_RATE'] = '15'
+    conf = ScoutApm::Config.without_file(@context)
+    assert_in_delta 0.15, conf.value('job_sample_rate')
+  ensure
+    ENV.delete('SCOUT_JOB_SAMPLE_RATE')
+  end
+
+  def test_endpoint_sample_rate_nil_when_not_set
+    # Nil allows sampling to fall through to global sample_rate
+    ENV.delete('SCOUT_ENDPOINT_SAMPLE_RATE')
+    conf = ScoutApm::Config.without_file(@context)
+    assert_nil conf.value('endpoint_sample_rate')
+  end
+
+  def test_job_sample_rate_nil_when_not_set
+    # Nil allows sampling to fall through to global sample_rate
+    ENV.delete('SCOUT_JOB_SAMPLE_RATE')
+    conf = ScoutApm::Config.without_file(@context)
+    assert_nil conf.value('job_sample_rate')
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.0.2
 platform: ruby
 authors:
 - Derek Haynes