ddtrace 0.13.0 → 0.47.0

data/lib/ddtrace/contrib/http/integration.rb

@@ -0,0 +1,45 @@
+require 'ddtrace/version'
+
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/http/configuration/settings'
+require 'ddtrace/contrib/configuration/resolvers/pattern_resolver'
+require 'ddtrace/contrib/http/patcher'
+require 'ddtrace/contrib/http/circuit_breaker'
+
+module Datadog
+  module Contrib
+    # HTTP integration
+    module HTTP
+      extend CircuitBreaker
+
+      # Description of HTTP integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Datadog::VERSION::MINIMUM_RUBY_VERSION
+
+        register_as :http, auto_patch: true
+
+        def self.version
+          Gem::Version.new(RUBY_VERSION)
+        end
+
+        def self.loaded?
+          !defined?(::Net::HTTP).nil?
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+
+        def resolver
+          @resolver ||= Contrib::Configuration::Resolvers::PatternResolver.new
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/http/patcher.rb

@@ -1,159 +1,24 @@
-# requirements should be kept minimal as Patcher is a shared requirement.
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/http/ext'
+require 'ddtrace/contrib/http/instrumentation'
 
 module Datadog
   module Contrib
     # Datadog Net/HTTP integration.
     module HTTP
-      URL = 'http.url'.freeze
-      METHOD = 'http.method'.freeze
-      BODY = 'http.body'.freeze
-
-      NAME = 'http.request'.freeze
-      APP = 'net/http'.freeze
-      SERVICE = 'net/http'.freeze
-
-      module_function
-
-      def should_skip_tracing?(req, address, port, transport, pin)
-        # we don't want to trace our own call to the API (they use net/http)
-        # when we know the host & port (from the URI) we use it, else (most-likely
-        # called with a block) rely on the URL at the end.
-        if req.respond_to?(:uri) && req.uri
-          if req.uri.host.to_s == transport.hostname.to_s &&
-             req.uri.port.to_i == transport.port.to_i
-            return true
-          end
-        elsif address && port &&
-              address.to_s == transport.hostname.to_s &&
-              port.to_i == transport.port.to_i
-          return true
-        end
-        # we don't want a "shotgun" effect with two nested traces for one
-        # logical get, and request is likely to call itself recursively
-        active = pin.tracer.active_span()
-        return true if active && (active.name == NAME)
-        false
-      end
-
-      def should_skip_distributed_tracing?(pin)
-        if pin.config && pin.config.key?(:distributed_tracing)
-          return !pin.config[:distributed_tracing]
-        end
-
-        !Datadog.configuration[:http][:distributed_tracing]
-      end
-
       # Patcher enables patching of 'net/http' module.
       module Patcher
-        include Base
-        register_as :http, auto_patch: true
-        option :distributed_tracing, default: false
-        option :service_name, default: SERVICE
-        option :tracer, default: Datadog.tracer
-
-        @patched = false
+        include Contrib::Patcher
 
         module_function
 
-        # patch applies our patch if needed
-        def patch
-          unless @patched
-            begin
-              require 'uri'
-              require 'ddtrace/pin'
-              require 'ddtrace/ext/app_types'
-              require 'ddtrace/ext/http'
-              require 'ddtrace/ext/net'
-              require 'ddtrace/ext/distributed'
-
-              patch_http
-
-              @patched = true
-            rescue StandardError => e
-              Datadog::Tracer.log.error("Unable to apply net/http integration: #{e}")
-            end
-          end
-          @patched
+        def target_version
+          Integration.version
         end
 
-        # patched? tells whether patch has been successfully applied
-        def patched?
-          @patched
-        end
-
-        # rubocop:disable Metrics/MethodLength
-        # rubocop:disable Metrics/BlockLength
-        # rubocop:disable Metrics/AbcSize
-        def patch_http
-          ::Net::HTTP.class_eval do
-            alias_method :request_without_datadog, :request
-            remove_method :request
-
-            def datadog_pin
-              @datadog_pindatadog_pin ||= begin
-                service = Datadog.configuration[:http][:service_name]
-                tracer = Datadog.configuration[:http][:tracer]
-
-                Datadog::Pin.new(service, app: APP, app_type: Datadog::Ext::AppTypes::WEB, tracer: tracer)
-              end
-            end
-
-            def request(req, body = nil, &block) # :yield: +response+
-              pin = datadog_pin
-              return request_without_datadog(req, body, &block) unless pin && pin.tracer
-
-              transport = pin.tracer.writer.transport
-
-              if Datadog::Contrib::HTTP.should_skip_tracing?(req, @address, @port, transport, pin)
-                return request_without_datadog(req, body, &block)
-              end
-
-              pin.tracer.trace(NAME) do |span|
-                begin
-                  span.service = pin.service
-                  span.span_type = Datadog::Ext::HTTP::TYPE
-
-                  span.resource = req.method
-                  # Using the method as a resource, as URL/path can trigger
-                  # a possibly infinite number of resources.
-                  span.set_tag(Datadog::Ext::HTTP::URL, req.path)
-                  span.set_tag(Datadog::Ext::HTTP::METHOD, req.method)
-
-                  if pin.tracer.enabled && !Datadog::Contrib::HTTP.should_skip_distributed_tracing?(pin)
-                    req.add_field(Datadog::Ext::DistributedTracing::HTTP_HEADER_TRACE_ID, span.trace_id)
-                    req.add_field(Datadog::Ext::DistributedTracing::HTTP_HEADER_PARENT_ID, span.span_id)
-                    if span.context.sampling_priority
-                      req.add_field(
-                        Datadog::Ext::DistributedTracing::HTTP_HEADER_SAMPLING_PRIORITY,
-                        span.context.sampling_priority
-                      )
-                    end
-                  end
-                rescue StandardError => e
-                  Datadog::Tracer.log.error("error preparing span for http request: #{e}")
-                ensure
-                  response = request_without_datadog(req, body, &block)
-                end
-                span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.code)
-                if req.respond_to?(:uri) && req.uri
-                  span.set_tag(Datadog::Ext::NET::TARGET_HOST, req.uri.host)
-                  span.set_tag(Datadog::Ext::NET::TARGET_PORT, req.uri.port.to_s)
-                else
-                  span.set_tag(Datadog::Ext::NET::TARGET_HOST, @address)
-                  span.set_tag(Datadog::Ext::NET::TARGET_PORT, @port.to_s)
-                end
-
-                case response.code.to_i / 100
-                when 4
-                  span.set_error(response)
-                when 5
-                  span.set_error(response)
-                end
-
-                response
-              end
-            end
-          end
+        # patch applies our patch if needed
+        def patch
+          ::Net::HTTP.send(:include, Instrumentation)
         end
       end
     end

data/lib/ddtrace/contrib/http_annotation_helper.rb

@@ -0,0 +1,10 @@
+module Datadog
+  module Contrib
+    # Contains methods helpful for tracing/annotating HTTP request libraries
+    module HttpAnnotationHelper
+      def service_name(hostname, configuration_options)
+        configuration_options[:split_by_domain] ? hostname : configuration_options[:service_name]
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/httpclient/configuration/settings.rb

@@ -0,0 +1,32 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/httpclient/ext'
+
+module Datadog
+  module Contrib
+    module Httpclient
+      module Configuration
+        # Custom settings for the Httpclient integration
+        class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
+          option :analytics_enabled do |o|
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
+            o.lazy
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
+            o.lazy
+          end
+
+          option :distributed_tracing, default: true
+          option :service_name, default: Ext::SERVICE_NAME
+          option :split_by_domain, default: false
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/httpclient/ext.rb

@@ -0,0 +1,17 @@
+module Datadog
+  module Contrib
+    module Httpclient
+      # Httpclient integration constants
+      module Ext
+        APP = 'httpclient'.freeze
+        ENV_ENABLED = 'DD_TRACE_HTTPCLIENT_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTPCLIENT_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_HTTPCLIENT_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_HTTPCLIENT_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_HTTPCLIENT_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'httpclient'.freeze
+        SPAN_REQUEST = 'httpclient.request'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/httpclient/instrumentation.rb

@@ -0,0 +1,147 @@
+require 'ddtrace/ext/app_types'
+require 'ddtrace/ext/http'
+require 'ddtrace/ext/net'
+require 'ddtrace/ext/distributed'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/propagation/http_propagator'
+require 'ddtrace/contrib/http_annotation_helper'
+
+module Datadog
+  module Contrib
+    module Httpclient
+      # Instrumentation for Httpclient
+      module Instrumentation
+        def self.included(base)
+          base.send(:prepend, InstanceMethods)
+        end
+
+        # Instance methods for configuration
+        module InstanceMethods
+          include Datadog::Contrib::HttpAnnotationHelper
+
+          def do_get_block(req, proxy, conn, &block)
+            host = req.header.request_uri.host
+            request_options = datadog_configuration(host)
+            pin = datadog_pin(request_options)
+
+            return super unless pin && pin.tracer
+
+            pin.tracer.trace(Ext::SPAN_REQUEST, on_error: method(:annotate_span_with_error!)) do |span|
+              begin
+                request_options[:service_name] = pin.service_name
+                span.service = service_name(host, request_options)
+                span.span_type = Datadog::Ext::HTTP::TYPE_OUTBOUND
+
+                if pin.tracer.enabled && !should_skip_distributed_tracing?(pin)
+                  Datadog::HTTPPropagator.inject!(span.context, req.header)
+                end
+
+                # Add additional request specific tags to the span.
+                annotate_span_with_request!(span, req, request_options)
+              rescue StandardError => e
+                logger.error("error preparing span for httpclient request: #{e}, Source: #{e.backtrace}")
+              ensure
+                res = super
+              end
+
+              # Add additional response specific tags to the span.
+              annotate_span_with_response!(span, res)
+
+              res
+            end
+          end
+
+          private
+
+          def annotate_span_with_request!(span, req, req_options)
+            http_method = req.header.request_method.upcase
+            uri = req.header.request_uri
+
+            span.resource = http_method
+            span.set_tag(Datadog::Ext::HTTP::METHOD, http_method)
+            span.set_tag(Datadog::Ext::HTTP::URL, uri.path)
+            span.set_tag(Datadog::Ext::NET::TARGET_HOST, uri.host)
+            span.set_tag(Datadog::Ext::NET::TARGET_PORT, uri.port)
+
+            # Tag as an external peer service
+            span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
+            set_analytics_sample_rate(span, req_options)
+          end
+
+          def annotate_span_with_response!(span, response)
+            return unless response && response.status
+
+            span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.status)
+
+            case response.status.to_i
+            when 400...599
+              span.set_error(["Error #{response.status}", response.body])
+            end
+          end
+
+          def annotate_span_with_error!(span, error)
+            span.set_error(error)
+          end
+
+          def datadog_pin(config = Datadog.configuration[:httprb])
+            service = config[:service_name]
+            tracer = config[:tracer]
+
+            @datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+              tracer: -> { config[:tracer] }
+            )
+
+            if @datadog_pin.service_name == default_datadog_pin.service_name && @datadog_pin.service_name != service
+              @datadog_pin.service = service
+            end
+            if @datadog_pin.tracer == default_datadog_pin.tracer && @datadog_pin.tracer != tracer
+              @datadog_pin.tracer = tracer
+            end
+
+            @datadog_pin
+          end
+
+          def default_datadog_pin
+            config = Datadog.configuration[:httpclient]
+            service = config[:service_name]
+
+            @default_datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+              tracer: -> { config[:tracer] }
+            )
+          end
+
+          def datadog_configuration(host = :default)
+            Datadog.configuration[:httpclient, host]
+          end
+
+          def analytics_enabled?(request_options)
+            Contrib::Analytics.enabled?(request_options[:analytics_enabled])
+          end
+
+          def logger
+            Datadog.logger
+          end
+
+          def should_skip_distributed_tracing?(pin)
+            return !pin.config[:distributed_tracing] if pin.config && pin.config.key?(:distributed_tracing)
+
+            !Datadog.configuration[:httpclient][:distributed_tracing]
+          end
+
+          def set_analytics_sample_rate(span, request_options)
+            return unless analytics_enabled?(request_options)
+
+            Contrib::Analytics.set_sample_rate(span, request_options[:analytics_sample_rate])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/httpclient/integration.rb

@@ -0,0 +1,43 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/httpclient/configuration/settings'
+require 'ddtrace/contrib/configuration/resolvers/pattern_resolver'
+require 'ddtrace/contrib/httpclient/patcher'
+
+module Datadog
+  module Contrib
+    module Httpclient
+      # Description of Httpclient integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('2.2.0')
+
+        register_as :httpclient
+
+        def self.version
+          Gem.loaded_specs['httpclient'] && Gem.loaded_specs['httpclient'].version
+        end
+
+        def self.loaded?
+          !defined?(::HTTPClient).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+
+        def resolver
+          @resolver ||= Contrib::Configuration::Resolvers::PatternResolver.new
+        end
+      end
+    end
+  end
+end