ddtrace 0.42.0 → 0.54.2

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

@@ -0,0 +1,36 @@
+# typed: false
+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,21 @@
+# typed: true
+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,39 @@
+# typed: false
+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 @@
+# typed: true
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+
+module Datadog
+  module Contrib
+    module Qless
+      # Patcher enables patching of 'qless' module.
+      module Patcher
+        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+        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
+          # These are executed in inverse order of listing here
+          ::Qless::Workers::BaseWorker.include(QlessJob)
+          ::Qless::Workers::BaseWorker.include(TracerCleaner)
+        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,74 @@
+# typed: false
+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,34 @@
+# typed: true
+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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'ddtrace/contrib/configuration/settings'
@@ -35,6 +36,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

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Datadog
@@ -5,25 +6,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/integration.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'ddtrace/contrib/integration'

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'ddtrace/contrib/que/tracer'

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

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'ddtrace/contrib/analytics'
@@ -9,8 +10,9 @@ module Datadog
       class Tracer
         def call(job)
           trace_options = {
-            service:   configuration[:service_name],
-            span_type: Datadog::Ext::AppTypes::WORKER
+            service: configuration[:service_name],
+            span_type: Datadog::Ext::AppTypes::WORKER,
+            on_error: configuration[:error_handler]
           }
 
           tracer.trace(Ext::SPAN_JOB, trace_options) do |request_span|

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/racecar/ext'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/active_support/notifications/event'
 require 'ddtrace/contrib/racecar/ext'
@@ -9,8 +10,8 @@ module Datadog
       # Defines basic behaviors for an ActiveRecord event.
       module Event
         def self.included(base)
-          base.send(:include, ActiveSupport::Notifications::Event)
-          base.send(:extend, ClassMethods)
+          base.include(ActiveSupport::Notifications::Event)
+          base.extend(ClassMethods)
         end
 
         # Class methods for Racecar events.
@@ -66,6 +67,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/racecar/events/batch.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/racecar/ext'
 require 'ddtrace/contrib/racecar/event'
 

data/lib/ddtrace/contrib/racecar/events/consume.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/racecar/ext'
 require 'ddtrace/contrib/racecar/event'
 

data/lib/ddtrace/contrib/racecar/events/message.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/racecar/ext'
 require 'ddtrace/contrib/racecar/event'
 

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/racecar/events/batch'
 require 'ddtrace/contrib/racecar/events/message'
 require 'ddtrace/contrib/racecar/events/consume'

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Racecar

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/racecar/configuration/settings'
 require 'ddtrace/contrib/racecar/patcher'

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/racecar/ext'

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/rack/ext'
 
@@ -8,9 +9,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/ext.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Rack

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

@@ -1,6 +1,8 @@
+# typed: false
 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 +27,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

@@ -1,10 +1,11 @@
+# typed: false
 require 'ddtrace/ext/app_types'
 require 'ddtrace/ext/http'
 require 'ddtrace/propagation/http_propagator'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/rack/ext'
 require 'ddtrace/contrib/rack/request_queue'
-require 'ddtrace/environment'
+require 'datadog/core/environment/variable_helpers'
 require 'date'
 
 module Datadog
@@ -53,7 +54,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 +132,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 +201,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 +258,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 +273,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

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

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Contrib
     module Rack
@@ -53,9 +54,7 @@ module Datadog
             end
           end
 
-          following = if middleware.instance_variable_defined?('@app')
-                        middleware.instance_variable_get('@app')
-                      end
+          following = (middleware.instance_variable_get('@app') if middleware.instance_variable_defined?('@app'))
 
           retain_middleware_name(following)
         end

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

@@ -1,7 +1,13 @@
+# typed: true
 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 @@
+# typed: ignore
+
+# 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/configuration/settings.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 
 module Datadog
@@ -72,6 +73,13 @@ module Datadog
             end
           end
 
+          option :job_service do |o|
+            o.on_set do |value|
+              # Update ActiveJob service name too
+              Datadog.configuration[:active_job][:service_name] = value
+            end
+          end
+
           option :middleware, default: true
           option :middleware_names, default: false
           option :template_base_path do |o|

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Rails