bugsnag_performance 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31cfcfc45215dec768c1e6040c418f63355ea308cf2d8d660ccad2c3f2de3621
-  data.tar.gz: e3868f8cd3341f285e0bd868c3db54e640739ed0a755308162c3dac96cf47b76
+  metadata.gz: 84d3f11ac05bf81b8de7503e8992327b5152196ed024ee348aaac879fa7b845e
+  data.tar.gz: 517ae6ce8cfa46220e1a2d5b3394514cc2096a8139cd7c82492e5d62dbcff615
 SHA512:
-  metadata.gz: f394a3a656e3bbd76aa825db67b2e6bd156590d666648ca6484df820fc833f8904e24dce311084bcfc64ff4e064f5bbcd181a92e51a60d27c7ccedf7a029ccd4
-  data.tar.gz: 9f8ad547b130279f751169c2305ce57faaf34a566782abca3df7fc307efbab8b14873c6ef0946069a0f49f159d40d8b225969eaf5defa5bb236b402e10afd05d
+  metadata.gz: 74294e03b1b6bfada4a0043b12fa5d82ea0953dd592d274c36792b49a96445fbf21026b275ae0055d2a5505aad93099bc063332102e25fdfae48a8cd2242e1d9
+  data.tar.gz: 8f4c8de90d51d4e613869b7f74b5ed8a88f142819d4e576442df0e457dd3534b6d5a3c959feb7d2557286784211658a17ae387503df2078b819b77c9f4e078d3

data/lib/bugsnag_performance/configuration.rb

@@ -9,7 +9,6 @@ module BugsnagPerformance
     attr_accessor :app_version
     attr_accessor :release_stage
     attr_accessor :enabled_release_stages
-    attr_accessor :use_managed_quota
 
     attr_writer :endpoint
 
@@ -20,7 +19,6 @@ module BugsnagPerformance
       @api_key = fetch(errors_configuration, :api_key, env: "BUGSNAG_PERFORMANCE_API_KEY")
       @app_version = fetch(errors_configuration, :app_version)
       @release_stage = fetch(errors_configuration, :release_stage, env: "BUGSNAG_PERFORMANCE_RELEASE_STAGE", default: "production")
-      @use_managed_quota = true
 
       @enabled_release_stages = fetch(errors_configuration, :enabled_release_stages, env: "BUGSNAG_PERFORMANCE_ENABLED_RELEASE_STAGES")
 

data/lib/bugsnag_performance/internal/configuration_validator.rb

@@ -16,7 +16,6 @@ module BugsnagPerformance
         validate_string(:app_version, optional: true)
         validate_string(:release_stage, optional: true)
         validate_array(:enabled_release_stages, "non-empty strings", optional: true, &method(:valid_string?))
-        validate_boolean(:use_managed_quota, optional: false)
         valid_endpoint = validate_endpoint
 
         # if the endpoint is invalid then we shouldn't attempt to send traces
@@ -72,16 +71,6 @@ module BugsnagPerformance
         end
       end
 
-      def validate_boolean(name, optional:)
-        value = @configuration.send(name)
-
-        if (value.nil? && optional) || value == true || value == false
-          @valid_configuration.send("#{name}=", value)
-        else
-          @messages << "#{name} should be a boolean, got #{value.inspect}"
-        end
-      end
-
       def validate_array(name, description, optional:, &block)
         value = @configuration.send(name)
 

data/lib/bugsnag_performance/internal/delivery.rb

@@ -3,6 +3,8 @@
 module BugsnagPerformance
   module Internal
     class Delivery
+      attr_reader :uri
+
       def initialize(configuration)
         @uri = URI(configuration.endpoint)
         @common_headers = {

data/lib/bugsnag_performance/internal/payload_encoder.rb

@@ -26,14 +26,9 @@ module BugsnagPerformance
         :SPAN_STATUS_UNSET,
         :SPAN_STATUS_ERROR
 
-      def initialize(sampler)
-        @sampler = sampler
-      end
-
       def encode(span_data)
         {
           resourceSpans: span_data
-            .filter { |span| @sampler.resample_span?(span) }
             .group_by(&:resource)
             .map do |resource, scope_spans|
               {

data/lib/bugsnag_performance/internal/probability_attribute_span_processor.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module BugsnagPerformance
+  module Internal
+    class ProbabilityAttributeSpanProcessor
+      def initialize(probability_manager)
+        @probability_manager = probability_manager
+      end
+
+      def on_start(span, parent_context)
+        # avoid overwriting the attribute if the sampler has already set it
+        if span.attributes.nil? || span.attributes["bugsnag.sampling.p"].nil?
+          span.set_attribute("bugsnag.sampling.p", @probability_manager.probability)
+        end
+
+        OpenTelemetry::SDK::Trace::Export::SUCCESS
+      end
+
+      def on_finish(span)
+        OpenTelemetry::SDK::Trace::Export::SUCCESS
+      end
+
+      def force_flush(timeout: nil)
+        OpenTelemetry::SDK::Trace::Export::SUCCESS
+      end
+
+      def shutdown(timeout: nil)
+        OpenTelemetry::SDK::Trace::Export::SUCCESS
+      end
+    end
+  end
+end

data/lib/bugsnag_performance/internal/span_exporter.rb

@@ -7,36 +7,67 @@ module BugsnagPerformance
         logger,
         probability_manager,
         delivery,
+        sampler,
         payload_encoder,
         sampling_header_encoder
       )
         @logger = logger
         @probability_manager = probability_manager
         @delivery = delivery
+        @sampler = sampler
         @payload_encoder = payload_encoder
         @sampling_header_encoder = sampling_header_encoder
         @disabled = false
+        @unmanaged_mode = false
+        @logged_first_batch_destination = false
       end
 
       def disable!
         @disabled = true
       end
 
+      def unmanaged_mode!
+        @unmanaged_mode = true
+      end
+
+      def unmanaged_mode?
+        @unmanaged_mode
+      end
+
       def export(span_data, timeout: nil)
         return OpenTelemetry::SDK::Trace::Export::SUCCESS if @disabled
 
         with_timeout(timeout) do
+          # ensure we're in the correct managed or unmanaged mode
+          maybe_enter_unmanaged_mode
+          managed_status = unmanaged_mode? ? "unmanaged" : "managed"
+
           headers = {}
-          sampling_header = @sampling_header_encoder.encode(span_data)
 
-          if sampling_header.nil?
-            @logger.warn("One or more spans are missing the 'bugsnag.sampling.p' attribute. This trace will be sent as 'unmanaged'.")
-          else
-            headers["Bugsnag-Span-Sampling"] = sampling_header
+          # resample the spans and attach the Bugsnag-Span-Sampling header only
+          # if we're in managed mode
+          unless unmanaged_mode?
+            span_data = span_data.filter { |span| @sampler.resample_span?(span) }
+
+            sampling_header = @sampling_header_encoder.encode(span_data)
+
+            if sampling_header.nil?
+              @logger.warn("One or more spans are missing the 'bugsnag.sampling.p' attribute. This trace will be sent as unmanaged")
+              managed_status = "unmanaged"
+            else
+              headers["Bugsnag-Span-Sampling"] = sampling_header
+            end
           end
 
           body = JSON.generate(@payload_encoder.encode(span_data))
 
+          # log whether we're sending managed or unmanaged spans on the first
+          # batch only
+          unless @logged_first_batch_destination
+            @logger.info("Sending #{managed_status} spans to #{@delivery.uri}")
+            @logged_first_batch_destination = true
+          end
+
           response = @delivery.deliver(headers, body)
 
           if response.sampling_probability
@@ -64,6 +95,18 @@ module BugsnagPerformance
 
       private
 
+      def maybe_enter_unmanaged_mode
+        # we're in unmanaged mode already so don't need to do anything
+        return if unmanaged_mode?
+
+        # our sampler is in use so we're in managed mode
+        return if OpenTelemetry.tracer_provider.sampler.is_a?(Sampler)
+
+        # the user has changed the sampler from ours to a custom one; enter
+        # unmanaged mode
+        unmanaged_mode!
+      end
+
       def with_timeout(timeout, &block)
         if timeout.nil?
           block.call

data/lib/bugsnag_performance/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BugsnagPerformance
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/bugsnag_performance.rb

@@ -23,6 +23,7 @@ require_relative "bugsnag_performance/internal/probability_manager"
 require_relative "bugsnag_performance/internal/configuration_validator"
 require_relative "bugsnag_performance/internal/sampling_header_encoder"
 require_relative "bugsnag_performance/internal/nil_errors_configuration"
+require_relative "bugsnag_performance/internal/probability_attribute_span_processor"
 
 module BugsnagPerformance
   def self.configure(&block)
@@ -45,10 +46,17 @@ module BugsnagPerformance
       configuration.logger,
       probability_manager,
       delivery,
-      Internal::PayloadEncoder.new(sampler),
+      sampler,
+      Internal::PayloadEncoder.new,
       Internal::SamplingHeaderEncoder.new,
     )
 
+    # enter unmanaged mode if the OTel sampler environment variable has been set
+    # note: we assume any value means a non-default sampler will be used because
+    #       we don't control what the valid values are
+    user_has_custom_sampler = ENV.key?("OTEL_TRACES_SAMPLER")
+    exporter.unmanaged_mode! if user_has_custom_sampler
+
     if configuration.enabled_release_stages && !configuration.enabled_release_stages.include?(configuration.release_stage)
       configuration.logger.info("Not exporting spans as the current release stage is not in the enabled release stages.")
       exporter.disable!
@@ -76,10 +84,18 @@ module BugsnagPerformance
       otel_configurator.add_span_processor(
         OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(exporter)
       )
+
+      # ensure the "bugsnag.sampling.p" attribute is set on all spans even when
+      # our sampler is not in use
+      otel_configurator.add_span_processor(
+        Internal::ProbabilityAttributeSpanProcessor.new(probability_manager)
+      )
     end
 
-    # use our sampler
-    OpenTelemetry.tracer_provider.sampler = sampler
+    # don't use our sampler if the user has configured a sampler via the OTel
+    # environment variable
+    # note: the user can still replace our sampler with their own after this
+    OpenTelemetry.tracer_provider.sampler = sampler unless user_has_custom_sampler
 
     return_value
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag_performance
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - BugSnag
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-21 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -84,6 +84,7 @@ files:
 - lib/bugsnag_performance/internal/logger_wrapper.rb
 - lib/bugsnag_performance/internal/nil_errors_configuration.rb
 - lib/bugsnag_performance/internal/payload_encoder.rb
+- lib/bugsnag_performance/internal/probability_attribute_span_processor.rb
 - lib/bugsnag_performance/internal/probability_fetcher.rb
 - lib/bugsnag_performance/internal/probability_manager.rb
 - lib/bugsnag_performance/internal/sampler.rb
@@ -99,7 +100,7 @@ metadata:
   homepage_uri: https://www.bugsnag.com
   source_code_uri: https://github.com/bugsnag/bugsnag-ruby-performance
   bug_tracker_uri: https://github.com/bugsnag/bugsnag-ruby-performance/issues
-  changelog_uri: https://github.com/bugsnag/bugsnag-ruby-performance/blob/v0.1.0/CHANGELOG.md
+  changelog_uri: https://github.com/bugsnag/bugsnag-ruby-performance/blob/v0.2.0/CHANGELOG.md
   documentation_uri: https://docs.bugsnag.com/performance/integration-guides/ruby/
   rubygems_mfa_required: 'true'
 post_install_message: