cw-datadog 2.23.0.2

data/lib/datadog/kit/identity.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require_relative '../appsec/instrumentation/gateway/argument'
+
+module Datadog
+  module Kit
+    # Tracking identity via traces
+    module Identity
+      class << self
+        # Attach user information to the trace
+        #
+        # @param trace [TraceOperation] Trace to attach data to. Defaults to
+        #   active trace.
+        # @param span [SpanOperation] Span to attach data to. Defaults to
+        #   active span on trace. Note that this should be a service entry span.
+        #   When AppSec is enabled, the expected span and trace are automatically
+        #   used as defaults.
+        # @param id [String] Mandatory. Username or client id extracted
+        #   from the access token or Authorization header in the inbound request
+        #   from outside the system.
+        # @param email [String] Email of the authenticated user associated
+        #   to the trace.
+        # @param name [String] User-friendly name. To be displayed in the
+        #   UI if set.
+        # @param session_id [String] Session ID of the authenticated user.
+        # @param role [String] Actual/assumed role the client is making
+        #   the request under extracted from token or application security
+        #   context.
+        # @param scope [String] Scopes or granted authorities the client
+        #   currently possesses extracted from token or application security
+        #   context. The value would come from the scope associated with an OAuth
+        #   2.0 Access Token or an attribute value in a SAML 2.0 Assertion.
+        # @param others [Hash<Symbol, String>] Additional free-form
+        #   user information to attach to the trace.
+        #
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/PerceivedComplexity
+        def set_user(
+          trace = nil, span = nil, id:, email: nil, name: nil, session_id: nil, role: nil, scope: nil, **others
+        )
+          raise ArgumentError, 'missing required key: :id' if id.nil?
+
+          # enforce types
+
+          raise TypeError, ':id must be a String' unless id.is_a?(String)
+          raise TypeError, ':email must be a String' unless email.nil? || email.is_a?(String)
+          raise TypeError, ':name must be a String' unless name.nil? || name.is_a?(String)
+          raise TypeError, ':session_id must be a String' unless session_id.nil? || session_id.is_a?(String)
+          raise TypeError, ':role must be a String' unless role.nil? || role.is_a?(String)
+          raise TypeError, ':scope must be a String' unless scope.nil? || scope.is_a?(String)
+
+          others.each do |k, v|
+            raise TypeError, "#{k.inspect} must be a String" unless v.nil? || v.is_a?(String)
+          end
+
+          set_trace_and_span_context('set_user', trace, span) do |_active_trace, active_span|
+            # set tags once data is known consistent
+            active_span.set_tag('usr.id', id)
+            active_span.set_tag('usr.email', email) unless email.nil?
+            active_span.set_tag('usr.name', name) unless name.nil?
+            active_span.set_tag('usr.session_id', session_id) unless session_id.nil?
+            active_span.set_tag('usr.role', role) unless role.nil?
+            active_span.set_tag('usr.scope', scope) unless scope.nil?
+
+            others.each do |k, v|
+              active_span.set_tag("usr.#{k}", v) unless v.nil?
+            end
+
+            if Datadog::AppSec.active_context
+              active_span.set_tag('_dd.appsec.user.collection_mode', 'sdk')
+
+              user = ::Datadog::AppSec::Instrumentation::Gateway::User.new(id, others[:login], session_id)
+              ::Datadog::AppSec::Instrumentation.gateway.push('identity.set_user', user)
+            end
+          end
+        end
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/PerceivedComplexity
+        # rubocop:enable Metrics/CyclomaticComplexity
+
+        private
+
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/PerceivedComplexity
+        def set_trace_and_span_context(method, trace = nil, span = nil)
+          if (appsec_context = Datadog::AppSec.active_context)
+            trace = appsec_context.trace
+            span = appsec_context.span
+          end
+
+          trace ||= Datadog::Tracing.active_trace
+          span ||= trace&.active_span || Datadog::Tracing.active_span
+
+          unless trace && span
+            Datadog.logger.debug(
+              "Tracing not enabled. Method ##{method} is a no-op. Please enable tracing if you want ##{method}" \
+              ' to track this events'
+            )
+            return
+          end
+
+          raise ArgumentError, "span #{span.id} does not belong to trace #{trace.id}" if trace.id != span.trace_id
+
+          yield(trace, span)
+        end
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/PerceivedComplexity
+        # rubocop:enable Metrics/CyclomaticComplexity
+      end
+    end
+  end
+end

data/lib/datadog/kit.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Datadog
+  # Datadog::Kit holds public-facing APIs for higher level user-facing
+  # features, these features not belonging to a specific product. Contrary to
+  # Datadog::Core, Kit depends on products.
+  module Kit
+  end
+end
+
+require_relative 'kit/identity'

data/lib/datadog/opentelemetry/api/baggage.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative 'trace/span'
+require_relative '../../tracing/trace_operation'
+require_relative '../trace'
+
+module Datadog
+  module OpenTelemetry
+    module API
+      # The Baggage module provides an implementation of the OpenTelemetry Baggage API.
+      #
+      # Baggage is a set of name/value pairs describing user-defined properties that can be
+      # propagated through a distributed trace. This implementation follows the W3C Baggage
+      # specification and the OpenTelemetry Baggage API.
+      #
+      # @see https://www.w3.org/TR/baggage/
+      # @see https://opentelemetry.io/docs/specs/otel/baggage/api/
+      module Baggage
+        def initialize(trace: nil)
+          @trace = trace
+        end
+
+        # Returns a new context with empty baggage
+        #
+        # @param [optional Context] context Context to clear baggage from. Defaults
+        # to ::OpenTelemetry::Context.current
+        # @return [Context]
+        def clear(context: ::OpenTelemetry::Context.current)
+          context.ensure_trace.baggage.clear
+          context
+        end
+
+        # Returns the corresponding value for key
+        #
+        # @param [String] key The lookup key
+        # @param [optional Context] context The context from which to retrieve
+        # the key. Defaults to ::OpenTelemetry::Context.current
+        # @return [String, nil]
+        def value(key, context: ::OpenTelemetry::Context.current)
+          trace = context.ensure_trace
+          return nil if trace.nil?
+
+          trace.baggage && trace.baggage[key]
+        end
+
+        # Returns all baggage values
+        #
+        # @param [optional Context] context The context from which to retrieve
+        # the baggage. Defaults to ::OpenTelemetry::Context.current
+        # @return [Hash<String, String>]
+        def values(context: ::OpenTelemetry::Context.current)
+          trace = context.ensure_trace
+          return {} if trace.nil?
+
+          trace.baggage ? trace.baggage.dup : {}
+        end
+
+        # Returns a new context with new key-value pair
+        #
+        # @param [String] key The key to store this value under
+        # @param [String] value String value to be stored under key
+        # @param [optional String] metadata This is here to store properties
+        # received from other W3C Baggage implementations but is not exposed in
+        # OpenTelemetry. This is considered private API and not for use by
+        # end-users.
+        # @param [optional Context] context The context to update with new
+        # value. Defaults to ::OpenTelemetry::Context.current
+        # @return [Context]
+        def set_value(key, value, metadata: nil, context: ::OpenTelemetry::Context.current)
+          # Delegate to the context to set the value because an active trace is not guaranteed
+          # set_values handles this logic
+          context.set_values({::OpenTelemetry::Baggage.const_get(:BAGGAGE_KEY) => {key => value}})
+        end
+
+        # Returns a new context with value at key removed
+        #
+        # @param [String] key The key to remove
+        # @param [optional Context] context The context to remove baggage
+        # from. Defaults to ::OpenTelemetry::Context.current
+        # @return [Context]
+        def remove_value(key, context: ::OpenTelemetry::Context.current)
+          # Delegate to the context to remove the value because an active trace is not guaranteed
+          # set_values handles this logic
+          context.set_values({Context::BAGGAGE_REMOVE_KEY => key})
+        end
+        ::OpenTelemetry::Baggage.singleton_class.prepend(self)
+      end
+    end
+  end
+end

data/lib/datadog/opentelemetry/api/baggage.rbs

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Datadog
+  module OpenTelemetry
+    module API
+      module Baggage
+        def initialize: (?trace: Datadog::Tracing::TraceOperation?) -> void
+
+        # Returns a new context with empty baggage
+        def clear: (?context: OpenTelemetry::Context) -> OpenTelemetry::Context
+
+        # Returns the corresponding value for key
+        def value: (String key, ?context: OpenTelemetry::Context) -> String?
+
+        # Returns all baggage values
+        def values: (?context: OpenTelemetry::Context) -> Hash[String, String]
+
+        # Returns a new context with key-value pair
+        def set_value: (String key, String value, ?metadata: String?, ?context: OpenTelemetry::Context) -> OpenTelemetry::Context
+
+        # Returns a new context with value at key removed
+        def remove_value: (String key, ?context: OpenTelemetry::Context) -> OpenTelemetry::Context
+      end
+    end
+  end
+end 

data/lib/datadog/opentelemetry/api/context.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+require_relative 'trace/span'
+require_relative '../../tracing/trace_operation'
+require_relative '../trace'
+
+module Datadog
+  module OpenTelemetry
+    module API
+      # The OpenTelemetry Context contains a key-value store that can be attached
+      # to a trace.
+      #
+      # It loosely matches our `TraceOperations#tags`, except for the following:
+      # * Context can store arbitrary objects as values. One example is for the key
+      #   `Context::Key.new('current-span')`, which is associated with a `Span` object.
+      #   In contrast, `TraceOperations#tags` only stores string values.
+      # * Context is how spans know who their parent span is. The parenting operation happens on every
+      #   span created. Parenting is not directly tied to the active Fiber or Thread.
+      # * Context is immutable: changing a value creates a copy of Context.
+      # * Context is not bound to a specific trace: it can be reused an arbitrary number of times.
+      module Context
+        CURRENT_SPAN_KEY = ::OpenTelemetry::Trace.const_get(:CURRENT_SPAN_KEY)
+        private_constant :CURRENT_SPAN_KEY
+        BAGGAGE_REMOVE_KEY = Object.new # sentinel object to indicate the deletion of a value in baggage
+
+        def initialize(entries, trace: nil, baggage: nil)
+          @trace = trace || ::Datadog::Tracing.send(:tracer).send(:start_trace)
+          @trace.otel_values.merge!(entries) if entries
+          @trace.otel_context ||= self
+          @trace.baggage = baggage if baggage
+        end
+
+        # Because Context can be reused, we have to make sure we have
+        # a valid `TraceOperation` on every invocation.
+        def ensure_trace
+          return nil unless @trace
+
+          # The Context can be reused after the root span has finished.
+          @trace.send(:reset) if @trace.finished?
+          @trace
+        end
+
+        # Returns the corresponding value (or nil) for key
+        #
+        # @param [Key] key The lookup key
+        # @return [Object]
+        def value(key)
+          return nil unless @trace
+
+          @trace.otel_value(key)
+        end
+
+        # `alias` performed to match {::OpenTelemetry::Context} aliasing upstream
+        alias [] value # rubocop:disable Style/Alias
+
+        # Returns a new Context where entries contains the newly added key and value
+        #
+        # @param [Key] key The key to store this value under
+        # @param [Object] value Object to be stored under key
+        # @return [Context]
+        def set_value(key, value)
+          set_values(key => value)
+        end
+
+        # Returns a new Context with the current context's entries merged with the
+        #   new entries
+        #
+        # @param [Hash] values The values to be merged with the current context's
+        #   entries.
+        # @param [Object] value Object to be stored under key
+        # @return [Context]
+        def set_values(values)
+          if (current_span = values[CURRENT_SPAN_KEY]) && current_span.datadog_trace
+            # Because `#set_value` returns new context, we have to create
+            # a new copy of the active trace to ensure there's no conflict with
+            # other users of the active trace.
+            # It effectively becomes an internal trace propagation.
+            trace = Datadog::OpenTelemetry::Trace.start_trace_copy(
+              current_span.datadog_trace,
+              parent_span: current_span.datadog_span
+            )
+          end
+
+          existing_values = @trace&.otel_values || {}
+          existing_baggage = @trace&.baggage || {}
+
+          # Retrieve the baggage removal sentinel and remove it from the values hash
+          existing_baggage.delete(values[BAGGAGE_REMOVE_KEY]) if values.key?(BAGGAGE_REMOVE_KEY)
+
+          # If the values hash contains a BAGGAGE_KEY, merge its contents with existing baggage
+          # Otherwise, keep the existing baggage unchanged
+          new_baggage = if values.key?(::OpenTelemetry::Baggage.const_get(:BAGGAGE_KEY))
+            existing_baggage.merge(values[::OpenTelemetry::Baggage.const_get(:BAGGAGE_KEY)])
+          else
+            existing_baggage
+          end
+
+          ::OpenTelemetry::Context.new(existing_values.merge(values), trace: trace, baggage: new_baggage)
+        end
+
+        # The Datadog {TraceOperation} associated with this {Context}.
+        def trace
+          @trace
+        end
+
+        # Singleton class methods for {Context}
+        module SingletonClass
+          # Returns current context, which is never nil
+          #
+          # @return [Context]
+          def current
+            trace = Tracing.active_trace
+            return ::OpenTelemetry::Context::ROOT unless trace
+
+            trace.otel_context ||= ::OpenTelemetry::Context.from_trace(trace)
+          end
+
+          # Associates a Context with the caller's current Fiber. Every call to
+          # this operation should be paired with a corresponding call to detach.
+          #
+          # Returns a token to be used with the matching call to detach
+          #
+          # @param [Context] context The new context
+          # @return [Object] A token to be used when detaching
+          def attach(context)
+            previous_trace = Tracing.active_trace
+            continue_trace!(context)
+
+            stack.push(previous_trace&.otel_context || ::OpenTelemetry::Context::ROOT)
+            stack.size
+          end
+
+          # Restores the previous Context associated with the current Fiber.
+          # The supplied token is used to check if the call to detach is balanced
+          # with a corresponding attach call. A warning is logged if the
+          # calls are unbalanced.
+          #
+          # @param [Object] token The token provided by the matching call to attach
+          # @return [Boolean] True if the calls matched, false otherwise
+          def detach(token)
+            s = stack
+            calls_matched = (token == s.size)
+            unless calls_matched
+              ::OpenTelemetry.handle_error(
+                exception: ::OpenTelemetry::Context::DetachError.new(
+                  'calls to detach should match corresponding calls to attach.'
+                )
+              )
+            end
+
+            previous_context = s.pop
+            continue_trace!(previous_context)
+            calls_matched
+          end
+
+          # Part of the OpenTelemetry public API for {Context}.
+          def clear
+            super
+            tracer = Tracing.send(:tracer)
+            tracer.send(:call_context).activate!(nil)
+          end
+
+          # Creates a new {Context} associated with a {TraceOperation}.
+          def from_trace(trace)
+            new({}, trace: trace)
+          end
+
+          private
+
+          def continue_trace!(context, &block)
+            call_context = Tracing.send(:tracer).send(:call_context)
+            if context&.trace
+              call_context.activate!(context.ensure_trace, &block)
+            else
+              call_context.activate!(nil)
+            end
+          end
+        end
+
+        def self.prepended(base)
+          base.singleton_class.prepend(SingletonClass)
+        end
+
+        ::OpenTelemetry::Context.prepend(self)
+      end
+
+      # OpenTelemetry-specific {TraceOperation} features.
+      #
+      # These extensions providing matching between {TraceOperation}
+      # and OpenTelemetry {Context}.
+      module TraceOperation
+        attr_accessor :otel_context
+
+        # Stores values from Context#entries
+        def otel_value(key)
+          otel_values[key]
+        end
+
+        # Retrieves values for Context#entries
+        def otel_values
+          @otel_values ||= {}
+        end
+
+        Tracing::TraceOperation.include(self)
+      end
+    end
+  end
+end

data/lib/datadog/opentelemetry/api/trace/span.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Datadog
+  module OpenTelemetry
+    module Trace
+      # Stores associated Datadog entities to the OpenTelemetry Span.
+      module Span
+        attr_accessor :datadog_trace, :datadog_span
+
+        ::OpenTelemetry::Trace::Span.prepend(self)
+      end
+    end
+  end
+end

data/lib/datadog/opentelemetry/sdk/configurator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'span_processor'
+require_relative 'id_generator'
+require_relative 'propagator'
+
+module Datadog
+  module OpenTelemetry
+    module SDK
+      # The Configurator is responsible for setting wiring up
+      # different OpenTelemetry requirements together.
+      # Some of the requirements will be changed to Datadog versions.
+      module Configurator
+        def initialize
+          super
+          @id_generator = IdGenerator
+        end
+
+        # Ensure Datadog-configure propagation styles have are applied when configured.
+        #
+        # DEV: Support configuring propagation through the environment variable
+        # DEV: `OTEL_PROPAGATORS`, alias to `DD_TRACE_PROPAGATION_STYLE`
+        def configure_propagation
+          @propagators = [Propagator.new(Tracing::Contrib::HTTP)]
+          super
+        end
+
+        # Ensure Datadog-configure trace writer is configured.
+        def wrapped_exporters_from_env
+          [SpanProcessor.new]
+        end
+
+        ::OpenTelemetry::SDK::Configurator.prepend(self)
+      end
+    end
+  end
+end

data/lib/datadog/opentelemetry/sdk/id_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Datadog
+  module OpenTelemetry
+    module SDK
+      # Generates Datadog-compatible IDs for OpenTelemetry traces.
+      # OpenTelemetry traces already produce Datadog-compatible IDs.
+      class IdGenerator
+        class << self
+          include ::OpenTelemetry::Trace
+
+          # Generates a valid trace identifier, a 16-byte string with at least one
+          # non-zero byte.
+          #
+          # @return [String] a valid trace ID.
+          def generate_trace_id
+            loop do
+              id = Random.bytes(8) # DEV: Change to 16 (16*8-byte) when 128-bit trace_id is supported.
+              return id unless id == ::OpenTelemetry::Trace::INVALID_SPAN_ID
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/opentelemetry/sdk/propagator.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Datadog
+  module OpenTelemetry
+    module SDK
+      # Compatibility wrapper to allow Datadog propagators to fulfill the
+      # OpenTelemetry propagator API.
+      class Propagator
+        def initialize(datadog_propagator)
+          @datadog_propagator = datadog_propagator
+        end
+
+        def inject(
+          carrier, context: ::OpenTelemetry::Context.current,
+          setter: ::OpenTelemetry::Context::Propagation.text_map_setter
+        )
+          unless setter == ::OpenTelemetry::Context::Propagation.text_map_setter
+            # PENDING: Not to report telemetry logs for now
+            Datadog.logger.error(
+              'Custom setter is not supported. Please inform the `datadog` team at ' \
+            ' https://github.com/DataDog/dd-trace-rb of your use case so we can best support you. Using the default ' \
+            'OpenTelemetry::Context::Propagation.text_map_setter as a fallback setter.'
+            )
+          end
+
+          @datadog_propagator.inject(context.trace.to_digest, carrier)
+        end
+
+        def extract(
+          carrier, context: ::OpenTelemetry::Context.current,
+          getter: ::OpenTelemetry::Context::Propagation.text_map_getter
+        )
+          if getter != ::OpenTelemetry::Context::Propagation.text_map_getter &&
+              getter != ::OpenTelemetry::Common::Propagation.rack_env_getter
+            # PENDING: Not to report telemetry logs for now
+            Datadog.logger.error(
+              "Custom getter #{getter} is not supported. Please inform the `datadog` team at " \
+            ' https://github.com/DataDog/dd-trace-rb of your use case so we can best support you. Using the default ' \
+            'OpenTelemetry::Context::Propagation.text_map_getter as a fallback getter.'
+            )
+          end
+
+          digest = @datadog_propagator.extract(carrier)
+          return context unless digest
+
+          # Converts the {Numeric} Datadog id object to OpenTelemetry's byte array format.
+          # 128-bit unsigned, big-endian integer
+          trace_id = [digest.trace_id >> 64, digest.trace_id & 0xFFFFFFFFFFFFFFFF].pack('Q>Q>')
+          # 64-bit unsigned, big-endian integer
+          span_id = [digest.span_id].pack('Q>')
+
+          if digest.trace_state || digest.trace_flags
+            trace_flags = ::OpenTelemetry::Trace::TraceFlags.from_byte(digest.trace_flags)
+            tracestate = Tracing::Distributed::TraceContext.new(fetcher: nil).send(:build_tracestate, digest)
+          else
+            trace_flags = if Tracing::Sampling::PrioritySampler.sampled?(digest.trace_sampling_priority)
+              ::OpenTelemetry::Trace::TraceFlags::SAMPLED
+            else
+              ::OpenTelemetry::Trace::TraceFlags::DEFAULT
+            end
+            tracestate = ::OpenTelemetry::Trace::Tracestate::DEFAULT
+          end
+
+          span_context = ::OpenTelemetry::Trace::SpanContext.new(
+            trace_id: trace_id,
+            span_id: span_id,
+            trace_flags: trace_flags,
+            tracestate: tracestate,
+            remote: true
+          )
+
+          span = ::OpenTelemetry::Trace.non_recording_span(span_context)
+
+          trace = Tracing.continue_trace!(digest)
+
+          span.datadog_trace = trace
+
+          ::OpenTelemetry::Trace.context_with_span(span, parent_context: context)
+        end
+
+        # Returns fields set by this propagator.
+        # DEV: Doesn't seem like it's used in production Otel code paths.
+        def fields
+          []
+        end
+      end
+    end
+  end
+end