cw-datadog 2.23.0.2

data/lib/datadog/tracing/contrib/ethon/easy_patch.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+require_relative '../../../core/utils/hash'
+require_relative '../../metadata/ext'
+require_relative '../http'
+require_relative 'ext'
+require_relative '../http_annotation_helper'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Ethon
+        # Ethon EasyPatch
+        module EasyPatch
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # InstanceMethods - implementing instrumentation
+          module InstanceMethods
+            include Contrib::HttpAnnotationHelper
+
+            def http_request(url, action_name, options = {})
+              load_datadog_configuration_for(url)
+              return super unless Tracing.enabled?
+
+              # It's tricky to get HTTP method from libcurl
+              @datadog_method = action_name.to_s.upcase
+              super
+            end
+
+            def headers=(headers)
+              # Store headers to call this method again when span is ready
+              @datadog_original_headers = headers
+              super
+            end
+
+            def perform
+              load_datadog_configuration_for(url)
+              return super unless Tracing.enabled?
+
+              datadog_before_request
+              super
+            end
+
+            def complete
+              return super unless Tracing.enabled?
+
+              begin
+                response_options = mirror.options
+                response_code = (response_options[:response_code] || response_options[:code]).to_i
+                if response_code.zero?
+                  return_code = response_options[:return_code]
+                  message = return_code ? ::Ethon::Curl.easy_strerror(return_code) : 'unknown reason'
+                  set_span_error_message("Request has failed: #{message}")
+                else
+                  @datadog_span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, response_code)
+                  # DEV-3.0: This was previously checking against a 500..599 range.
+                  # To not introduce breaking change, this was changed to use `http_error_statuses.server`,
+                  # but `ethon` is a client library, this check should use `http_error_statuses.client` instead.
+                  if Datadog.configuration.tracing.http_error_statuses.server.include?(response_code)
+                    set_span_error_message("Request has failed with HTTP error: #{response_code}")
+                  end
+                end
+
+                @datadog_span.set_tags(
+                  Datadog.configuration.tracing.header_tags.response_tags(
+                    Core::Utils::Hash::CaseInsensitiveWrapper.new(parse_response_headers)
+                  )
+                )
+              ensure
+                @datadog_span.finish
+                @datadog_span = nil
+              end
+              super
+            end
+
+            def reset
+              super
+            ensure
+              @datadog_span = nil
+              @datadog_method = nil
+              @datadog_original_headers = nil
+              @datadog_configuration = nil
+            end
+
+            # Starts or retrieves the already started Easy request span.
+            #
+            # When tracing in Multi request context, child spans for each Easy
+            # request are created early, and then finished as their HTTP response
+            # becomes available. Because many Easy requests are open at the same time,
+            # many Datadog::Tracing::Spans are also open at the same time. To avoid each separate
+            # Easy request becoming the parented to the previous open request we set
+            # the +parent_span+ parameter with the parent Multi span. This correctly
+            # assigns all open Easy spans to the currently executing Multi context.
+            #
+            # @param [Datadog::Tracing::Span] continue_from the Multi span, if executing in a Multi context.
+            def datadog_before_request(continue_from: nil)
+              load_datadog_configuration_for(url)
+
+              trace_options = continue_from ? {continue_from: continue_from} : {}
+              uri = try_parse_uri
+
+              @datadog_span = Tracing.trace(
+                Ext::SPAN_REQUEST,
+                service: uri ? service_name(uri.host, datadog_configuration) : datadog_configuration[:service_name],
+                type: Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND,
+                **trace_options
+              )
+              datadog_trace = Tracing.active_trace
+
+              datadog_tag_request
+
+              if Tracing::Distributed::PropagationPolicy.enabled?(
+                global_config: datadog_configuration,
+                trace: datadog_trace
+              )
+                @datadog_original_headers ||= {}
+                Contrib::HTTP.inject(datadog_trace, @datadog_original_headers)
+                self.headers = @datadog_original_headers
+              end
+            end
+
+            def datadog_span_started?
+              instance_variable_defined?(:@datadog_span) && !@datadog_span.nil?
+            end
+
+            private
+
+            attr_reader :datadog_configuration
+
+            def datadog_tag_request
+              span = @datadog_span
+              method = Ext::NOT_APPLICABLE_METHOD
+              method = @datadog_method.to_s if instance_variable_defined?(:@datadog_method) && !@datadog_method.nil?
+              span.resource = method
+
+              if datadog_configuration[:peer_service]
+                span.set_tag(
+                  Tracing::Metadata::Ext::TAG_PEER_SERVICE,
+                  datadog_configuration[: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
+
+              # Set analytics sample rate
+              Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+              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_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
+
+              uri = try_parse_uri
+              return unless uri
+
+              span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_URL, uri.path)
+              span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, method)
+              span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, uri.host)
+              span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, uri.port)
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, uri.host)
+
+              if @datadog_original_headers
+                span.set_tags(
+                  Datadog.configuration.tracing.header_tags.request_tags(
+                    Core::Utils::Hash::CaseInsensitiveWrapper.new(@datadog_original_headers)
+                  )
+                )
+              end
+
+              Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
+            end
+
+            def set_span_error_message(message)
+              # Sets span error from message, in case there is no exception available
+              @datadog_span.status = Tracing::Metadata::Ext::Errors::STATUS
+              @datadog_span.set_tag(Tracing::Metadata::Ext::Errors::TAG_MSG, message)
+            end
+
+            # rubocop:disable Lint/SuppressedException
+            def try_parse_uri
+              URI.parse(url)
+            rescue URI::InvalidURIError
+            end
+            # rubocop:enable Lint/SuppressedException
+
+            def load_datadog_configuration_for(host = :default)
+              @datadog_configuration = Datadog.configuration.tracing[:ethon, host]
+            end
+
+            def analytics_enabled?
+              Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+            end
+
+            def analytics_sample_rate
+              datadog_configuration[:analytics_sample_rate]
+            end
+
+            # `#response_headers` returns a "\n" concatenated String containing:
+            # * The HTTP Status-Line.
+            # * The response headers.
+            # * A trailing "\n".
+            #
+            # This method extracts only the headers from it.
+            def parse_response_headers
+              return {} if response_headers.empty?
+
+              lines = response_headers.split("\n")
+
+              lines = lines[1..(lines.size - 1)] # Remove Status-Line and trailing whitespace.
+
+              # Find only well-behaved HTTP headers.
+              lines.map do |line|
+                header = line.split(':', 2)
+                (header.size != 2) ? nil : header
+              end.compact.to_h
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Ethon
+        # Ethon integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_ETHON_ENABLED'
+          ENV_SERVICE_NAME = 'DD_TRACE_ETHON_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_ETHON_PEER_SERVICE'
+
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ETHON_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ETHON_ANALYTICS_SAMPLE_RATE'
+          DEFAULT_PEER_SERVICE_NAME = 'ethon'
+          SPAN_REQUEST = 'ethon.request'
+          SPAN_MULTI_REQUEST = 'ethon.multi.request'
+          NOT_APPLICABLE_METHOD = 'N/A'
+          TAG_COMPONENT = 'ethon'
+          TAG_OPERATION_REQUEST = 'request'
+          TAG_OPERATION_MULTI_REQUEST = 'multi.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

data/lib/datadog/tracing/contrib/ethon/integration.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative '../configuration/resolvers/pattern_resolver'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Ethon
+        # Description of Ethon integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('0.11.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :ethon
+
+          def self.version
+            Gem.loaded_specs['ethon']&.version
+          end
+
+          def self.loaded?
+            !defined?(::Ethon::Easy).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+
+          def resolver
+            @resolver ||= Contrib::Configuration::Resolvers::PatternResolver.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/ethon/multi_patch.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative '../../metadata/ext'
+require_relative '../http'
+require_relative 'ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Ethon
+        # Ethon MultiPatch
+        module MultiPatch
+          def self.included(base)
+            # No need to prepend here since add method is included into Multi class
+            base.include(InstanceMethods)
+          end
+
+          # InstanceMethods - implementing instrumentation
+          module InstanceMethods
+            def add(easy)
+              handles = super
+              return handles unless handles && Tracing.enabled?
+
+              if datadog_multi_performing?
+                # Start Easy span in case Multi is already performing
+                easy.datadog_before_request(continue_from: datadog_multi_trace_digest)
+              end
+              handles
+            end
+
+            def perform
+              if Tracing.enabled?
+                easy_handles.each do |easy|
+                  easy.datadog_before_request(continue_from: datadog_multi_trace_digest) unless easy.datadog_span_started?
+                end
+              end
+              super
+            ensure
+              if Tracing.enabled? && datadog_multi_performing?
+                @datadog_multi_span.finish
+                @datadog_multi_span = nil
+                @datadog_multi_trace_digest = nil
+              end
+            end
+
+            private
+
+            def datadog_multi_performing?
+              instance_variable_defined?(:@datadog_multi_span) && !@datadog_multi_span.nil?
+            end
+
+            def datadog_multi_trace_digest
+              return unless datadog_multi_span
+
+              @datadog_multi_trace_digest
+            end
+
+            def datadog_multi_span
+              return @datadog_multi_span if datadog_multi_performing?
+
+              @datadog_multi_span = Tracing.trace(
+                Ext::SPAN_MULTI_REQUEST,
+                service: datadog_configuration[:service_name]
+              )
+              @datadog_multi_trace_digest = Tracing.active_trace.to_digest
+
+              @datadog_multi_span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              @datadog_multi_span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_MULTI_REQUEST)
+
+              @datadog_multi_span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
+
+              # Tag original global service name if not used
+              if @datadog_multi_span.service != Datadog.configuration.service
+                @datadog_multi_span.set_tag(
+                  Tracing::Contrib::Ext::Metadata::TAG_BASE_SERVICE,
+                  Datadog.configuration.service
+                )
+              end
+
+              # Set analytics sample rate
+              Contrib::Analytics.set_sample_rate(@datadog_multi_span, analytics_sample_rate) if analytics_enabled?
+
+              @datadog_multi_span
+            end
+
+            def datadog_configuration
+              Datadog.configuration.tracing[:ethon]
+            end
+
+            def analytics_enabled?
+              Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+            end
+
+            def analytics_sample_rate
+              datadog_configuration[:analytics_sample_rate]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative '../patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Ethon
+        # Patcher enables patching of 'ethon' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            require_relative 'easy_patch'
+            require_relative 'multi_patch'
+
+            ::Ethon::Easy.include(EasyPatch)
+            ::Ethon::Multi.include(MultiPatch)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative '../../../span_operation'
+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 Excon
+        module Configuration
+          # Custom settings for the Excon 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: `excon` 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/excon/ext.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Excon
+        # Excon integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_EXCON_ENABLED'
+          ENV_SERVICE_NAME = 'DD_TRACE_EXCON_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_EXCON_PEER_SERVICE'
+
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_EXCON_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_EXCON_ANALYTICS_SAMPLE_RATE'
+          ENV_ERROR_STATUS_CODES = 'DD_TRACE_EXCON_ERROR_STATUS_CODES'
+          DEFAULT_PEER_SERVICE_NAME = 'excon'
+          SPAN_REQUEST = 'excon.request'
+          TAG_COMPONENT = 'excon'
+          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

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative '../configuration/resolvers/pattern_resolver'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Excon
+        # Description of Excon integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('0.50.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :excon
+
+          def self.version
+            Gem.loaded_specs['excon']&.version
+          end
+
+          def self.loaded?
+            !defined?(::Excon).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+
+          def resolver
+            @resolver ||= Contrib::Configuration::Resolvers::PatternResolver.new
+          end
+        end
+      end
+    end
+  end
+end