ddtrace 0.44.0 → 0.45.0

data/lib/ddtrace/contrib/ethon/easy_patch.rb

@@ -109,11 +109,12 @@ module Datadog
             # Set analytics sample rate
             Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
-            return unless uri
-            span.set_tag(Datadog::Ext::HTTP::URL, uri.path)
+            this_uri = uri
+            return unless this_uri
+            span.set_tag(Datadog::Ext::HTTP::URL, this_uri.path)
             span.set_tag(Datadog::Ext::HTTP::METHOD, method)
-            span.set_tag(Datadog::Ext::NET::TARGET_HOST, uri.host)
-            span.set_tag(Datadog::Ext::NET::TARGET_PORT, uri.port)
+            span.set_tag(Datadog::Ext::NET::TARGET_HOST, this_uri.host)
+            span.set_tag(Datadog::Ext::NET::TARGET_PORT, this_uri.port)
           end
 
           def set_span_error_message(message)

data/lib/ddtrace/contrib/extensions.rb

@@ -27,8 +27,26 @@ module Datadog
 
           # Activate integrations
           if target.respond_to?(:integrations_pending_activation)
+            reduce_verbosity = target.respond_to?(:reduce_verbosity?) ? target.reduce_verbosity? : false
             target.integrations_pending_activation.each do |integration|
-              integration.patch if integration.respond_to?(:patch)
+              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 unless !reduce_verbosity ||
+                          ((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
 
             target.integrations_pending_activation.clear
@@ -86,6 +104,14 @@ module Datadog
             registry[name] ||
               raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
           end
+
+          def reduce_verbosity?
+            defined?(@reduce_verbosity) ? @reduce_verbosity : false
+          end
+
+          def reduce_log_verbosity
+            @reduce_verbosity ||= true
+          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,152 @@
+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 ||= begin
+              Datadog::Pin.new(
+                service,
+                app: Ext::APP,
+                app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+                tracer: -> { config[:tracer] }
+              )
+            end
+
+            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 ||= begin
+              Datadog::Pin.new(
+                service,
+                app: Ext::APP,
+                app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+                tracer: -> { config[:tracer] }
+              )
+            end
+          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)
+            if pin.config && pin.config.key?(:distributed_tracing)
+              return !pin.config[:distributed_tracing]
+            end
+
+            !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

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

@@ -0,0 +1,35 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/httpclient/instrumentation'
+
+module Datadog
+  module Contrib
+    # Datadog Httpclient integration.
+    module Httpclient
+      # Patcher enables patching of 'httpclient' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:httpclient)
+        end
+
+        def target_version
+          Integration.version
+        end
+
+        # patch applies our patch
+        def patch
+          do_once(:httpclient) do
+            begin
+              ::HTTPClient.send(:include, Instrumentation)
+            rescue StandardError => e
+              Datadog::Logger.error("Unable to apply httpclient integration: #{e}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/patchable.rb

@@ -42,16 +42,27 @@ module Datadog
 
         def patch
           if !self.class.patchable? || patcher.nil?
-            desc = "Available?: #{self.class.available?}"
-            desc += ", Loaded? #{self.class.loaded?}"
-            desc += ", Compatible? #{self.class.compatible?}"
-            desc += ", Patchable? #{self.class.patchable?}"
-
-            Datadog.logger.warn("Unable to patch #{self.class.name} (#{desc})")
-            return
+            return {
+              name: self.class.name,
+              available: self.class.available?,
+              loaded: self.class.loaded?,
+              compatible: self.class.compatible?,
+              patchable: self.class.patchable?
+            }
           end
 
           patcher.patch
+          true
+        end
+
+        # Can the patch for this integration be applied automatically?
+        # For example: test integrations should only be applied
+        # by the user explicitly setting `c.use :rspec`
+        # and rails sub-modules are auto-instrumented by enabling rails
+        # so auto-instrumenting them on their own will cause changes in
+        # service naming behavior
+        def auto_instrument?
+          true
         end
       end
     end

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

@@ -1,6 +1,7 @@
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/rack/configuration/settings'
 require 'ddtrace/contrib/rack/patcher'
+require 'ddtrace/contrib/rails/utils'
 
 module Datadog
   module Contrib
@@ -25,6 +26,12 @@ module Datadog
           super && version >= MINIMUM_VERSION
         end
 
+        # enabled by rails integration so should only auto instrument
+        # if detected that it is being used without rails
+        def auto_instrument?
+          !Datadog::Contrib::Rails::Utils.railtie_supported?
+        end
+
         def default_configuration
           Configuration::Settings.new
         end

data/lib/ddtrace/contrib/rack/middlewares.rb

@@ -53,7 +53,7 @@ module Datadog
             tracer.provider.context = context if context.trace_id
           end
 
-          # [experimental] create a root Span to keep track of frontend web servers
+          # Create a root Span to keep track of frontend web servers
           # (i.e. Apache, nginx) if the header is properly set
           frontend_span = compute_queue_time(env, tracer)
 

data/lib/ddtrace/contrib/rack/request_queue.rb

@@ -1,7 +1,12 @@
 module Datadog
   module Contrib
     module Rack
-      # QueueTime simply...
+      # Retrieves the time spent in an upstream proxy
+      # for the current Rack request.
+      #
+      # This time captures the request delay introduced but
+      # such proxy before the request made it to the Ruby
+      # process.
       module QueueTime
         REQUEST_START = 'HTTP_X_REQUEST_START'.freeze
         QUEUE_START = 'HTTP_X_QUEUE_START'.freeze

data/lib/ddtrace/contrib/rails/auto_instrument_railtie.rb

@@ -0,0 +1,10 @@
+require 'ddtrace'
+
+# Railtie to include AutoInstrumentation in rails loading
+class DatadogAutoInstrumentRailtie < Rails::Railtie
+  # we want to load before config initializers so that any user supplied config
+  # in config/initializers/datadog.rb will take precedence
+  initializer 'datadog.start_tracer', before: :load_config_initializers do
+    Datadog::Contrib::AutoInstrument.patch_all
+  end
+end

data/lib/ddtrace/contrib/rails/utils.rb

@@ -14,6 +14,10 @@ module Datadog
             ::Rails.application.class.to_s.underscore
           end
         end
+
+        def self.railtie_supported?
+          !(defined?(::Rails::VERSION::MAJOR) && ::Rails::VERSION::MAJOR >= 3 && defined?(::Rails::Railtie)).nil?
+        end
       end
     end
   end