solarwinds_apm 7.1.0 → 7.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d565e746144994b5c3a81ee19665ee9b2d4e81fbad2e21da567465455c37e6c0
-  data.tar.gz: 949351c94748745d2ba19268a531ba5b4f805568132772dcfb9749b0af3698a8
+  metadata.gz: '082c952e4514335f3f4b5371745bc77c371592d8f4473b65149bdcd2613281a2'
+  data.tar.gz: 9ee34f536ac6580862f9b97cfed9942d36b235a533e0f75c55181de30a80d69f
 SHA512:
-  metadata.gz: 209a50b78aa94dc85805ef8c6c08db7584966ca62293c53aa9744852170c3c84ac4ef24b2e43e508bad5d1e505f4cd82d72d984a00823232b9a9e13bddb061c6
-  data.tar.gz: '0962ab7325e66d3f330361b9f0187f75c07eabcd2d0d400db0d55e75c2124aefa2fe630cbe2eef506f48f58f6e6d3cb6ad1d36f1a816845618b6bd2649e8b951'
+  metadata.gz: b35526de0b456a81e53feb19ec84a48d592f48077cb52cdef3f9ca2e0cfa8cc341bbc41904255de6550c5484bb4da85ca555ada74f48461cd9817858bf4c6ac2
+  data.tar.gz: '0549ec00da3f0f6940baec1049072c6a5ef96b7ac9c90c2f7a3078ed52f51ff50eeee93e5fe6b12a2ce08cd8f71b39341ed6ffa2b5cf249762d5d9477ac9462b'

data/lib/solarwinds_apm/config.rb

@@ -192,29 +192,14 @@ module SolarWindsAPM
       case key
       when :sampling_rate
         SolarWindsAPM.logger.warn do
-          "[#{name}/#{__method__}] sampling_rate is not a supported setting for SolarWindsAPM::Config. Please use :sample_rate."
+          '[Deprecated] sampling_rate is not a supported setting for SolarWindsAPM::Config.'
         end
 
       when :sample_rate
-        unless value.is_a?(Integer) || value.is_a?(Float)
-          SolarWindsAPM.logger.warn do
-            "[#{name}/#{__method__}] :sample_rate must be a number between 0 and 1000000 (1m) (provided: #{value}), corrected to 0"
-          end
-          value = 0
-        end
-
-        # Validate :sample_rate value
-        unless value.between?(0, 1e6)
-          new_value = value.negative? ? 0 : 1_000_000
-          SolarWindsAPM.logger.warn do
-            "[#{name}/#{__method__}] :sample_rate must be between 0 and 1000000 (1m) (provided: #{value}), corrected to #{new_value}"
-          end
+        SolarWindsAPM.logger.warn do
+          '[Deprecated] sample_rate is not a supported setting for SolarWindsAPM::Config.'
         end
 
-        # Assure value is an integer
-        @@config[key.to_sym] = new_value.to_i
-        SolarWindsAPM.sample_rate(new_value)
-
       when :transaction_settings
         compile_settings(value)
 

data/lib/solarwinds_apm/sampling/oboe_sampler.rb

@@ -18,7 +18,6 @@ module SolarWindsAPM
     TRIGGERED_TRACE_ATTRIBUTE = 'TriggeredTrace'
 
     TRACESTATE_REGEXP = /^[0-9a-f]{16}-[0-9a-f]{2}$/
-    BUCKET_INTERVAL = 1000
     DICE_SCALE = 1_000_000
 
     OTEL_SAMPLING_DECISION = ::OpenTelemetry::SDK::Trace::Samplers::Decision
@@ -30,16 +29,14 @@ module SolarWindsAPM
       @counters = SolarWindsAPM::Metrics::Counter.new
       @buckets = {
         SolarWindsAPM::BucketType::DEFAULT =>
-          SolarWindsAPM::TokenBucket.new(SolarWindsAPM::TokenBucketSettings.new(nil, nil, BUCKET_INTERVAL, 'DEFUALT')),
+          SolarWindsAPM::TokenBucket.new(SolarWindsAPM::TokenBucketSettings.new(nil, nil, 'DEFUALT')),
         SolarWindsAPM::BucketType::TRIGGER_RELAXED =>
-          SolarWindsAPM::TokenBucket.new(SolarWindsAPM::TokenBucketSettings.new(nil, nil, BUCKET_INTERVAL, 'TRIGGER_RELAXED')),
+          SolarWindsAPM::TokenBucket.new(SolarWindsAPM::TokenBucketSettings.new(nil, nil, 'TRIGGER_RELAXED')),
         SolarWindsAPM::BucketType::TRIGGER_STRICT =>
-          SolarWindsAPM::TokenBucket.new(SolarWindsAPM::TokenBucketSettings.new(nil, nil, BUCKET_INTERVAL, 'TRIGGER_STRICT'))
+          SolarWindsAPM::TokenBucket.new(SolarWindsAPM::TokenBucketSettings.new(nil, nil, 'TRIGGER_STRICT'))
       }
       @settings = {} # parsed setting from swo backend
       @settings_mutex = ::Mutex.new
-
-      @buckets.each_value(&:start)
     end
 
     # return sampling result
@@ -289,9 +286,9 @@ module SolarWindsAPM
     end
 
     def update_settings(settings)
-      return unless settings[:timestamp] > (@settings[:timestamp] || 0)
-
       @settings_mutex.synchronize do
+        return unless settings[:timestamp] > (@settings[:timestamp] || 0)
+
         @settings = settings
         @buckets.each do |type, bucket|
           bucket.update(@settings[:buckets][type]) if @settings[:buckets][type]
@@ -324,18 +321,20 @@ module SolarWindsAPM
     end
 
     def get_settings(params)
-      return if @settings.empty?
-
-      expiry = (@settings[:timestamp] + @settings[:ttl]) * 1000
-      time_now = Time.now.to_i * 1000
-      if time_now > expiry
-        @logger.debug { "[#{self.class}/#{__method__}] settings expired, removing" }
-        @settings = {}
-        return
+      @settings_mutex.synchronize do
+        return if @settings.empty?
+
+        expiry = (@settings[:timestamp] + @settings[:ttl]) * 1000
+        time_now = Time.now.to_i * 1000
+        if time_now > expiry
+          @logger.debug { "[#{self.class}/#{__method__}] settings expired, removing" }
+          @settings = {}
+          return
+        end
+        sampling_setting = SolarWindsAPM::SamplingSettings.merge(@settings, local_settings(params))
+        @logger.debug { "[#{self.class}/#{__method__}] sampling_setting: #{sampling_setting.inspect}" }
+        sampling_setting
       end
-      sampling_setting = SolarWindsAPM::SamplingSettings.merge(@settings, local_settings(params))
-      @logger.debug { "[#{self.class}/#{__method__}] sampling_setting: #{sampling_setting.inspect}" }
-      sampling_setting
     end
   end
 end

data/lib/solarwinds_apm/sampling/sampling_constants.rb

@@ -55,7 +55,6 @@ module SolarWindsAPM
 
   TokenBucketSettings = Struct.new(:capacity,    # Number
                                    :rate,        # Number
-                                   :interval,    # Number
                                    :type)        # String
 
   module SampleSource

data/lib/solarwinds_apm/sampling/token_bucket.rb

@@ -10,126 +10,88 @@
 # capacity is updated through update_settings
 module SolarWindsAPM
   class TokenBucket
-    # Maximum value of a signed 32-bit integer
-    MAX_INTERVAL = (2**31) - 1
-
-    attr_reader :capacity, :rate, :interval, :tokens, :type
+    attr_reader :type
 
     def initialize(token_bucket_settings)
-      self.capacity = token_bucket_settings.capacity || 0
-      self.rate = token_bucket_settings.rate || 0
-      self.interval = token_bucket_settings.interval || MAX_INTERVAL
-      self.tokens = @capacity
+      @capacity = token_bucket_settings.capacity || 0
+      @rate = token_bucket_settings.rate || 0
+      @tokens = @capacity
+      @last_update_time = Time.now.to_f
       @type = token_bucket_settings.type
-      @timer = nil
+      @lock = ::Mutex.new
     end
 
-    # oboe sampler update_settings will update the token
-    # (thread safe as update_settings is guarded by mutex from oboe sampler)
-    def update(settings)
-      settings.instance_of?(Hash) ? update_from_hash(settings) : update_from_token_bucket_settings(settings)
+    def capacity
+      @lock.synchronize { @capacity }
     end
 
-    def update_from_hash(settings)
-      if settings[:capacity]
-        difference = settings[:capacity] - @capacity
-        self.capacity = settings[:capacity]
-        self.tokens = @tokens + difference
-      end
-
-      self.rate = settings[:rate] if settings[:rate]
-
-      return unless settings[:interval]
-
-      self.interval = settings[:interval]
-      return unless running
-
-      stop
-      start
+    def rate
+      @lock.synchronize { @rate }
     end
 
-    def update_from_token_bucket_settings(settings)
-      if settings.capacity
-        difference = settings.capacity - @capacity
-        self.capacity = settings.capacity
-        self.tokens = @tokens + difference
+    def tokens
+      @lock.synchronize do
+        calculate_tokens
+        @tokens
       end
-
-      self.rate = settings.rate if settings.rate
-
-      return unless settings.interval
-
-      self.interval = settings.interval
-      return unless running
-
-      stop
-      start
-    end
-
-    def capacity=(capacity)
-      @capacity = [0, capacity].max
-    end
-
-    def rate=(rate)
-      @rate = [0, rate].max
-    end
-
-    # self.interval= sets the @interval and @sleep_interval
-    # @sleep_interval is used in the timer thread to sleep between replenishing the bucket
-    def interval=(interval)
-      @interval = interval.clamp(0, MAX_INTERVAL)
-      @sleep_interval = @interval / 1000.0
     end
 
-    def tokens=(tokens)
-      @tokens = tokens.clamp(0, @capacity)
+    # oboe sampler update_settings will update the token
+    def update(settings)
+      settings.instance_of?(Hash) ? update_from_hash(settings) : update_from_hash(tb_to_hash(settings))
     end
 
     # Attempts to consume tokens from the bucket
-    # @param n [Integer] Number of tokens to consume
+    # @param token [Integer] Number of tokens to consume
     # @return [Boolean] Whether there were enough tokens
-    # TODO: we need to include thread-safety here since sampler is shared across threads
-    # and we may have multiple threads trying to consume tokens at the same time
     def consume(token = 1)
-      if @tokens >= token
-        self.tokens = @tokens - token
-        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] #{@type} Consumed #{token} from total #{@tokens} (#{(@tokens.to_f / @capacity * 100).round(1)}% remaining)" }
-        true
-      else
-        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] #{@type} Token consumption failed: requested=#{token}, available=#{@tokens}, capacity=#{@capacity}" }
-        false
-      end
-    end
-
-    # Starts replenishing the bucket
-    def start
-      return if running
-
-      @timer = Thread.new do
-        loop do
-          task
-          sleep(@sleep_interval)
+      @lock.synchronize do
+        calculate_tokens
+        if @tokens >= token
+          @tokens -= token
+          SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] #{@type} Consumed #{token} (#{(@tokens.to_f / @capacity * 100).round(1)}% remaining)" }
+          true
+        else
+          SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] #{@type} Token consumption failed: requested=#{token}, available=#{@tokens}, capacity=#{@capacity}" }
+          false
         end
       end
     end
 
-    # Stops replenishing the bucket
-    def stop
-      return unless running
+    private
 
-      @timer.kill
-      @timer = nil
+    def calculate_tokens
+      now = Time.now.to_f
+      elapsed = now - @last_update_time
+      @last_update_time = now
+      @tokens += elapsed * @rate
+      @tokens = [@tokens, @capacity].min
     end
 
-    # Whether the bucket is actively being replenished
-    def running
-      !@timer.nil?
-    end
+    # settings is from json sampler
+    def update_from_hash(settings)
+      @lock.synchronize do
+        calculate_tokens
+
+        if settings[:capacity]
+          new_capacity = [0, settings[:capacity]].max
+          difference = new_capacity - @capacity
+          @capacity = new_capacity
+          @tokens += difference
+          @tokens = [0, @tokens].max
+        end
 
-    private
+        @rate = [0, settings[:rate]].max if settings[:rate]
+      end
+    end
 
-    def task
-      self.tokens = tokens + @rate
+    # settings is from http sampler
+    def tb_to_hash(settings)
+      tb_hash = {}
+      tb_hash[:capacity] = settings.capacity if settings.respond_to?(:capacity)
+      tb_hash[:rate] = settings.rate if settings.respond_to?(:rate)
+      tb_hash[:type] = settings.type if settings.respond_to?(:type)
+      tb_hash
     end
   end
 end

data/lib/solarwinds_apm/version.rb

@@ -13,7 +13,7 @@ module SolarWindsAPM
   module Version
     MAJOR  = 7 # breaking,
     MINOR  = 1 # feature,
-    PATCH  = 0 # fix => BFF
+    PATCH  = 1 # fix => BFF
     PRE    = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solarwinds_apm
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.1.1
 platform: ruby
 authors:
 - Maia Engeli
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-21 00:00:00.000000000 Z
+date: 2026-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-exporter-otlp