cw-datadog 2.23.0.2

data/lib/datadog/tracing/contrib/excon/middleware.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+require 'excon'
+
+require_relative '../../../core'
+require_relative '../../metadata/ext'
+require_relative '../http'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative '../http_annotation_helper'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Excon
+        # Middleware implements an excon-middleware for datadog instrumentation
+        class Middleware < ::Excon::Middleware::Base
+          include Contrib::HttpAnnotationHelper
+
+          def initialize(stack, options = {})
+            super(stack)
+            @default_options = datadog_configuration.options_hash.merge(options)
+          end
+
+          def request_call(datum)
+            begin
+              unless datum.key?(:datadog_span)
+                @options = build_request_options!(datum)
+                span = Tracing.trace(Ext::SPAN_REQUEST)
+                trace = Tracing.active_trace
+                datum[:datadog_span] = span
+                annotate!(span, datum)
+                if Tracing::Distributed::PropagationPolicy.enabled?(
+                  global_config: @options,
+                  trace: trace
+                )
+                  propagate!(trace, span, datum)
+                end
+
+                span
+              end
+            rescue => e
+              Datadog.logger.debug(e.message)
+            end
+
+            @stack.request_call(datum)
+          end
+
+          def response_call(datum)
+            @stack.response_call(datum).tap do |d|
+              handle_response(d)
+            end
+          end
+
+          def error_call(datum)
+            handle_response(datum)
+            @stack.error_call(datum)
+          end
+
+          # Returns a child class of this trace middleware
+          # With options given as defaults.
+          def self.with(options = {})
+            Class.new(self) do
+              @options = options
+
+              # rubocop:disable Style/TrivialAccessors
+              def self.options
+                @options
+              end
+              # rubocop:enable Style/TrivialAccessors
+
+              # default_options in this case contains our specific middleware options
+              # so we want it to take precedence in build_request_options
+              def build_request_options!(datum)
+                datadog_configuration(datum[:host]).options_hash.merge(@default_options)
+              end
+
+              def initialize(stack)
+                super(stack, self.class.options)
+              end
+            end
+          end
+
+          # Returns a copy of the default stack with the trace middleware injected
+          def self.around_default_stack
+            ::Excon.defaults[:middlewares].dup.tap do |default_stack|
+              # If the default stack contains a version of the trace middleware already...
+              existing_trace_middleware = default_stack.find { |m| m <= Middleware }
+              default_stack.delete(existing_trace_middleware) if existing_trace_middleware
+
+              # Inject after the ResponseParser middleware
+              response_middleware_index = default_stack.index(::Excon::Middleware::ResponseParser).to_i
+              default_stack.insert(response_middleware_index + 1, self)
+            end
+          end
+
+          private
+
+          def analytics_enabled?
+            Contrib::Analytics.enabled?(@options[:analytics_enabled])
+          end
+
+          def analytics_sample_rate
+            @options[:analytics_sample_rate]
+          end
+
+          def distributed_tracing?
+            @options[:distributed_tracing] == true && Tracing.enabled?
+          end
+
+          def on_error
+            @options[:on_error] || Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+          end
+
+          def error_status_codes
+            @options[:error_status_codes]
+          end
+
+          def annotate!(span, datum)
+            span.resource = datum[:method].to_s.upcase
+            span.service = service_name(datum[:host], @options)
+            span.type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
+
+            if @options[:peer_service]
+              span.set_tag(
+                Tracing::Metadata::Ext::TAG_PEER_SERVICE,
+                @options[:peer_service]
+              )
+            end
+
+            # Tag original global service name if not used
+            if span.service != Datadog.configuration.service
+              span.set_tag(Tracing::Contrib::Ext::Metadata::TAG_BASE_SERVICE, Datadog.configuration.service)
+            end
+
+            span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
+
+            span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+            span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
+
+            span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, datum[:host])
+
+            # Set analytics sample rate
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+            span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_URL, datum[:path])
+            span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, datum[:method].to_s.upcase)
+            span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, datum[:host])
+            span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, datum[:port])
+            span.set_tags(
+              Datadog.configuration.tracing.header_tags.request_tags(
+                Core::Utils::Hash::CaseInsensitiveWrapper.new(datum[:headers])
+              )
+            )
+
+            Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
+          end
+
+          def handle_response(datum)
+            if datum.key?(:datadog_span)
+              datum[:datadog_span].tap do |span|
+                return span if span.finished?
+
+                if datum.key?(:response)
+                  response = datum[:response]
+                  if error_status_codes.include? response[:status]
+                    span.set_error(["Error #{response[:status]}", response[:body]])
+                  end
+                  span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, response[:status])
+
+                  span.set_tags(
+                    Datadog.configuration.tracing.header_tags.response_tags(
+                      Core::Utils::Hash::CaseInsensitiveWrapper.new(response[:headers])
+                    )
+                  )
+                end
+                on_error.call(span, datum[:error]) if datum.key?(:error)
+                span.finish
+                datum.delete(:datadog_span)
+              end
+            end
+          rescue => e
+            Datadog.logger.debug(e.message)
+          end
+
+          def propagate!(trace, span, datum)
+            Contrib::HTTP.inject(trace, datum[:headers])
+          end
+
+          def build_request_options!(datum)
+            @default_options.merge(datadog_configuration(datum[:host]).options_hash)
+          end
+
+          def datadog_configuration(host = :default)
+            Datadog.configuration.tracing[:excon, host]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/excon/patcher.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Excon
+        # Patcher enables patching of 'excon' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            require_relative 'middleware'
+            add_middleware
+          end
+
+          def add_middleware
+            ::Excon.defaults[:middlewares] = Middleware.around_default_stack
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/ext.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      # Contrib specific constants
+      module Ext
+        # @public_api
+        module DB
+          # Name of the database. This is *not* the database hostname.
+          #
+          # For databases which support such a concept, the default schema/database/namespace
+          # as configured in the connection string.
+          #
+          # If the tracer is already tracking changes to the default schema/database throughout the lifetime of
+          # the session (i.e. the client executes USE {NEW_SCHEMA} and now the default schema has changed from what
+          # was set upon connection initialization), then ideally this attribute reflects the “current” value.
+          # If the tracer is not already tracking changes then just leaving it to the default value set upon
+          # initialization is OK.
+          #
+          # This is the equivalent of OTel’s `db.namespace`
+          # @see https://opentelemetry.io/docs/specs/semconv/database/database-spans/#common-attributes
+          TAG_INSTANCE = 'db.instance'
+
+          TAG_USER = 'db.user'
+          TAG_SYSTEM = 'db.system'
+          TAG_STATEMENT = 'db.statement'
+          TAG_ROW_COUNT = 'db.row_count'
+          PEER_SERVICE_SOURCES = [TAG_INSTANCE,
+            Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
+            Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,].freeze
+        end
+
+        module RPC
+          TAG_SYSTEM = 'rpc.system'
+          TAG_SERVICE = 'rpc.service'
+          TAG_METHOD = 'rpc.method'
+          PEER_SERVICE_SOURCES = [TAG_SERVICE,
+            Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
+            Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,].freeze
+          module GRPC
+            TAG_STATUS_CODE = 'rpc.grpc.status_code'
+            TAG_FULL_METHOD = 'rpc.grpc.full_method'
+          end
+        end
+
+        module Messaging
+          TAG_SYSTEM = 'messaging.system'
+          TAG_DESTINATION = 'messaging.destination'
+          PEER_SERVICE_SOURCES = [Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
+            Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,].freeze
+        end
+
+        module Metadata
+          # Name of tag from which where peer.service information was extracted from
+          TAG_PEER_SERVICE_SOURCE = '_dd.peer.service.source'
+
+          # Value of tag from which peer.service value was remapped from
+          TAG_PEER_SERVICE_REMAP = '_dd.peer.service.remapped_from'
+
+          # Set equal to the global service when contrib span.service is overriden
+          TAG_BASE_SERVICE = '_dd.base_service'
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/extensions.rb

@@ -0,0 +1,255 @@
+# frozen_string_literal: true
+
+require 'set'
+
+require_relative '../../core/configuration/settings'
+
+# Datadog
+module Datadog
+  # Datadog tracing
+  module Tracing
+    module Contrib
+      # Extensions that can be added to the base library
+      # Adds registry, configuration access for integrations.
+      #
+      # DEV: The Registry should probably be part of the core tracer
+      # as it represents a global tracer repository that is strongly intertwined
+      # with the tracer lifecycle and deeply modifies the tracer initialization
+      # process.
+      # Most of this file should probably live inside the tracer core.
+      module Extensions
+        def self.extend!
+          Datadog.singleton_class.prepend Helpers
+          Datadog.singleton_class.prepend Configuration
+
+          # DEV: We want settings to only apply to the `tracing` subgroup.
+          #      Until we have a better API of accessing that settings class,
+          #      we have to dig into it like this.
+          settings_class = Core::Configuration::Settings.options[:tracing].default.call.class
+          settings_class.include(Configuration::Settings)
+        end
+
+        # Helper methods for Datadog module.
+        module Helpers
+          # The global integration registry.
+          #
+          # This registry holds a reference to all integrations available
+          # to the tracer.
+          #
+          # Integrations registered in the {.registry} can be activated as follows:
+          #
+          # ```
+          # Datadog.configure do |c|
+          #   c.tracing.instrument :my_registered_integration, **my_options
+          # end
+          # ```
+          #
+          # New integrations can be registered by implementing the {Datadog::Tracing::Contrib::Integration} interface.
+          #
+          # @return [Datadog::Tracing::Contrib::Registry]
+          # @!attribute [r] registry
+          # @public_api
+          def registry
+            Contrib::REGISTRY
+          end
+        end
+
+        # Configuration methods for Datadog module.
+        module Configuration
+          # TODO: Is is not possible to separate this configuration method
+          # TODO: from core datadog parts ()e.g. the registry).
+          # TODO: Today this method sits here in the `Datadog::Tracing::Contrib::Extensions` namespace
+          # TODO: but cannot empirically constraints to the contrib domain only.
+          # TODO: We should promote most of this logic to core parts of datadog.
+          def configure(&block)
+            # Reconfigure core settings
+            super
+
+            # Activate integrations
+            configuration = self.configuration.tracing
+
+            if configuration.respond_to?(:integrations_pending_activation)
+              ignore_integration_load_errors = if configuration.respond_to?(:ignore_integration_load_errors?)
+                configuration.ignore_integration_load_errors?
+              else
+                false
+              end
+
+              configuration.integrations_pending_activation.each do |integration|
+                next unless integration.respond_to?(:patch)
+
+                # integration.patch returns either true or a hash of details on why patching failed
+                patch_results = integration.patch
+
+                next if patch_results == true
+
+                # if patching failed, only log output if verbosity is unset
+                # or if patching failure is due to compatibility or integration specific reasons
+                next if ignore_integration_load_errors &&
+                  (!patch_results[:available] || !patch_results[:loaded] ||
+                  (patch_results[:compatible] && patch_results[:patchable]))
+
+                desc = "Available?: #{patch_results[:available]}"
+                desc += ", Loaded? #{patch_results[:loaded]}"
+                desc += ", Compatible? #{patch_results[:compatible]}"
+                desc += ", Patchable? #{patch_results[:patchable]}"
+
+                Datadog.logger.warn("Unable to patch #{patch_results[:name]} (#{desc})")
+              end
+
+              # Only notify telemetry if it's initialized
+              components.telemetry&.integrations_change! if configuration.integrations_pending_activation
+
+              configuration.integrations_pending_activation.clear
+            end
+
+            configuration
+          end
+
+          # Extensions for Datadog::Core::Configuration::Settings
+          # @public_api
+          module Settings
+            InvalidIntegrationError = Class.new(StandardError)
+
+            # Used to avoid concurrency issues between registering integrations (e.g. mutation) and reporting the
+            # current integrations for logging/debugging/telemetry purposes (e.g. iteration) in the
+            # `@instrumented_integrations` hash.
+            #
+            # See https://github.com/DataDog/dd-trace-rb/issues/2851 for details on the original issue.
+            INSTRUMENTED_INTEGRATIONS_LOCK = Mutex.new
+
+            def self.included(base)
+              base.class_eval do
+                settings :contrib do
+                  # Key-value map for explicitly re-mapping peer.service values
+                  #
+                  # @default `DD_TRACE_PEER_SERVICE_MAPPING` environment variable converted to hash
+                  # @return [Hash]
+                  option :peer_service_mapping do |o|
+                    o.env Tracing::Configuration::Ext::SpanAttributeSchema::ENV_PEER_SERVICE_MAPPING
+                    o.type :hash
+                    o.default({})
+                  end
+
+                  # Enables population of default in the `peer.service` span tag.
+                  # Explicitly setting the `peer.service` for an integration will
+                  # still be honored with this option disabled.
+                  #
+                  # Also when disabled, other peer service related configurations have no effect.
+                  #
+                  # @default `DD_TRACE_PEER_SERVICE_DEFAULTS_ENABLED` environment variable, otherwise `false`
+                  # @return [Boolean]
+                  option :peer_service_defaults do |o|
+                    o.env Tracing::Configuration::Ext::SpanAttributeSchema::ENV_PEER_SERVICE_DEFAULTS_ENABLED
+                    o.type :bool
+                    o.default false
+                  end
+
+                  # Global service name behavior
+                  settings :global_default_service_name do
+                    # Overrides default service name to global service name
+                    #
+                    # Allows for usage of v1 service name changes without
+                    # being forced to update schema versions
+                    #
+                    # @default `DD_TRACE_REMOVE_INTEGRATION_SERVICE_NAMES_ENABLED` environment variable, otherwise `false`
+                    # @return [Boolean]
+                    option :enabled do |o|
+                      o.env Tracing::Configuration::Ext::SpanAttributeSchema::ENV_GLOBAL_DEFAULT_SERVICE_NAME_ENABLED
+                      o.type :bool
+                      o.default false
+                    end
+                  end
+                end
+              end
+            end
+
+            # Applies instrumentation for the provided `integration_name`.
+            #
+            # Options may be provided, that are specific to that instrumentation.
+            # See the instrumentation's settings file for a list of available options.
+            #
+            # @example
+            #   Datadog.configure { |c| c.tracing.instrument :integration_name }
+            # @example
+            #   Datadog.configure { |c| c.tracing.instrument :integration_name, option_key: :option_value }
+            # @param [Symbol] integration_name the integration name
+            # @param [Hash] options the integration-specific configuration settings
+            # @return [Datadog::Tracing::Contrib::Integration]
+            def instrument(integration_name, options = {}, &block)
+              integration = fetch_integration(integration_name)
+
+              unless integration.nil? || !integration.default_configuration.enabled
+                configuration_name = options[:describes] || :default
+                filtered_options = options.reject { |k, _v| k == :describes }
+                integration.configure(configuration_name, filtered_options, &block)
+                INSTRUMENTED_INTEGRATIONS_LOCK.synchronize do
+                  @instrumented_integrations ||= {}
+                  @instrumented_integrations[integration_name] = integration
+                end
+
+                # Add to activation list
+                integrations_pending_activation << integration
+              end
+
+              integration
+            end
+
+            # For the provided `integration_name`, resolves a matching configuration
+            # for the provided integration from an integration-specific `key`.
+            #
+            # How the matching is performed is integration-specific.
+            #
+            # @example
+            #   Datadog.configuration.tracing[:integration_name]
+            # @example
+            #   Datadog.configuration.tracing[:integration_name][:sub_configuration]
+            # @param [Symbol] integration_name the integration name
+            # @param [Object] key the integration-specific lookup key
+            # @return [Datadog::Tracing::Contrib::Configuration::Settings]
+            def [](integration_name, key = :default)
+              integration = fetch_integration(integration_name)
+              integration&.resolve(key)
+            end
+
+            # @!visibility private
+            def integrations_pending_activation
+              @integrations_pending_activation ||= Set.new
+            end
+
+            # This method is only for logging/debugging/telemetry purposes (e.g. iteration) in the
+            # `@instrumented_integrations` hash.
+            # @!visibility private
+            def instrumented_integrations
+              INSTRUMENTED_INTEGRATIONS_LOCK.synchronize { (@instrumented_integrations&.dup || {}).freeze }
+            end
+
+            # @!visibility private
+            def reset!
+              INSTRUMENTED_INTEGRATIONS_LOCK.synchronize { @instrumented_integrations&.clear }
+              super
+            end
+
+            # @!visibility private
+            def fetch_integration(name)
+              Contrib::REGISTRY[name] ||
+                raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
+            end
+
+            # @!visibility private
+            def ignore_integration_load_errors?
+              defined?(@ignore_integration_load_errors) ? @ignore_integration_load_errors == true : false
+            end
+
+            def ignore_integration_load_errors=(value)
+              @ignore_integration_load_errors = value
+            end
+          end
+        end
+      end
+    end
+  end
+
+  # Load built-in Datadog integrations
+  Tracing::Contrib::Extensions.extend!
+end

data/lib/datadog/tracing/contrib/faraday/configuration/settings.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative '../../configuration/settings'
+require_relative '../../status_range_matcher'
+require_relative '../../status_range_env_parser'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        module Configuration
+          # Custom settings for the Faraday integration
+          # @public_api
+          class Settings < Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+
+            # @!visibility private
+            option :analytics_enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ANALYTICS_ENABLED
+              o.default false
+            end
+
+            option :analytics_sample_rate do |o|
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
+            end
+
+            option :distributed_tracing, default: true, type: :bool
+
+            option :on_error do |o|
+              o.type :proc, nilable: true
+            end
+
+            option :error_status_codes do |o|
+              o.env Ext::ENV_ERROR_STATUS_CODES
+              o.setter do |value|
+                if value.nil?
+                  # Fallback to global config, which is defaulted to client (400..499) + server (500..599)
+                  # DEV-3.0: `faraday` is a client library, this should fall back to `http_error_statuses.client` only.
+                  # We cannot change it without causing a breaking change.
+                  client_global_error_statuses = Datadog.configuration.tracing.http_error_statuses.client
+                  server_global_error_statuses = Datadog.configuration.tracing.http_error_statuses.server
+                  client_global_error_statuses + server_global_error_statuses
+                else
+                  Tracing::Contrib::StatusRangeMatcher.new(value)
+                end
+              end
+              o.env_parser do |v|
+                Tracing::Contrib::StatusRangeEnvParser.call(v) if v
+              end
+            end
+
+            option :split_by_domain, default: false, type: :bool
+
+            option :service_name do |o|
+              o.type :string, nilable: true
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
+            end
+
+            option :peer_service do |o|
+              o.type :string, nilable: true
+              o.env Ext::ENV_PEER_SERVICE
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/faraday/connection.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        # Handles installation of our middleware if the user has *not*
+        # already explicitly configured our middleware for this correction.
+        #
+        # Wraps Faraday::Connection#initialize:
+        # https://github.com/lostisland/faraday/blob/ff9dc1d1219a1bbdba95a9a4cf5d135b97247ee2/lib/faraday/connection.rb#L62-L92
+        module Connection
+          def initialize(*args, &block)
+            super.tap do
+              use(:datadog_tracing) unless builder.handlers.any? { |h| h.klass == Middleware }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/faraday/ext.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        # Faraday integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_FARADAY_ENABLED'
+          ENV_SERVICE_NAME = 'DD_TRACE_FARADAY_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_FARADAY_PEER_SERVICE'
+          ENV_ERROR_STATUS_CODES = 'DD_TRACE_FARADAY_ERROR_STATUS_CODES'
+
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_FARADAY_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_FARADAY_ANALYTICS_SAMPLE_RATE'
+          DEFAULT_PEER_SERVICE_NAME = 'faraday'
+          SPAN_REQUEST = 'faraday.request'
+          TAG_COMPONENT = 'faraday'
+          TAG_OPERATION_REQUEST = 'request'
+          PEER_SERVICE_SOURCES = [
+            Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
+            Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,
+          ].freeze
+        end
+      end
+    end
+  end
+end