ddtrace 0.44.0 → 0.48.0

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,38 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/httpclient/instrumentation'
+require 'ddtrace/utils/only_once'
+
+module Datadog
+  module Contrib
+    # Datadog Httpclient integration.
+    module Httpclient
+      # Patcher enables patching of 'httpclient' module.
+      module Patcher
+        include Contrib::Patcher
+
+        PATCH_ONLY_ONCE = Datadog::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.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/httprb/instrumentation.rb

@@ -16,7 +16,6 @@ module Datadog
         end
 
         # Instance methods for configuration
-        # rubocop:disable Metrics/ModuleLength
         module InstanceMethods
           include Datadog::Contrib::HttpAnnotationHelper
 
@@ -99,14 +98,12 @@ module Datadog
             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
+            @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
@@ -122,14 +119,12 @@ module Datadog
             config = Datadog.configuration[:httprb]
             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
+            @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)
@@ -145,15 +140,14 @@ module Datadog
           end
 
           def should_skip_distributed_tracing?(pin)
-            if pin.config && pin.config.key?(:distributed_tracing)
-              return !pin.config[:distributed_tracing]
-            end
+            return !pin.config[:distributed_tracing] if pin.config && pin.config.key?(:distributed_tracing)
 
             !Datadog.configuration[: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

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

@@ -1,5 +1,6 @@
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/httprb/instrumentation'
+require 'ddtrace/utils/only_once'
 
 module Datadog
   module Contrib
@@ -9,10 +10,12 @@ module Datadog
       module Patcher
         include Contrib::Patcher
 
+        PATCH_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
         module_function
 
         def patched?
-          done?(:httprb)
+          PATCH_ONLY_ONCE.ran?
         end
 
         def target_version
@@ -21,7 +24,7 @@ module Datadog
 
         # patch applies our patch
         def patch
-          do_once(:httprb) do
+          PATCH_ONLY_ONCE.run do
             begin
               ::HTTP::Client.send(:include, Instrumentation)
             rescue StandardError => e

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

@@ -23,6 +23,7 @@ module Datadog
               return unless respond_to? :cluster
               return unless cluster.respond_to? :addresses
               return unless cluster.addresses.respond_to? :first
+
               Datadog::Pin.get_from(cluster.addresses.first)
             end
 
@@ -31,6 +32,7 @@ module Datadog
               return unless respond_to? :cluster
               return unless cluster.respond_to? :addresses
               return unless cluster.addresses.respond_to? :each
+
               # attach the PIN to all cluster addresses. One of them is used
               # when executing a Command and it is attached to the Monitoring
               # Event instance.

data/lib/ddtrace/contrib/mongodb/subscribers.rb

@@ -29,9 +29,7 @@ module Datadog
           span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
 
           # Set analytics sample rate
-          if analytics_enabled?
-            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
-          end
+          Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
           # add operation tags; the full query is stored and used as a resource,
           # since it has been quantized and reduced
@@ -92,6 +90,7 @@ module Datadog
 
         def clear_span(event)
           return if Thread.current[:datadog_mongo_span].nil?
+
           Thread.current[:datadog_mongo_span].delete(event.request_id)
         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/patcher.rb

@@ -1,14 +1,12 @@
-require 'ddtrace/patcher'
+require 'ddtrace/utils/only_once'
 
 module Datadog
   module Contrib
     # Common behavior for patcher modules
     module Patcher
       def self.included(base)
-        base.send(:include, Datadog::Patcher)
-
         base.singleton_class.send(:prepend, CommonMethods)
-        base.send(:prepend, CommonMethods) if base.class == Class
+        base.send(:prepend, CommonMethods) if base.instance_of?(Class)
       end
 
       # Prepended instance methods for all patchers
@@ -18,13 +16,13 @@ module Datadog
         end
 
         def patched?
-          done?(:patch)
+          patch_only_once.ran?
         end
 
         def patch
           return unless defined?(super)
 
-          do_once(:patch) do
+          patch_only_once.run do
             begin
               super.tap do
                 # Emit a metric
@@ -56,6 +54,11 @@ module Datadog
             tags << "target_version:#{target_version}" if respond_to?(:target_version) && !target_version.nil?
           end
         end
+
+        def patch_only_once
+          # NOTE: This is not thread-safe
+          @patch_only_once ||= Datadog::Utils::OnlyOnce.new
+        end
       end
     end
   end

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

@@ -1,6 +1,7 @@
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/presto/ext'
 require 'ddtrace/contrib/presto/instrumentation'
+require 'ddtrace/utils/only_once'
 
 module Datadog
   module Contrib
@@ -9,14 +10,16 @@ module Datadog
       module Patcher
         include Contrib::Patcher
 
+        PATCH_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
         module_function
 
         def patched?
-          done?(:presto)
+          PATCH_ONLY_ONCE.ran?
         end
 
         def patch
-          do_once(:presto) do
+          PATCH_ONLY_ONCE.run do
             begin
               ::Presto::Client::Client.send(:include, Instrumentation::Client)
             rescue StandardError => e

data/lib/ddtrace/contrib/qless/qless_job.rb

@@ -9,6 +9,7 @@ module Datadog
       module QlessJob
         def around_perform(job)
           return super unless datadog_configuration && tracer
+
           tracer.trace(Ext::SPAN_JOB, span_options) do |span|
             span.resource = job.klass_name
             span.span_type = Datadog::Ext::AppTypes::WORKER

data/lib/ddtrace/contrib/qless/tracer_cleaner.rb

@@ -16,6 +16,7 @@ module Datadog
         def forked?
           pin = Datadog::Pin.get_from(::Qless)
           return false unless pin
+
           pin.config[:forked] == true
         end
 

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

@@ -5,25 +5,25 @@ module Datadog
     module Que
       # Que integration constants
       module Ext
-        APP = 'que'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_QUE_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_QUE_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_QUE_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_QUE_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ENABLED = 'DD_TRACE_QUE_ENABLED'.freeze
-        ENV_TAG_ARGS_ENABLED = 'DD_TRACE_QUE_TAG_ARGS_ENABLED'.freeze
-        ENV_TAG_DATA_ENABLED = 'DD_TRACE_QUE_TAG_DATA_ENABLED'.freeze
-        SERVICE_NAME = 'que'.freeze
-        SPAN_JOB = 'que.job'.freeze
-        TAG_JOB_ARGS = 'que.job.args'.freeze
-        TAG_JOB_DATA = 'que.job.data'.freeze
-        TAG_JOB_ERROR_COUNT = 'que.job.error_count'.freeze
-        TAG_JOB_EXPIRED_AT = 'que.job.expired_at'.freeze
-        TAG_JOB_FINISHED_AT = 'que.job.finished_at'.freeze
-        TAG_JOB_ID = 'que.job.id'.freeze
-        TAG_JOB_PRIORITY = 'que.job.priority'.freeze
-        TAG_JOB_QUEUE = 'que.job.queue'.freeze
-        TAG_JOB_RUN_AT = 'que.job.run_at'.freeze
+        APP = 'que'
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_QUE_ANALYTICS_ENABLED'
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_QUE_ANALYTICS_ENABLED'
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_QUE_ANALYTICS_SAMPLE_RATE'
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_QUE_ANALYTICS_SAMPLE_RATE'
+        ENV_ENABLED = 'DD_TRACE_QUE_ENABLED'
+        ENV_TAG_ARGS_ENABLED = 'DD_TRACE_QUE_TAG_ARGS_ENABLED'
+        ENV_TAG_DATA_ENABLED = 'DD_TRACE_QUE_TAG_DATA_ENABLED'
+        SERVICE_NAME = 'que'
+        SPAN_JOB = 'que.job'
+        TAG_JOB_ARGS = 'que.job.args'
+        TAG_JOB_DATA = 'que.job.data'
+        TAG_JOB_ERROR_COUNT = 'que.job.error_count'
+        TAG_JOB_EXPIRED_AT = 'que.job.expired_at'
+        TAG_JOB_FINISHED_AT = 'que.job.finished_at'
+        TAG_JOB_ID = 'que.job.id'
+        TAG_JOB_PRIORITY = 'que.job.priority'
+        TAG_JOB_QUEUE = 'que.job.queue'
+        TAG_JOB_RUN_AT = 'que.job.run_at'
       end
     end
   end

data/lib/ddtrace/contrib/que/tracer.rb

@@ -9,7 +9,7 @@ module Datadog
       class Tracer
         def call(job)
           trace_options = {
-            service:   configuration[:service_name],
+            service: configuration[:service_name],
             span_type: Datadog::Ext::AppTypes::WORKER,
             on_error: configuration[:error_handler]
           }

data/lib/ddtrace/contrib/racecar/event.rb

@@ -66,6 +66,7 @@ module Datadog
           # preventing such a leak.
           def ensure_clean_context!
             return unless configuration[:tracer].call_context.current_span
+
             configuration[:tracer].provider.context = Context.new
           end
         end

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

@@ -8,9 +8,9 @@ module Datadog
         # Custom settings for the Rack integration
         class Settings < Contrib::Configuration::Settings
           DEFAULT_HEADERS = {
-            response: [
-              'Content-Type',
-              'X-Request-ID'
+            response: %w[
+              Content-Type
+              X-Request-ID
             ]
           }.freeze
 

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)
 
@@ -131,7 +131,8 @@ module Datadog
         end
 
         # rubocop:disable Metrics/AbcSize
-        # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/PerceivedComplexity
         def set_request_tags!(request_span, env, status, headers, response, original_env)
           # http://www.rubydoc.info/github/rack/rack/file/SPEC
           # The source of truth in Rack is the PATH_INFO key that holds the
@@ -199,9 +200,7 @@ module Datadog
 
           # detect if the status code is a 5xx and flag the request span as an error
           # unless it has been already set by the underlying framework
-          if status.to_s.start_with?('5') && request_span.status.zero?
-            request_span.status = 1
-          end
+          request_span.status = 1 if status.to_s.start_with?('5') && request_span.status.zero?
         end
 
         private
@@ -258,9 +257,7 @@ module Datadog
             whitelist = configuration[:headers][:request] || []
             whitelist.each do |header|
               rack_header = header_to_rack_header(header)
-              if env.key?(rack_header)
-                result[Datadog::Ext::HTTP::RequestHeaders.to_tag(header)] = env[rack_header]
-              end
+              result[Datadog::Ext::HTTP::RequestHeaders.to_tag(header)] = env[rack_header] if env.key?(rack_header)
             end
           end
         end
@@ -275,9 +272,7 @@ module Datadog
                 # Try a case-insensitive lookup
                 uppercased_header = header.to_s.upcase
                 matching_header = headers.keys.find { |h| h.upcase == uppercased_header }
-                if matching_header
-                  result[Datadog::Ext::HTTP::ResponseHeaders.to_tag(header)] = headers[matching_header]
-                end
+                result[Datadog::Ext::HTTP::ResponseHeaders.to_tag(header)] = headers[matching_header] if matching_header
               end
             end
           end