datadog 2.0.0.beta1

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

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative '../http_annotation_helper'
+require_relative '../utils/quantization/http'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module HTTP
+        # Instrumentation for Net::HTTP
+        module Instrumentation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          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.type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
+                  span.resource = req.method
+
+                  if Tracing.enabled? && !Contrib::HTTP.should_skip_distributed_tracing?(client_config)
+                    Contrib::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)
+
+                response
+              end
+            end
+
+            def annotate_span_with_request!(span, request, request_options)
+              if request_options[:peer_service]
+                span.set_tag(
+                  Tracing::Metadata::Ext::TAG_PEER_SERVICE,
+                  request_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::HTTP::TAG_URL,
+                Contrib::Utils::Quantization::HTTP.url(request.path, { query: { exclude: :all } })
+              )
+              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)
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host)
+
+              # Set analytics sample rate
+              set_analytics_sample_rate(span, request_options)
+
+              span.set_tags(
+                Datadog.configuration.tracing.header_tags.request_tags(request)
+              )
+
+              Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
+            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
+
+              span.set_tags(
+                Datadog.configuration.tracing.header_tags.response_tags(response)
+              )
+            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,49 @@
+# frozen_string_literal: true
+
+require_relative '../configuration/resolvers/pattern_resolver'
+require_relative 'circuit_breaker'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+require_relative '../integration'
+require_relative '../../../../datadog/version'
+
+module Datadog
+  module Tracing
+    module Contrib
+      # HTTP integration
+      module HTTP
+        extend CircuitBreaker
+
+        # Description of HTTP integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Datadog::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,30 @@
+# frozen_string_literal: true
+
+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.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'component'
+require_relative 'http/integration'
+require_relative 'http/distributed/propagation'
+
+module Datadog
+  module Tracing
+    module Contrib
+      # `Net/HTTP` integration public API
+      # @public_api
+      module HTTP
+        # Inject distributed headers into the given request
+        # @param digest [Datadog::Tracing::TraceDigest] the trace to inject
+        # @param data [Hash] the request to inject
+        def self.inject(digest, data)
+          raise 'Please invoke Datadog.configure at least once before calling this method' unless @propagation
+
+          @propagation.inject!(digest, data)
+        end
+
+        # Extract distributed headers from the given request
+        # @param data [Hash] the request to extract from
+        # @return [Datadog::Tracing::TraceDigest,nil] the extracted trace digest or nil if none was found
+        def self.extract(data)
+          raise 'Please invoke Datadog.configure at least once before calling this method' unless @propagation
+
+          @propagation.extract(data)
+        end
+
+        Contrib::Component.register('http') do |config|
+          tracing = config.tracing
+          # DEV: evaluate propagation_style in case it overrides propagation_style_extract & propagation_extract_first
+          tracing.propagation_style
+
+          @propagation = HTTP::Distributed::Propagation.new(
+            propagation_style_inject: tracing.propagation_style_inject,
+            propagation_style_extract: tracing.propagation_style_extract,
+            propagation_extract_first: tracing.propagation_extract_first
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+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,68 @@
+# 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 Httpclient
+        module Configuration
+          # Custom settings for the Httpclient 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 :service_name do |o|
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
+            end
+
+            option :error_status_codes do |o|
+              o.env Ext::ENV_ERROR_STATUS_CODES
+              o.default 400...600
+              o.setter do |v|
+                Tracing::Contrib::StatusRangeMatcher.new(v) if v
+              end
+              o.env_parser do |v|
+                Tracing::Contrib::StatusRangeEnvParser.call(v) if v
+              end
+            end
+
+            option :peer_service do |o|
+              o.type :string, nilable: true
+              o.env Ext::ENV_PEER_SERVICE
+            end
+
+            option :split_by_domain, default: false, type: :bool
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+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'
+          ENV_SERVICE_NAME = 'DD_TRACE_HTTPCLIENT_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_HTTPCLIENT_PEER_SERVICE'
+
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTPCLIENT_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_HTTPCLIENT_ANALYTICS_SAMPLE_RATE'
+          ENV_ERROR_STATUS_CODES = 'DD_TRACE_HTTPCLIENT_ERROR_STATUS_CODES'
+          DEFAULT_PEER_SERVICE_NAME = 'httpclient'
+          SPAN_REQUEST = 'httpclient.request'
+          TAG_COMPONENT = 'httpclient'
+          TAG_OPERATION_REQUEST = 'request'
+          PEER_SERVICE_SOURCES = Array[
+            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/httpclient/instrumentation.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require_relative '../../metadata/ext'
+require_relative '../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.type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
+
+                  if Tracing.enabled? && !should_skip_distributed_tracing?(client_config)
+                    Contrib::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)
+
+              if req_options[:peer_service]
+                span.set_tag(
+                  Tracing::Metadata::Ext::TAG_PEER_SERVICE,
+                  req_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_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)
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, uri.host)
+
+              set_analytics_sample_rate(span, req_options)
+
+              span.set_tags(
+                Datadog.configuration.tracing.header_tags.request_tags(req.http_header)
+              )
+
+              Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
+            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
+
+              span.set_tags(
+                Datadog.configuration.tracing.header_tags.response_tags(response.header)
+              )
+            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,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 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,42 @@
+# frozen_string_literal: true
+
+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,68 @@
+# 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 Httprb
+        module Configuration
+          # Custom settings for the Httprb 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 :service_name do |o|
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
+            end
+
+            option :error_status_codes do |o|
+              o.env Ext::ENV_ERROR_STATUS_CODES
+              o.default 400...600
+              o.setter do |v|
+                Tracing::Contrib::StatusRangeMatcher.new(v) if v
+              end
+              o.env_parser do |v|
+                Tracing::Contrib::StatusRangeEnvParser.call(v) if v
+              end
+            end
+
+            option :peer_service do |o|
+              o.type :string, nilable: true
+              o.env Ext::ENV_PEER_SERVICE
+            end
+
+            option :split_by_domain, default: false, type: :bool
+          end
+        end
+      end
+    end
+  end
+end