ddtrace 0.54.0 → 1.1.0

data/lib/datadog/kit/identity.rb

@@ -0,0 +1,63 @@
+# typed: false
+
+module Datadog
+  module Kit
+    # Tracking identity via traces
+    module Identity
+      # Attach user information to the trace
+      #
+      # @param trace [TraceOperation] Trace to attach data to.
+      # @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<String || Symbol, String>] Additional free-form
+      #   user information to attach to the trace.
+      #
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      def self.set_user(trace, 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 tags once data is known consistent
+
+        trace.set_tag('usr.id', id)
+        trace.set_tag('usr.email', email)           unless email.nil?
+        trace.set_tag('usr.name', name)             unless name.nil?
+        trace.set_tag('usr.session_id', session_id) unless session_id.nil?
+        trace.set_tag('usr.role', role)             unless role.nil?
+        trace.set_tag('usr.scope', scope)           unless scope.nil?
+
+        others.each do |k, v|
+          trace.set_tag("usr.#{k}", v) unless v.nil?
+        end
+      end
+      # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity
+    end
+  end
+end

data/lib/datadog/kit.rb

@@ -0,0 +1,11 @@
+# typed: false
+
+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 'datadog/kit/identity'

data/lib/datadog/opentracer/binary_propagator.rb

@@ -0,0 +1,26 @@
+# typed: true
+
+module Datadog
+  module OpenTracer
+    # OpenTracing propagator for Datadog::OpenTracer::Tracer
+    module BinaryPropagator
+      extend Propagator
+
+      # Inject a SpanContext into the given carrier
+      #
+      # @param span_context [SpanContext]
+      # @param carrier [Carrier] A carrier object of Binary type
+      def self.inject(span_context, carrier)
+        nil
+      end
+
+      # Extract a SpanContext in Binary format from the given carrier.
+      #
+      # @param carrier [Carrier] A carrier object of Binary type
+      # @return [SpanContext, nil] the extracted SpanContext or nil if none could be found
+      def self.extract(carrier)
+        SpanContext::NOOP_INSTANCE
+      end
+    end
+  end
+end

data/lib/datadog/opentracer/carrier.rb

@@ -0,0 +1,9 @@
+# typed: strict
+
+module Datadog
+  module OpenTracer
+    # @public_api
+    class Carrier < ::OpenTracing::Carrier
+    end
+  end
+end

data/lib/datadog/opentracer/distributed_headers.rb

@@ -0,0 +1,58 @@
+# typed: true
+
+require 'datadog/tracing/span'
+require 'datadog/tracing/distributed/headers/ext'
+
+module Datadog
+  module OpenTracer
+    # DistributedHeaders provides easy access and validation to headers
+    # @public_api
+    class DistributedHeaders
+      include Tracing::Distributed::Headers::Ext
+
+      def initialize(carrier)
+        @carrier = carrier
+      end
+
+      def valid?
+        # Sampling priority is optional.
+        !trace_id.nil? && !parent_id.nil?
+      end
+
+      def trace_id
+        id HTTP_HEADER_TRACE_ID
+      end
+
+      def parent_id
+        id HTTP_HEADER_PARENT_ID
+      end
+
+      def sampling_priority
+        hdr = @carrier[HTTP_HEADER_SAMPLING_PRIORITY]
+        # It's important to make a difference between no header,
+        # and a header defined to zero.
+        return unless hdr
+
+        value = hdr.to_i
+        return if value < 0
+
+        value
+      end
+
+      def origin
+        hdr = @carrier[HTTP_HEADER_ORIGIN]
+        # Only return the value if it is not an empty string
+        hdr if hdr != ''
+      end
+
+      private
+
+      def id(header)
+        value = @carrier[header].to_i
+        return if value.zero? || value >= Datadog::Tracing::Span::EXTERNAL_MAX_ID
+
+        value < 0 ? value + 0x1_0000_0000_0000_0000 : value
+      end
+    end
+  end
+end

data/lib/datadog/opentracer/global_tracer.rb

@@ -0,0 +1,17 @@
+# typed: true
+
+module Datadog
+  module OpenTracer
+    # Patch for OpenTracing module
+    module GlobalTracer
+      def global_tracer=(tracer)
+        super.tap do
+          if tracer.class <= Datadog::OpenTracer::Tracer
+            # Update the Datadog global tracer, too.
+            Datadog.configure { |c| c.tracing.instance = tracer.datadog_tracer }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/opentracer/propagator.rb

@@ -0,0 +1,26 @@
+# typed: false
+
+module Datadog
+  module OpenTracer
+    # OpenTracing propagator for Datadog::OpenTracer::Tracer
+    # @abstract
+    # @public_api
+    module Propagator
+      # Inject a SpanContext into the given carrier
+      #
+      # @param span_context [SpanContext]
+      # @param carrier [Carrier] A carrier object of the type dictated by the specified `format`
+      def inject(span_context, carrier)
+        raise NotImplementedError
+      end
+
+      # Extract a SpanContext in the given format from the given carrier.
+      #
+      # @param carrier [Carrier] A carrier object of the type dictated by the specified `format`
+      # @return [SpanContext, nil] the extracted SpanContext or nil if none could be found
+      def extract(carrier)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/datadog/opentracer/rack_propagator.rb

@@ -0,0 +1,72 @@
+# typed: true
+
+require 'datadog/tracing/context'
+require 'datadog/tracing/distributed/headers/ext'
+require 'datadog/tracing/propagation/http'
+require 'datadog/tracing/trace_operation'
+require 'datadog/opentracer/propagator'
+
+module Datadog
+  module OpenTracer
+    # OpenTracing propagator for Datadog::OpenTracer::Tracer
+    module RackPropagator
+      extend Propagator
+      extend Tracing::Distributed::Headers::Ext
+      include Tracing::Distributed::Headers::Ext
+
+      BAGGAGE_PREFIX = 'ot-baggage-'.freeze
+      BAGGAGE_PREFIX_FORMATTED = 'HTTP_OT_BAGGAGE_'.freeze
+
+      class << self
+        # Inject a SpanContext into the given carrier
+        #
+        # @param span_context [SpanContext]
+        # @param carrier [Carrier] A carrier object of Rack type
+        def inject(span_context, carrier)
+          active_trace = span_context.datadog_context.active_trace
+
+          # Inject Datadog trace properties
+          Tracing::Propagation::HTTP.inject!(active_trace, carrier)
+
+          # Inject baggage
+          span_context.baggage.each do |key, value|
+            carrier[BAGGAGE_PREFIX + key] = value
+          end
+
+          nil
+        end
+
+        # Extract a SpanContext in Rack format from the given carrier.
+        #
+        # @param carrier [Carrier] A carrier object of Rack type
+        # @return [SpanContext, nil] the extracted SpanContext or nil if none could be found
+        def extract(carrier)
+          # First extract & build a Datadog context
+          datadog_trace_digest = Tracing::Propagation::HTTP.extract(carrier)
+
+          # Then extract any other baggage
+          baggage = {}
+          carrier.each do |key, value|
+            baggage[header_to_baggage(key)] = value if baggage_header?(key)
+          end
+
+          SpanContextFactory.build(
+            datadog_context: nil,
+            datadog_trace_digest: datadog_trace_digest,
+            baggage: baggage
+          )
+        end
+
+        private
+
+        def baggage_header?(header)
+          header.to_s.start_with?(BAGGAGE_PREFIX_FORMATTED)
+        end
+
+        def header_to_baggage(key)
+          key[BAGGAGE_PREFIX_FORMATTED.length, key.length].downcase
+        end
+      end
+    end
+  end
+end

data/lib/datadog/opentracer/scope.rb

@@ -0,0 +1,18 @@
+# typed: true
+
+module Datadog
+  module OpenTracer
+    # OpenTracing adapter for scope
+    # @public_api
+    class Scope < ::OpenTracing::Scope
+      attr_reader \
+        :manager,
+        :span
+
+      def initialize(manager:, span:)
+        @manager = manager
+        @span = span
+      end
+    end
+  end
+end

data/lib/datadog/opentracer/scope_manager.rb

@@ -0,0 +1,9 @@
+# typed: strict
+
+module Datadog
+  module OpenTracer
+    # @public_api
+    class ScopeManager < ::OpenTracing::ScopeManager
+    end
+  end
+end

data/lib/datadog/opentracer/span.rb

@@ -0,0 +1,101 @@
+# typed: true
+
+require 'time'
+
+require 'datadog/tracing/metadata/ext'
+
+module Datadog
+  module OpenTracer
+    # OpenTracing adapter for Datadog::Span
+    # @public_api
+    class Span < ::OpenTracing::Span
+      attr_reader \
+        :datadog_span
+
+      def initialize(datadog_span:, span_context:)
+        @datadog_span = datadog_span
+        @span_context = span_context
+      end
+
+      # Set the name of the operation
+      #
+      # @param [String] name
+      def operation_name=(name)
+        datadog_span.name = name
+      end
+
+      # Span Context
+      #
+      # @return [SpanContext]
+      def context
+        @span_context
+      end
+
+      # Set a tag value on this span
+      # @param key [String] the key of the tag
+      # @param value [String, Numeric, Boolean] the value of the tag. If it's not
+      # a String, Numeric, or Boolean it will be encoded with to_s
+      def set_tag(key, value)
+        # Special cases to convert opentracing tags to datadog tags
+        case key
+        when 'error'
+          # Opentracing supports and `error: <bool>` tag, we need to convert to span status
+          # DEV: Do not return, we want to still set the `error` tag as they requested
+          datadog_span.status = value ? Datadog::Tracing::Metadata::Ext::Errors::STATUS : 0
+        end
+
+        tap { datadog_span.set_tag(key, value) }
+      end
+
+      # Set a baggage item on the span
+      # @param key [String] the key of the baggage item
+      # @param value [String] the value of the baggage item
+      def set_baggage_item(key, value)
+        tap do
+          # SpanContext is immutable, so to make changes
+          # build a new span context.
+          @span_context = SpanContextFactory.clone(
+            span_context: context,
+            baggage: { key => value }
+          )
+        end
+      end
+
+      # Get a baggage item
+      # @param key [String] the key of the baggage item
+      # @return [String] value of the baggage item
+      def get_baggage_item(key)
+        context.baggage[key]
+      end
+
+      # @deprecated Use {#log_kv} instead.
+      # Reason: event is an optional standard log field defined in spec and not required.  Also,
+      # method name {#log_kv} is more consistent with other language implementations such as Python and Go.
+      #
+      # Add a log entry to this span
+      # @param event [String] event name for the log
+      # @param timestamp [Time] time of the log
+      # @param fields [Hash] Additional information to log
+      def log(event: nil, timestamp: Time.now, **fields)
+        super # Log deprecation warning
+
+        # If the fields specify an error
+        datadog_span.set_error(fields[:'error.object']) if fields.key?(:'error.object')
+      end
+
+      # Add a log entry to this span
+      # @param timestamp [Time] time of the log
+      # @param fields [Hash] Additional information to log
+      def log_kv(timestamp: Time.now, **fields)
+        # If the fields specify an error
+        datadog_span.set_error(fields[:'error.object']) if fields.key?(:'error.object')
+      end
+
+      # Finish the {Span}
+      # @param end_time [Time] custom end time, if not now
+      def finish(end_time: Time.now)
+        datadog_span.finish(end_time)
+      end
+    end
+  end
+end

data/lib/datadog/opentracer/span_context.rb

@@ -0,0 +1,19 @@
+# typed: true
+
+module Datadog
+  module OpenTracer
+    # OpenTracing adapter for SpanContext
+    # @public_api
+    class SpanContext < ::OpenTracing::SpanContext
+      attr_reader \
+        :datadog_context,
+        :datadog_trace_digest
+
+      def initialize(datadog_context:, datadog_trace_digest: nil, baggage: {})
+        @datadog_context = datadog_context
+        @datadog_trace_digest = datadog_trace_digest
+        @baggage = baggage.freeze
+      end
+    end
+  end
+end

data/lib/datadog/opentracer/span_context_factory.rb

@@ -0,0 +1,27 @@
+# typed: true
+
+module Datadog
+  module OpenTracer
+    # Creates new Datadog::OpenTracer::SpanContext
+    module SpanContextFactory
+      module_function
+
+      def build(datadog_context:, datadog_trace_digest: nil, baggage: {})
+        SpanContext.new(
+          datadog_context: datadog_context,
+          datadog_trace_digest: datadog_trace_digest,
+          baggage: baggage.dup
+        )
+      end
+
+      def clone(span_context:, baggage: {})
+        SpanContext.new(
+          datadog_context: span_context.datadog_context,
+          datadog_trace_digest: span_context.datadog_trace_digest,
+          # Merge baggage from previous SpanContext
+          baggage: span_context.baggage.merge(baggage)
+        )
+      end
+    end
+  end
+end

data/lib/datadog/opentracer/text_map_propagator.rb

@@ -0,0 +1,87 @@
+# typed: true
+
+require 'datadog/tracing/context'
+require 'datadog/tracing/distributed/headers/ext'
+require 'datadog/tracing/trace_operation'
+require 'datadog/opentracer/propagator'
+
+module Datadog
+  module OpenTracer
+    # OpenTracing propagator for Datadog::OpenTracer::Tracer
+    module TextMapPropagator
+      extend Propagator
+      extend Tracing::Distributed::Headers::Ext
+      include Tracing::Distributed::Headers::Ext
+
+      BAGGAGE_PREFIX = 'ot-baggage-'.freeze
+
+      class << self
+        # Inject a SpanContext into the given carrier
+        #
+        # @param span_context [SpanContext]
+        # @param carrier [Carrier] A carrier object of Rack type
+        def inject(span_context, carrier)
+          # Inject baggage
+          span_context.baggage.each do |key, value|
+            carrier[BAGGAGE_PREFIX + key] = value
+          end
+
+          # Inject Datadog trace properties
+          active_trace = span_context.datadog_context.active_trace
+          digest = active_trace.to_digest if active_trace
+          return unless digest
+
+          carrier[HTTP_HEADER_ORIGIN] = digest.trace_origin
+          carrier[HTTP_HEADER_PARENT_ID] = digest.span_id
+          carrier[HTTP_HEADER_SAMPLING_PRIORITY] = digest.trace_sampling_priority
+          carrier[HTTP_HEADER_TRACE_ID] = digest.trace_id
+
+          nil
+        end
+
+        # Extract a SpanContext in TextMap format from the given carrier.
+        #
+        # @param carrier [Carrier] A carrier object of TextMap type
+        # @return [SpanContext, nil] the extracted SpanContext or nil if none could be found
+        def extract(carrier)
+          # First extract & build a Datadog context
+          headers = DistributedHeaders.new(carrier)
+          datadog_trace_digest = headers_to_trace_digest(headers)
+
+          # Then extract any other baggage
+          baggage = {}
+          carrier.each do |key, value|
+            baggage[item_to_baggage(key)] = value if baggage_item?(key)
+          end
+
+          SpanContextFactory.build(
+            datadog_context: nil,
+            datadog_trace_digest: datadog_trace_digest,
+            baggage: baggage
+          )
+        end
+
+        private
+
+        def headers_to_trace_digest(headers)
+          return unless headers.valid?
+
+          Datadog::Tracing::TraceDigest.new(
+            span_id: headers.parent_id,
+            trace_id: headers.trace_id,
+            trace_origin: headers.origin,
+            trace_sampling_priority: headers.sampling_priority
+          )
+        end
+
+        def baggage_item?(item)
+          item.to_s.start_with?(BAGGAGE_PREFIX)
+        end
+
+        def item_to_baggage(key)
+          key[BAGGAGE_PREFIX.length, key.length]
+        end
+      end
+    end
+  end
+end

data/lib/datadog/opentracer/thread_local_scope.rb

@@ -0,0 +1,34 @@
+# typed: true
+
+module Datadog
+  module OpenTracer
+    # OpenTracing adapter for thread local scopes
+    # @public_api
+    class ThreadLocalScope < Scope
+      attr_reader \
+        :finish_on_close
+
+      def initialize(
+        manager:,
+        span:,
+        finish_on_close: true
+      )
+        super(manager: manager, span: span)
+        @finish_on_close = finish_on_close
+        @previous_scope = manager.active
+      end
+
+      # Mark the end of the active period for the current thread and Scope,
+      # updating the ScopeManager#active in the process.
+      #
+      # NOTE: Calling close more than once on a single Scope instance leads to
+      # undefined behavior.
+      def close
+        return unless equal?(manager.active)
+
+        span.finish if finish_on_close
+        manager.send(:set_scope, @previous_scope)
+      end
+    end
+  end
+end

data/lib/datadog/opentracer/thread_local_scope_manager.rb

@@ -0,0 +1,43 @@
+# typed: true
+
+module Datadog
+  module OpenTracer
+    # OpenTracing adapter for thread local scope management
+    # @public_api
+    class ThreadLocalScopeManager < ScopeManager
+      # Make a span instance active.
+      #
+      # @param span [Span] the Span that should become active
+      # @param finish_on_close [Boolean] whether the Span should automatically be
+      #   finished when Scope#close is called
+      # @return [Scope] instance to control the end of the active period for the
+      #  Span. It is a programming error to neglect to call Scope#close on the
+      #  returned instance.
+      def activate(span, finish_on_close: true)
+        ThreadLocalScope.new(
+          manager: self,
+          span: span,
+          finish_on_close: finish_on_close
+        ).tap do |scope|
+          set_scope(scope)
+        end
+      end
+
+      # @return [Scope] the currently active Scope which can be used to access the
+      # currently active Span.
+      #
+      # If there is a non-null Scope, its wrapped Span becomes an implicit parent
+      # (as Reference#CHILD_OF) of any newly-created Span at Tracer#start_active_span
+      # or Tracer#start_span time.
+      def active
+        Thread.current[object_id.to_s]
+      end
+
+      private
+
+      def set_scope(scope)
+        Thread.current[object_id.to_s] = scope
+      end
+    end
+  end
+end