ddtrace 0.41.0 → 0.46.0

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/httprb/instrumentation.rb

@@ -40,7 +40,7 @@ module Datadog
                 # 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}, Soure: #{e.backtrace}")
+                logger.error("error preparing span for http.rb request: #{e}, Source: #{e.backtrace}")
               ensure
                 res = super(req, options)
               end
@@ -103,7 +103,7 @@ module Datadog
               Datadog::Pin.new(
                 service,
                 app: Ext::APP,
-                app_type: Datadog::Ext::AppTypes::WEB,
+                app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
                 tracer: -> { config[:tracer] }
               )
             end
@@ -126,7 +126,7 @@ module Datadog
               Datadog::Pin.new(
                 service,
                 app: Ext::APP,
-                app_type: Datadog::Ext::AppTypes::WEB,
+                app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
                 tracer: -> { config[:tracer] }
               )
             end
@@ -145,15 +145,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/kafka/event.rb

@@ -42,7 +42,7 @@ module Datadog
             # Measure service stats
             Contrib::Analytics.set_measured(span)
 
-            span.set_error(payload[:exception_object]) if payload[:exception_object]
+            report_if_exception(span, payload)
           end
         end
       end

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

@@ -8,7 +8,7 @@ module Datadog
         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

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

@@ -0,0 +1,35 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/qless/ext'
+
+module Datadog
+  module Contrib
+    module Qless
+      module Configuration
+        # Custom settings for the Qless integration
+        class Settings < Contrib::Configuration::Settings
+          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 :tag_job_data do |o|
+            o.default { env_to_bool(Ext::ENV_TAG_JOB_DATA, false) }
+            o.lazy
+          end
+
+          option :tag_job_tags do |o|
+            o.default { env_to_bool(Ext::ENV_TAG_JOB_TAGS, false) }
+            o.lazy
+          end
+
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Datadog
+  module Contrib
+    module Qless
+      # Qless integration constants
+      module Ext
+        APP = 'qless'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_QLESS_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_QLESS_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_TAG_JOB_DATA = 'DD_QLESS_TAG_JOB_DATA'.freeze
+        ENV_TAG_JOB_TAGS = 'DD_QLESS_TAG_JOB_TAGS'.freeze
+        SERVICE_NAME = 'qless'.freeze
+        SPAN_JOB = 'qless.job'.freeze
+        TAG_JOB_ID = 'qless.job.id'.freeze
+        TAG_JOB_DATA = 'qless.job.data'.freeze
+        TAG_JOB_QUEUE = 'qless.job.queue'.freeze
+        TAG_JOB_TAGS = 'qless.job.tags'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/qless/configuration/settings'
+require 'ddtrace/contrib/qless/patcher'
+
+module Datadog
+  module Contrib
+    module Qless
+      # Description of Qless integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('0.10.0')
+
+        register_as :qless, auto_patch: true
+
+        def self.version
+          Gem.loaded_specs['qless'] && Gem.loaded_specs['qless'].version
+        end
+
+        def self.loaded?
+          !defined?(::Qless).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+
+module Datadog
+  module Contrib
+    module Qless
+      # Patcher enables patching of 'qless' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def target_version
+          Integration.version
+        end
+
+        def patch
+          require_relative 'qless_job'
+          require_relative 'tracer_cleaner'
+
+          # Instrument all Qless Workers
+          ::Qless::Workers::BaseWorker.class_eval do
+            # These are executed in inverse order of listing here
+            include QlessJob
+            include TracerCleaner
+          end
+        end
+
+        def get_option(option)
+          Datadog.configuration[:qless].get_option(option)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/analytics'
+require 'qless'
+
+module Datadog
+  module Contrib
+    module Qless
+      # Uses Qless job hooks to create traces
+      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
+            span.set_tag(Ext::TAG_JOB_ID, job.jid)
+            span.set_tag(Ext::TAG_JOB_QUEUE, job.queue_name)
+
+            tag_job_tags = datadog_configuration[:tag_job_tags]
+            span.set_tag(Ext::TAG_JOB_TAGS, job.tags) if tag_job_tags
+
+            tag_job_data = datadog_configuration[:tag_job_data]
+            if tag_job_data && !job.data.empty?
+              job_data = job.data.with_indifferent_access
+              formatted_data = job_data.except(:tags).map do |key, value|
+                "#{key}:#{value}".underscore
+              end
+
+              span.set_tag(Ext::TAG_JOB_DATA, formatted_data)
+            end
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])
+            end
+
+            # Measure service stats
+            Contrib::Analytics.set_measured(span)
+
+            super
+          end
+        end
+
+        def after_fork
+          configuration = Datadog.configuration[:qless]
+          return if configuration.nil?
+
+          # Add a pin, marking the job as forked.
+          # Used to trigger shutdown in forks for performance reasons.
+          # Cleanup happens in the TracerCleaner class
+          Datadog::Pin.new(
+            configuration[:service_name],
+            config: { forked: true }
+          ).onto(::Qless)
+        end
+
+        private
+
+        def span_options
+          { service: datadog_configuration[:service_name] }
+        end
+
+        def tracer
+          datadog_configuration.tracer
+        end
+
+        def datadog_configuration
+          Datadog.configuration[:qless]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Datadog
+  module Contrib
+    module Qless
+      # Shutdown Tracer in forks for performance reasons
+      module TracerCleaner
+        def around_perform(job)
+          return super unless datadog_configuration && tracer
+
+          super.tap do
+            tracer.shutdown! if forked?
+          end
+        end
+
+        private
+
+        def forked?
+          pin = Datadog::Pin.get_from(::Qless)
+          return false unless pin
+
+          pin.config[:forked] == true
+        end
+
+        def tracer
+          datadog_configuration.tracer
+        end
+
+        def datadog_configuration
+          Datadog.configuration[:qless]
+        end
+      end
+    end
+  end
+end

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

@@ -35,6 +35,7 @@ module Datadog
             o.default { env_to_bool(Ext::ENV_TAG_DATA_ENABLED, false) }
             o.lazy
           end
+          option :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
         end
       end
     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