ddtrace 0.51.1 → 0.54.1

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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/sidekiq/configuration/settings'
 require 'ddtrace/contrib/sidekiq/patcher'
@@ -10,6 +11,7 @@ module Datadog
         include Contrib::Integration
 
         MINIMUM_VERSION = Gem::Version.new('3.5.4')
+        MINIMUM_SERVER_INTERNAL_TRACING_VERSION = Gem::Version.new('5.2.4')
 
         register_as :sidekiq
 
@@ -25,6 +27,15 @@ module Datadog
           super && version >= MINIMUM_VERSION
         end
 
+        # Only patch server internals on v5.2.4+ because that's when loading of
+        # `Sidekiq::Launcher` stabilized. Sidekiq 4+ technically can support our
+        # patches (with minor adjustments), but in order to avoid explicitly
+        # requiring `sidekiq/launcher` ourselves (which could affect gem
+        # initialization order), we are limiting this tracing to v5.2.4+.
+        def self.compatible_with_server_internal_tracing?
+          version >= MINIMUM_SERVER_INTERNAL_TRACING_VERSION
+        end
+
         def default_configuration
           Configuration::Settings.new
         end

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/patcher'
 
 module Datadog
@@ -33,8 +34,34 @@ module Datadog
             config.server_middleware do |chain|
               chain.add(Sidekiq::ServerTracer)
             end
+
+            patch_server_internals if Integration.compatible_with_server_internal_tracing?
           end
         end
+
+        def patch_server_internals
+          patch_server_heartbeat
+          patch_server_job_fetch
+          patch_server_scheduled_push
+        end
+
+        def patch_server_heartbeat
+          require 'ddtrace/contrib/sidekiq/server_internal_tracer/heartbeat'
+
+          ::Sidekiq::Launcher.prepend(ServerInternalTracer::Heartbeat)
+        end
+
+        def patch_server_job_fetch
+          require 'ddtrace/contrib/sidekiq/server_internal_tracer/job_fetch'
+
+          ::Sidekiq::Processor.prepend(ServerInternalTracer::JobFetch)
+        end
+
+        def patch_server_scheduled_push
+          require 'ddtrace/contrib/sidekiq/server_internal_tracer/scheduled_push'
+
+          ::Sidekiq::Scheduled::Poller.prepend(ServerInternalTracer::ScheduledPush)
+        end
       end
     end
   end

data/lib/ddtrace/contrib/sidekiq/server_internal_tracer/heartbeat.rb

@@ -0,0 +1,30 @@
+# typed: true
+
+module Datadog
+  module Contrib
+    module Sidekiq
+      module ServerInternalTracer
+        # Trace when a Sidekiq process has a heartbeat
+        module Heartbeat
+          private
+
+          def ❤ # rubocop:disable Naming/AsciiIdentifiers, Naming/MethodName
+            configuration = Datadog.configuration[:sidekiq]
+
+            configuration[:tracer].trace(Ext::SPAN_HEARTBEAT) do |span|
+              span.service = configuration[:service_name]
+              span.span_type = Datadog::Ext::AppTypes::WORKER
+
+              # Set analytics sample rate
+              if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+                Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+              end
+
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/sidekiq/server_internal_tracer/job_fetch.rb

@@ -0,0 +1,30 @@
+# typed: true
+
+module Datadog
+  module Contrib
+    module Sidekiq
+      module ServerInternalTracer
+        # Trace when Sidekiq looks for another job to work
+        module JobFetch
+          private
+
+          def fetch
+            configuration = Datadog.configuration[:sidekiq]
+
+            configuration[:tracer].trace(Ext::SPAN_JOB_FETCH) do |span|
+              span.service = configuration[:service_name]
+              span.span_type = Datadog::Ext::AppTypes::WORKER
+
+              # Set analytics sample rate
+              if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+                Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+              end
+
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/sidekiq/server_internal_tracer/scheduled_push.rb

@@ -0,0 +1,29 @@
+# typed: true
+
+module Datadog
+  module Contrib
+    module Sidekiq
+      module ServerInternalTracer
+        # Trace when Sidekiq checks to see if there are scheduled jobs that need to be worked
+        # https://github.com/mperham/sidekiq/wiki/Scheduled-Jobs
+        module ScheduledPush
+          def enqueue
+            configuration = Datadog.configuration[:sidekiq]
+
+            configuration[:tracer].trace(Ext::SPAN_SCHEDULED_PUSH) do |span|
+              span.service = configuration[:service_name]
+              span.span_type = Datadog::Ext::AppTypes::WORKER
+
+              # Set analytics sample rate
+              if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+                Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+              end
+
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

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

data/lib/ddtrace/contrib/sinatra/env.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/http'
 require 'ddtrace/contrib/sinatra/ext'
 
@@ -9,7 +10,8 @@ module Datadog
         module_function
 
         def datadog_span(env, app)
-          env[Ext::RACK_ENV_REQUEST_SPAN][app]
+          request_span = env[Ext::RACK_ENV_REQUEST_SPAN]
+          request_span && request_span[app]
         end
 
         def set_datadog_span(env, app, span)

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

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

data/lib/ddtrace/contrib/sinatra/headers.rb

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 
 module Datadog
@@ -5,6 +6,7 @@ module Datadog
     module Sinatra
       # Patcher enables patching of 'sinatra' 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/sinatra/tracer.rb

@@ -1,10 +1,11 @@
+# typed: false
 require 'sinatra/base'
 
 require 'ddtrace/ext/app_types'
 require 'ddtrace/ext/errors'
 require 'ddtrace/ext/http'
 require 'ddtrace/propagation/http_propagator'
-
+require 'ddtrace/utils/only_once'
 require 'ddtrace/contrib/sinatra/ext'
 require 'ddtrace/contrib/sinatra/tracer_middleware'
 require 'ddtrace/contrib/sinatra/env'
@@ -76,6 +77,9 @@ module Datadog
 
         # Method overrides for Sinatra::Base
         module Base
+          MISSING_REQUEST_SPAN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+          private_constant :MISSING_REQUEST_SPAN_ONLY_ONCE
+
           def render(engine, data, *)
             tracer = Datadog.configuration[:sinatra][:tracer]
             return super unless tracer.enabled
@@ -104,10 +108,9 @@ module Datadog
             tracer.trace(
               Ext::SPAN_ROUTE,
               service: configuration[:service_name],
-              span_type: Datadog::Ext::HTTP::TYPE_INBOUND
+              span_type: Datadog::Ext::HTTP::TYPE_INBOUND,
+              resource: "#{request.request_method} #{@datadog_route}",
             ) do |span|
-              span.resource = "#{request.request_method} #{@datadog_route}"
-
               span.set_tag(Ext::TAG_APP_NAME, settings.name || settings.superclass.name)
               span.set_tag(Ext::TAG_ROUTE_PATH, @datadog_route)
               span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name) if request.script_name && !request.script_name.empty?
@@ -115,6 +118,26 @@ module Datadog
               rack_request_span = env[Datadog::Contrib::Rack::TraceMiddleware::RACK_REQUEST_SPAN]
               rack_request_span.resource = span.resource if rack_request_span
 
+              sinatra_request_span =
+                if self.class <= ::Sinatra::Application # Classic style (top-level) application
+                  Sinatra::Env.datadog_span(env, ::Sinatra::Application)
+                else
+                  Sinatra::Env.datadog_span(env, self.class)
+                end
+              if sinatra_request_span
+                sinatra_request_span.resource = span.resource
+              else
+                MISSING_REQUEST_SPAN_ONLY_ONCE.run do
+                  Datadog.logger.warn do
+                    'Sinatra integration is misconfigured, reported traces will be missing request metadata ' \
+                    'such as path and HTTP status code. ' \
+                    'Did you forget to add `register Datadog::Contrib::Sinatra::Tracer` to your ' \
+                    '`Sinatra::Base` subclass? ' \
+                    'See <https://docs.datadoghq.com/tracing/setup_overview/setup/ruby/#sinatra> for more details.'
+                  end
+                end
+              end
+
               Contrib::Analytics.set_measured(span)
 
               super