ddtrace 0.43.0 → 0.48.0

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/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/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