ddtrace 0.51.1 → 0.54.2

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

@@ -1,9 +1,11 @@
+# typed: false
 require 'ddtrace/pin'
 require 'ddtrace/ext/app_types'
 
 require 'ddtrace/contrib/active_record/integration'
 require 'ddtrace/contrib/active_support/integration'
 require 'ddtrace/contrib/action_cable/integration'
+require 'ddtrace/contrib/action_mailer/integration'
 require 'ddtrace/contrib/action_pack/integration'
 require 'ddtrace/contrib/action_view/integration'
 require 'ddtrace/contrib/grape/endpoint'
@@ -20,7 +22,7 @@ module Datadog
       # Rails framework code, used to essentially:
       # - handle configuration entries which are specific to Datadog tracing
       # - instrument parts of the framework when needed
-      module Framework
+      module Framework # rubocop:disable Metrics/ModuleLength
         # After the Rails application finishes initializing, we configure the Rails
         # integration and all its sub-components with the application information
         # available.
@@ -44,9 +46,11 @@ module Datadog
 
             activate_rack!(datadog_config, rails_config)
             activate_action_cable!(datadog_config, rails_config)
+            activate_action_mailer!(datadog_config, rails_config)
             activate_active_support!(datadog_config, rails_config)
             activate_action_pack!(datadog_config, rails_config)
             activate_action_view!(datadog_config, rails_config)
+            activate_active_job!(datadog_config, rails_config)
             activate_active_record!(datadog_config, rails_config)
             activate_lograge!(datadog_config, rails_config)
             activate_semantic_logger!(datadog_config, rails_config)
@@ -61,6 +65,7 @@ module Datadog
             config[:database_service] ||= "#{config[:service_name]}-#{Contrib::ActiveRecord::Utils.adapter_name}"
             config[:controller_service] ||= config[:service_name]
             config[:cache_service] ||= "#{config[:service_name]}-cache"
+            config[:job_service] ||= "#{config[:service_name]}-#{Contrib::ActiveJob::Ext::SERVICE_NAME}"
           end
         end
 
@@ -92,6 +97,15 @@ module Datadog
           )
         end
 
+        def self.activate_action_mailer!(datadog_config, rails_config)
+          return unless defined?(::ActionMailer)
+
+          datadog_config.use(
+            :action_mailer,
+            service_name: "#{rails_config[:service_name]}-#{Contrib::ActionMailer::Ext::SERVICE_NAME}"
+          )
+        end
+
         def self.activate_action_pack!(datadog_config, rails_config)
           return unless defined?(::ActionPack)
 
@@ -114,6 +128,16 @@ module Datadog
           )
         end
 
+        def self.activate_active_job!(datadog_config, rails_config)
+          return unless defined?(::ActiveJob)
+
+          datadog_config.use(
+            :active_job,
+            service_name: rails_config[:job_service],
+            log_injection: rails_config[:log_injection]
+          )
+        end
+
         def self.activate_active_record!(datadog_config, rails_config)
           return unless defined?(::ActiveRecord)
 

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

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

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

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Contrib
     # Instrument Rails.

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/http'
 require 'ddtrace/contrib/action_pack/utils'
 

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

@@ -1,3 +1,4 @@
+# typed: ignore
 require 'ddtrace/contrib/rails/utils'
 require 'ddtrace/contrib/rails/framework'
 require 'ddtrace/contrib/rails/middlewares'
@@ -44,17 +45,26 @@ module Datadog
         end
 
         def add_middleware(app)
-          # Add trace middleware
+          # Add trace middleware at the top of the middleware stack,
+          # to ensure we capture the complete execution time.
           app.middleware.insert_before(0, Datadog::Contrib::Rack::TraceMiddleware)
 
-          # Insert right after Rails exception handling middleware, because if it's before,
-          # it catches and swallows the error. If it's too far after, custom middleware can find itself
-          # between, and raise exceptions that don't end up getting tagged on the request properly.
-          # e.g lost stack trace.
-          app.middleware.insert_after(
-            ActionDispatch::ShowExceptions,
-            Datadog::Contrib::Rails::ExceptionMiddleware
-          )
+          # Some Rails middleware can swallow an application error, preventing
+          # the error propagation to the encompassing Rack span.
+          #
+          # We insert our own middleware right before these Rails middleware
+          # have a chance to swallow the error.
+          #
+          # Note: because the middleware stack is push/pop, "before" and "after" are reversed
+          # for our use case: we insert ourselves with "after" a middleware to ensure we are
+          # able to pop the request "before" it.
+          if defined?(::ActionDispatch::DebugExceptions)
+            # Rails >= 3.2
+            app.middleware.insert_after(::ActionDispatch::DebugExceptions, Datadog::Contrib::Rails::ExceptionMiddleware)
+          else
+            # Rails < 3.2
+            app.middleware.insert_after(::ActionDispatch::ShowExceptions, Datadog::Contrib::Rails::ExceptionMiddleware)
+          end
         end
 
         def add_logger(app)

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

@@ -1,3 +1,4 @@
+# typed: ignore
 require 'ddtrace/contrib/rails/framework'
 require 'ddtrace/contrib/rails/middlewares'
 require 'ddtrace/contrib/rack/middlewares'

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/analytics'
 
 module Datadog

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

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

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

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

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

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

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

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

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

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

data/lib/ddtrace/contrib/redis/configuration/resolver.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/redis/vendor/resolver'
 
 module Datadog

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

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

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

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

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

@@ -0,0 +1,90 @@
+# typed: false
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/redis/ext'
+require 'ddtrace/contrib/redis/configuration/resolver'
+
+module Datadog
+  module Contrib
+    module Redis
+      # Instrumentation for Redis
+      module Instrumentation
+        def self.included(base)
+          base.prepend(InstanceMethods)
+        end
+
+        # InstanceMethods - implementing instrumentation
+        module InstanceMethods
+          def call(*args, &block)
+            pin = Datadog::Pin.get_from(self)
+            return super unless pin && pin.tracer
+
+            response = nil
+            pin.tracer.trace(Datadog::Contrib::Redis::Ext::SPAN_COMMAND) do |span|
+              span.service = pin.service
+              span.span_type = Datadog::Contrib::Redis::Ext::TYPE
+              span.resource = get_command(args)
+              Datadog::Contrib::Redis::Tags.set_common_tags(self, span)
+
+              response = super
+            end
+
+            response
+          end
+
+          def call_pipeline(*args, &block)
+            pin = Datadog::Pin.get_from(self)
+            return super unless pin && pin.tracer
+
+            response = nil
+            pin.tracer.trace(Datadog::Contrib::Redis::Ext::SPAN_COMMAND) do |span|
+              span.service = pin.service
+              span.span_type = Datadog::Contrib::Redis::Ext::TYPE
+              commands = get_pipeline_commands(args)
+              span.resource = commands.join("\n")
+              span.set_metric Datadog::Contrib::Redis::Ext::METRIC_PIPELINE_LEN, commands.length
+              Datadog::Contrib::Redis::Tags.set_common_tags(self, span)
+
+              response = super
+            end
+
+            response
+          end
+
+          def datadog_pin
+            @datadog_pin ||= begin
+              pin = Datadog::Pin.new(
+                datadog_configuration[:service_name],
+                app: Ext::APP,
+                app_type: Datadog::Ext::AppTypes::DB,
+                tracer: -> { datadog_configuration[:tracer] }
+              )
+              pin.onto(self)
+            end
+          end
+
+          private
+
+          def get_command(args)
+            if datadog_configuration[:command_args]
+              Datadog::Contrib::Redis::Quantize.format_command_args(*args)
+            else
+              Datadog::Contrib::Redis::Quantize.get_verb(*args)
+            end
+          end
+
+          def get_pipeline_commands(args)
+            if datadog_configuration[:command_args]
+              args[0].commands.map { |c| Datadog::Contrib::Redis::Quantize.format_command_args(c) }
+            else
+              args[0].commands.map { |c| Datadog::Contrib::Redis::Quantize.get_verb(c) }
+            end
+          end
+
+          def datadog_configuration
+            Datadog.configuration[:redis, options]
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/redis/ext'
 require 'ddtrace/contrib/redis/configuration/resolver'
@@ -22,92 +23,10 @@ module Datadog
           require 'ddtrace/ext/app_types'
           require 'ddtrace/contrib/redis/tags'
           require 'ddtrace/contrib/redis/quantize'
+          require 'ddtrace/contrib/redis/instrumentation'
 
-          patch_redis_client
+          ::Redis::Client.include(Instrumentation)
         end
-
-        # rubocop:disable Metrics/MethodLength
-        # rubocop:disable Metrics/BlockLength
-        # rubocop:disable Metrics/AbcSize
-        def patch_redis_client
-          ::Redis::Client.class_eval do
-            alias_method :call_without_datadog, :call
-            remove_method :call
-            def call(*args, &block)
-              pin = Datadog::Pin.get_from(self)
-              return call_without_datadog(*args, &block) unless pin && pin.tracer
-
-              response = nil
-              pin.tracer.trace(Datadog::Contrib::Redis::Ext::SPAN_COMMAND) do |span|
-                span.service = pin.service
-                span.span_type = Datadog::Contrib::Redis::Ext::TYPE
-                span.resource = get_command(args)
-                Datadog::Contrib::Redis::Tags.set_common_tags(self, span)
-
-                response = call_without_datadog(*args, &block)
-              end
-
-              response
-            end
-
-            alias_method :call_pipeline_without_datadog, :call_pipeline
-            remove_method :call_pipeline
-            def call_pipeline(*args, &block)
-              pin = Datadog::Pin.get_from(self)
-              return call_pipeline_without_datadog(*args, &block) unless pin && pin.tracer
-
-              response = nil
-              pin.tracer.trace(Datadog::Contrib::Redis::Ext::SPAN_COMMAND) do |span|
-                span.service = pin.service
-                span.span_type = Datadog::Contrib::Redis::Ext::TYPE
-                commands = get_pipeline_commands(args)
-                span.resource = commands.join("\n")
-                span.set_metric Datadog::Contrib::Redis::Ext::METRIC_PIPELINE_LEN, commands.length
-                Datadog::Contrib::Redis::Tags.set_common_tags(self, span)
-
-                response = call_pipeline_without_datadog(*args, &block)
-              end
-
-              response
-            end
-
-            def datadog_pin
-              @datadog_pin ||= begin
-                pin = Datadog::Pin.new(
-                  datadog_configuration[:service_name],
-                  app: Ext::APP,
-                  app_type: Datadog::Ext::AppTypes::DB,
-                  tracer: -> { datadog_configuration[:tracer] }
-                )
-                pin.onto(self)
-              end
-            end
-
-            private
-
-            def get_command(args)
-              if datadog_configuration[:command_args]
-                Datadog::Contrib::Redis::Quantize.format_command_args(*args)
-              else
-                Datadog::Contrib::Redis::Quantize.get_verb(*args)
-              end
-            end
-
-            def get_pipeline_commands(args)
-              if datadog_configuration[:command_args]
-                args[0].commands.map { |c| Datadog::Contrib::Redis::Quantize.format_command_args(c) }
-              else
-                args[0].commands.map { |c| Datadog::Contrib::Redis::Quantize.get_verb(c) }
-              end
-            end
-
-            def datadog_configuration
-              Datadog.configuration[:redis, options]
-            end
-          end
-        end
-        # rubocop:enable Metrics/MethodLength
-        # rubocop:enable Metrics/BlockLength
       end
     end
   end

data/lib/ddtrace/contrib/redis/quantize.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'set'
 
 module Datadog

data/lib/ddtrace/contrib/redis/tags.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/integration'
 require 'ddtrace/ext/net'
 require 'ddtrace/contrib/analytics'

data/lib/ddtrace/contrib/redis/vendor/resolver.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'uri'
 
 # NOTE: This code is copied directly from Redis.

data/lib/ddtrace/contrib/registerable.rb

@@ -1,4 +1,4 @@
-require 'ddtrace/contrib/registry'
+# typed: false
 
 module Datadog
   module Contrib
@@ -12,7 +12,7 @@ module Datadog
       # Class methods for registerable behavior
       module ClassMethods
         def register_as(name, options = {})
-          registry = options.fetch(:registry, Datadog.registry)
+          registry = options.fetch(:registry, Contrib::REGISTRY)
           auto_patch = options.fetch(:auto_patch, false)
 
           registry.add(name, new(name, options), auto_patch)

data/lib/ddtrace/contrib/registry.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     # Registry is a collection of integrations.

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

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/resque/configuration/settings'
 require 'ddtrace/contrib/resque/patcher'
@@ -10,8 +11,6 @@ module Datadog
         include Contrib::Integration
 
         MINIMUM_VERSION = Gem::Version.new('1.0')
-        # Maximum is first version it's NOT compatible with (not inclusive)
-        MAXIMUM_VERSION = Gem::Version.new('3.0')
 
         register_as :resque, auto_patch: true
 
@@ -24,9 +23,7 @@ module Datadog
         end
 
         def self.compatible?
-          super \
-            && version >= MINIMUM_VERSION \
-            && version < MAXIMUM_VERSION
+          super && version >= MINIMUM_VERSION
         end
 
         def default_configuration

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

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

data/lib/ddtrace/contrib/resque/resque_job.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/app_types'
 require 'ddtrace/sync_writer'
 require 'ddtrace/contrib/analytics'

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

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

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

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

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

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

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

@@ -1,8 +1,10 @@
+# typed: true
 module Datadog
   module Contrib
     module RestClient
       # Patcher enables patching of 'rest_client' module.
       module Patcher
+        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
         include Contrib::Patcher
 
         module_function

data/lib/ddtrace/contrib/rest_client/request_patch.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/distributed'
 require 'ddtrace/ext/integration'

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

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

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

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

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

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/semantic_logger/instrumentation'
 

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

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

data/lib/ddtrace/contrib/sequel/database.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/sql'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/analytics'

data/lib/ddtrace/contrib/sequel/dataset.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/sql'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/analytics'

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

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/sequel/database'
 require 'ddtrace/contrib/sequel/dataset'

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/integration'
 
 module Datadog

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

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

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

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/shoryuken/tracer'
 
 module Datadog

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/analytics'
 
 module Datadog

data/lib/ddtrace/contrib/sidekiq/client_tracer.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/sidekiq/tracing'
 require 'ddtrace/contrib/analytics'
 

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

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

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Sidekiq
@@ -14,6 +15,9 @@ module Datadog
         SERVICE_NAME = 'sidekiq'.freeze
         SPAN_PUSH = 'sidekiq.push'.freeze
         SPAN_JOB = 'sidekiq.job'.freeze
+        SPAN_JOB_FETCH = 'sidekiq.job_fetch'.freeze
+        SPAN_HEARTBEAT = 'sidekiq.heartbeat'.freeze
+        SPAN_SCHEDULED_PUSH = 'sidekiq.scheduled_push'.freeze
         TAG_JOB_DELAY = 'sidekiq.job.delay'.freeze
         TAG_JOB_ID = 'sidekiq.job.id'.freeze
         TAG_JOB_QUEUE = 'sidekiq.job.queue'.freeze