sentry-opentelemetry 6.3.1 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87748e3599ae6d335e57798ba09e0c6aca8949bbded34605968dd4d7e38d4377
-  data.tar.gz: 7d88f8af58505b4239ac68deaddd7a9c9eccc18d6e3db40100254a890a5a7b3c
+  metadata.gz: daa7a9bda91b8495497e7f2d8df45011f9a69b436156ec15e1d03bc6631b8b06
+  data.tar.gz: c3d64746ab277a28c149e9aaeb1a4c6e80aa9379f13cdc3a004845cac7dd8edd
 SHA512:
-  metadata.gz: 8339b7661c0372bd195f600a676a77781fb999009b730aed3a804814500933544e48b6e2d8881c5254756e7900284b9dc7f0861d2f91fb08a62729bcf77ce77a
-  data.tar.gz: ecf2bf87d9a91e361fcfc7843c7501e67630b010a733a7bc75d624abefe0c3531608154d9ee0ee89f4849e748b5f03766063d7f10b5da86c0193c6c2d17016ee
+  metadata.gz: cf620bf63c5f2164bac179a53890d59b08f702d8c648337794a693d9da4f8c8f2bd2d7e88a2e19ddc7ca7adc229327ad25ba892719988350a2a0e5bd5909bb38
+  data.tar.gz: f542e467b5245b2d30198baeddcd001a716170e79aa91d68cd136787717a2e65c751b6fcbc805464318b76a9309528806388d166e1fd46e699c96245865dfe95

data/lib/sentry/opentelemetry/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "sentry/opentelemetry/otlp_setup"
+
+module Sentry
+  class Configuration
+    # OTLP related configuration.
+    # @return [OTLP::Configuration]
+    attr_reader :otlp
+
+    after(:initialize) do
+      @otlp = OTLP::Configuration.new
+    end
+
+    after(:configured) do
+      Sentry::OpenTelemetry::OTLPSetup.setup(self) if otlp.enabled
+    end
+  end
+
+  module OTLP
+    class Configuration
+      attr_accessor :enabled
+      attr_accessor :setup_otlp_traces_exporter
+      attr_accessor :setup_propagator
+
+      def initialize
+        @enabled = false
+        @setup_otlp_traces_exporter = true
+        @setup_propagator = true
+      end
+    end
+  end
+end

data/lib/sentry/opentelemetry/otlp_propagator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Sentry
+  module OpenTelemetry
+    class OTLPPropagator < Propagator
+      def inject(
+        carrier,
+        context: ::OpenTelemetry::Context.current,
+        setter: ::OpenTelemetry::Context::Propagation.text_map_setter
+      )
+        span_context = ::OpenTelemetry::Trace.current_span(context).context
+        return unless span_context.valid?
+
+        setter.set(carrier, SENTRY_TRACE_HEADER_NAME, to_sentry_trace(span_context))
+
+        baggage = context[SENTRY_BAGGAGE_KEY]
+        if baggage.is_a?(Sentry::Baggage)
+          baggage_string = baggage.serialize
+          setter.set(carrier, BAGGAGE_HEADER_NAME, baggage_string) unless baggage_string&.empty?
+        end
+      end
+
+      private
+
+      def to_sentry_trace(span_context)
+        sampled = span_context.trace_flags.sampled? ? "1" : "0"
+        "#{span_context.hex_trace_id}-#{span_context.hex_span_id}-#{sampled}"
+      end
+    end
+  end
+end

data/lib/sentry/opentelemetry/otlp_setup.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+#
+require "sentry/opentelemetry/otlp_propagator"
+
+module Sentry
+  module OpenTelemetry
+    module OTLPSetup
+      USER_AGENT = "sentry-ruby.otlp/#{Sentry::VERSION}"
+
+      class << self
+        def setup(config)
+          @dsn = config.dsn
+          @sdk_logger = config.sdk_logger
+          log_debug("[OTLP] Setting up OTLP integration")
+
+          setup_external_propagation_context
+          setup_otlp_exporter if config.otlp.setup_otlp_traces_exporter
+          setup_sentry_propagator if config.otlp.setup_propagator
+        end
+
+        private
+
+        def log_debug(message)
+          @sdk_logger&.debug(message)
+        end
+
+        def log_warn(message)
+          @sdk_logger&.warn(message)
+        end
+
+        def setup_external_propagation_context
+          log_debug("[OTLP] Setting up trace linking for all events")
+
+          Sentry.register_external_propagation_context do
+            span_context = ::OpenTelemetry::Trace.current_span.context
+            span_context.valid? ? [span_context.hex_trace_id, span_context.hex_span_id] : nil
+          end
+        end
+
+        def setup_otlp_exporter
+          return unless @dsn
+
+          log_debug("[OTLP] Setting up OTLP exporter")
+
+          begin
+            require "opentelemetry/exporter/otlp"
+          rescue LoadError
+            log_warn("[OTLP] opentelemetry-exporter-otlp gem is not installed. " \
+                     "Please add it to your Gemfile to use the OTLP exporter.")
+            return
+          end
+
+          endpoint = "#{@dsn.server}#{@dsn.otlp_traces_endpoint}"
+          auth_header = @dsn.generate_auth_header(client: USER_AGENT)
+
+          log_debug("[OTLP] Sending traces to #{endpoint}")
+
+          exporter = ::OpenTelemetry::Exporter::OTLP::Exporter.new(
+            endpoint: endpoint,
+            headers: { "X-Sentry-Auth" => auth_header }
+          )
+
+          span_processor = ::OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(exporter)
+          ::OpenTelemetry.tracer_provider.add_span_processor(span_processor)
+        end
+
+        def setup_sentry_propagator
+          log_debug("[OTLP] Setting up propagator for distributed tracing")
+          ::OpenTelemetry.propagation = OTLPPropagator.new
+        end
+      end
+    end
+  end
+end

data/lib/sentry/opentelemetry/version.rb

@@ -2,6 +2,6 @@
 
 module Sentry
   module OpenTelemetry
-    VERSION = "6.3.1"
+    VERSION = "6.4.0"
   end
 end

data/lib/sentry-opentelemetry.rb

@@ -6,3 +6,4 @@ require "opentelemetry-sdk"
 require "sentry/opentelemetry/version"
 require "sentry/opentelemetry/span_processor"
 require "sentry/opentelemetry/propagator"
+require "sentry/opentelemetry/configuration"

data/sentry-opentelemetry.gemspec

@@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "sentry-ruby", "~> 6.3.1"
+  spec.add_dependency "sentry-ruby", "~> 6.4.0"
   spec.add_dependency "opentelemetry-sdk", "~> 1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-opentelemetry
 version: !ruby/object:Gem::Version
-  version: 6.3.1
+  version: 6.4.0
 platform: ruby
 authors:
 - Sentry Team
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.3.1
+        version: 6.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.3.1
+        version: 6.4.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -55,19 +55,22 @@ files:
 - bin/console
 - bin/setup
 - lib/sentry-opentelemetry.rb
+- lib/sentry/opentelemetry/configuration.rb
+- lib/sentry/opentelemetry/otlp_propagator.rb
+- lib/sentry/opentelemetry/otlp_setup.rb
 - lib/sentry/opentelemetry/propagator.rb
 - lib/sentry/opentelemetry/span_processor.rb
 - lib/sentry/opentelemetry/version.rb
 - sentry-opentelemetry.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/6.3.1/sentry-opentelemetry
+homepage: https://github.com/getsentry/sentry-ruby/tree/6.4.0/sentry-opentelemetry
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/6.3.1/sentry-opentelemetry
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/6.3.1/sentry-opentelemetry
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/6.3.1/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/6.4.0/sentry-opentelemetry
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/6.4.0/sentry-opentelemetry
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/6.4.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-opentelemetry/6.3.1
+  documentation_uri: http://www.rubydoc.info/gems/sentry-opentelemetry/6.4.0
 rdoc_options: []
 require_paths:
 - lib