ddtrace 0.54.2 → 1.10.1

data/lib/datadog/tracing/contrib/http/instrumentation.rb

@@ -0,0 +1,135 @@
+require 'uri'
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative '../http_annotation_helper'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module HTTP
+        # Instrumentation for Net::HTTP
+        module Instrumentation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # Span hook invoked after request is completed.
+          def self.after_request(&block)
+            if block
+              # Set hook
+              @after_request = block
+            else
+              # Get hook
+              @after_request ||= nil
+            end
+          end
+
+          # InstanceMethods - implementing instrumentation
+          module InstanceMethods
+            include Contrib::HttpAnnotationHelper
+
+            # :yield: +response+
+            def request(req, body = nil, &block)
+              host, = host_and_port(req)
+              request_options = datadog_configuration(host)
+              client_config = Datadog.configuration_for(self)
+
+              return super(req, body, &block) if Contrib::HTTP.should_skip_tracing?(req)
+
+              Tracing.trace(Ext::SPAN_REQUEST, on_error: method(:annotate_span_with_error!)) do |span, trace|
+                begin
+                  span.service = service_name(host, request_options, client_config)
+                  span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
+                  span.resource = req.method
+
+                  if Tracing.enabled? && !Contrib::HTTP.should_skip_distributed_tracing?(client_config)
+                    Tracing::Propagation::HTTP.inject!(trace, req)
+                  end
+
+                  # Add additional request specific tags to the span.
+                  annotate_span_with_request!(span, req, request_options)
+                rescue StandardError => e
+                  Datadog.logger.error("error preparing span for http request: #{e}")
+                ensure
+                  response = super(req, body, &block)
+                end
+
+                # Add additional response specific tags to the span.
+                annotate_span_with_response!(span, response, request_options)
+
+                # Invoke hook, if set.
+                unless Contrib::HTTP::Instrumentation.after_request.nil?
+                  Contrib::HTTP::Instrumentation.after_request.call(span, self, req, response)
+                end
+
+                response
+              end
+            end
+
+            def annotate_span_with_request!(span, request, request_options)
+              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::HTTP::TAG_URL, request.path)
+              span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, request.method)
+
+              host, port = host_and_port(request)
+              span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, host)
+              span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, port.to_s)
+
+              # Tag as an external peer service
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host)
+
+              # Set analytics sample rate
+              set_analytics_sample_rate(span, request_options)
+            end
+
+            def annotate_span_with_response!(span, response, request_options)
+              return unless response && response.code
+
+              span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, response.code)
+
+              span.set_error(response) if request_options[:error_status_codes].include? response.code.to_i
+            end
+
+            def annotate_span_with_error!(span, error)
+              span.set_error(error)
+            end
+
+            def set_analytics_sample_rate(span, request_options)
+              return unless analytics_enabled?(request_options)
+
+              Contrib::Analytics.set_sample_rate(span, analytics_sample_rate(request_options))
+            end
+
+            private
+
+            def host_and_port(request)
+              if request.respond_to?(:uri) && request.uri
+                [request.uri.host, request.uri.port]
+              else
+                [@address, @port]
+              end
+            end
+
+            def datadog_configuration(host = :default)
+              Datadog.configuration.tracing[:http, host]
+            end
+
+            def analytics_enabled?(request_options)
+              Contrib::Analytics.enabled?(request_options[:analytics_enabled])
+            end
+
+            def analytics_sample_rate(request_options)
+              request_options[:analytics_sample_rate]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require_relative '../configuration/resolvers/pattern_resolver'
+require_relative 'circuit_breaker'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+require_relative '../integration'
+require_relative '../../../../ddtrace/version'
+
+module Datadog
+  module Tracing
+    module Contrib
+      # HTTP integration
+      module HTTP
+        extend CircuitBreaker
+
+        # Description of HTTP integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = DDTrace::VERSION::MINIMUM_RUBY_VERSION
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :http, auto_patch: true
+
+          def self.version
+            Gem::Version.new(RUBY_VERSION)
+          end
+
+          def self.loaded?
+            !defined?(::Net::HTTP).nil?
+          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/http/patcher.rb

@@ -0,0 +1,28 @@
+require_relative '../patcher'
+require_relative 'ext'
+require_relative 'instrumentation'
+
+module Datadog
+  module Tracing
+    module Contrib
+      # Datadog Net/HTTP integration.
+      module HTTP
+        # Patcher enables patching of 'net/http' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          # patch applies our patch if needed
+          def patch
+            ::Net::HTTP.include(Instrumentation)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Datadog
+  module Tracing
+    module Contrib
+      # Contains methods helpful for tracing/annotating HTTP request libraries
+      module HttpAnnotationHelper
+        def service_name(hostname, configuration_options, pin = nil)
+          return hostname if configuration_options[:split_by_domain]
+          return pin[:service_name] if pin && pin[:service_name]
+
+          configuration_options[:service_name]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Httpclient
+        module Configuration
+          # Custom settings for the Httpclient integration
+          # @public_api
+          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, false) }
+              o.lazy
+            end
+
+            option :analytics_sample_rate do |o|
+              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+              o.lazy
+            end
+
+            option :distributed_tracing, default: true
+
+            option :service_name do |o|
+              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.lazy
+            end
+
+            option :error_status_codes do |o|
+              o.default { env_to_list(Ext::ENV_ERROR_STATUS_CODES, 400...600, comma_separated_only: false) }
+              o.lazy
+            end
+
+            option :split_by_domain, default: false
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Datadog
+  module Tracing
+    module Contrib
+      module Httpclient
+        # Httpclient integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_HTTPCLIENT_ENABLED'.freeze
+          ENV_SERVICE_NAME = 'DD_TRACE_HTTPCLIENT_SERVICE_NAME'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTPCLIENT_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_HTTPCLIENT_ANALYTICS_SAMPLE_RATE'.freeze
+          ENV_ERROR_STATUS_CODES = 'DD_TRACE_HTTPCLIENT_ERROR_STATUS_CODES'.freeze
+          DEFAULT_PEER_SERVICE_NAME = 'httpclient'.freeze
+          SPAN_REQUEST = 'httpclient.request'.freeze
+          TAG_COMPONENT = 'httpclient'.freeze
+          TAG_OPERATION_REQUEST = 'request'.freeze
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/httpclient/instrumentation.rb

@@ -0,0 +1,115 @@
+require_relative '../../metadata/ext'
+require_relative '../../propagation/http'
+require_relative '../analytics'
+require_relative '../http_annotation_helper'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Httpclient
+        # Instrumentation for Httpclient
+        module Instrumentation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # Instance methods for configuration
+          module InstanceMethods
+            include Contrib::HttpAnnotationHelper
+
+            def do_get_block(req, proxy, conn, &block)
+              host = req.header.request_uri.host
+              request_options = datadog_configuration(host)
+              client_config = Datadog.configuration_for(self)
+
+              Tracing.trace(Ext::SPAN_REQUEST, on_error: method(:annotate_span_with_error!)) do |span, trace|
+                begin
+                  span.service = service_name(host, request_options, client_config)
+                  span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
+
+                  if Tracing.enabled? && !should_skip_distributed_tracing?(client_config)
+                    Tracing::Propagation::HTTP.inject!(trace, 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, request_options)
+
+                res
+              end
+            end
+
+            private
+
+            def annotate_span_with_request!(span, req, req_options)
+              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)
+
+              http_method = req.header.request_method.upcase
+              uri = req.header.request_uri
+
+              span.resource = http_method
+              span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, http_method)
+              span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_URL, uri.path)
+              span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, uri.host)
+              span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, uri.port)
+
+              # Tag as an external peer service
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, uri.host)
+
+              set_analytics_sample_rate(span, req_options)
+            end
+
+            def annotate_span_with_response!(span, response, request_options)
+              return unless response && response.status
+
+              span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, response.status)
+
+              if request_options[:error_status_codes].include? response.code.to_i
+                span.set_error(["Error #{response.status}", response.body])
+              end
+            end
+
+            def annotate_span_with_error!(span, error)
+              span.set_error(error)
+            end
+
+            def datadog_configuration(host = :default)
+              Datadog.configuration.tracing[: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?(client_config)
+              return !client_config[:distributed_tracing] if client_config && client_config.key?(:distributed_tracing)
+
+              !Datadog.configuration.tracing[: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
+end

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

@@ -0,0 +1,46 @@
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative '../configuration/resolvers/pattern_resolver'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Httpclient
+        # Description of Httpclient integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('2.2.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          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 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/httpclient/patcher.rb

@@ -0,0 +1,40 @@
+require_relative '../../../core/utils/only_once'
+require_relative 'instrumentation'
+require_relative '../patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      # Datadog Httpclient integration.
+      module Httpclient
+        # Patcher enables patching of 'httpclient' module.
+        module Patcher
+          include Contrib::Patcher
+
+          PATCH_ONLY_ONCE = Core::Utils::OnlyOnce.new
+
+          module_function
+
+          def patched?
+            PATCH_ONLY_ONCE.ran?
+          end
+
+          def target_version
+            Integration.version
+          end
+
+          # patch applies our patch
+          def patch
+            PATCH_ONLY_ONCE.run do
+              begin
+                ::HTTPClient.include(Instrumentation)
+              rescue StandardError => e
+                Datadog.logger.error("Unable to apply httpclient integration: #{e}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Httprb
+        module Configuration
+          # Custom settings for the Httprb integration
+          # @public_api
+          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, false) }
+              o.lazy
+            end
+
+            option :analytics_sample_rate do |o|
+              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+              o.lazy
+            end
+
+            option :distributed_tracing, default: true
+
+            option :service_name do |o|
+              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.lazy
+            end
+
+            option :error_status_codes do |o|
+              o.default { env_to_list(Ext::ENV_ERROR_STATUS_CODES, 400...600, comma_separated_only: false) }
+              o.lazy
+            end
+
+            option :split_by_domain, default: false
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Datadog
+  module Tracing
+    module Contrib
+      module Httprb
+        # Httprb integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_HTTPRB_ENABLED'.freeze
+          ENV_SERVICE_NAME = 'DD_TRACE_HTTPRB_SERVICE_NAME'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTPRB_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_EHTTPRB_ANALYTICS_SAMPLE_RATE'.freeze
+          ENV_ERROR_STATUS_CODES = 'DD_TRACE_HTTPCLIENT_ERROR_STATUS_CODES'.freeze
+          DEFAULT_PEER_SERVICE_NAME = 'httprb'.freeze
+          SPAN_REQUEST = 'httprb.request'.freeze
+          TAG_COMPONENT = 'httprb'.freeze
+          TAG_OPERATION_REQUEST = 'request'.freeze
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/httprb/instrumentation.rb

@@ -0,0 +1,126 @@
+require_relative '../../metadata/ext'
+require_relative '../../propagation/http'
+require_relative '../analytics'
+require_relative '../http_annotation_helper'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Httprb
+        # Instrumentation for Httprb
+        module Instrumentation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # Instance methods for configuration
+          module InstanceMethods
+            include Contrib::HttpAnnotationHelper
+
+            def perform(req, options)
+              host = req.uri.host if req.respond_to?(:uri) && req.uri
+              request_options = datadog_configuration(host)
+              client_config = Datadog.configuration_for(self)
+
+              Tracing.trace(Ext::SPAN_REQUEST, on_error: method(:annotate_span_with_error!)) do |span, trace|
+                begin
+                  span.service = service_name(host, request_options, client_config)
+                  span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
+
+                  if Tracing.enabled? && !should_skip_distributed_tracing?(client_config)
+                    Tracing::Propagation::HTTP.inject!(trace, req)
+                  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 http.rb request: #{e}, Source: #{e.backtrace}")
+                ensure
+                  res = super(req, options)
+                end
+
+                # Add additional response specific tags to the span.
+                annotate_span_with_response!(span, res, request_options)
+
+                res
+              end
+            end
+
+            private
+
+            def annotate_span_with_request!(span, req, req_options)
+              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)
+
+              if req.verb && req.verb.is_a?(String) || req.verb.is_a?(Symbol)
+                http_method = req.verb.to_s.upcase
+                span.resource = http_method
+                span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, http_method)
+              else
+                logger.debug("service #{req_options[:service_name]} span #{Ext::SPAN_REQUEST} missing request verb")
+              end
+
+              if req.uri
+                uri = req.uri
+                span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_URL, uri.path)
+                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)
+              else
+                logger.debug("service #{req_options[:service_name]} span #{Ext::SPAN_REQUEST} missing uri")
+              end
+
+              # Tag as an external peer service
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+
+              set_analytics_sample_rate(span, req_options)
+            end
+
+            def annotate_span_with_response!(span, response, request_options)
+              return unless response && response.code
+
+              span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, response.code)
+
+              if request_options[:error_status_codes].include? response.code.to_i
+                # https://github.com/DataDog/dd-trace-rb/issues/1116
+                # parsing the response body message will alter downstream application behavior
+                span.set_error(["Error #{response.code}", 'Error'])
+              end
+            end
+
+            def annotate_span_with_error!(span, error)
+              span.set_error(error)
+            end
+
+            def datadog_configuration(host = :default)
+              Datadog.configuration.tracing[:httprb, 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?(client_config)
+              return !client_config[:distributed_tracing] if client_config && client_config.key?(:distributed_tracing)
+
+              !Datadog.configuration.tracing[:httprb][: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
+end