ddtrace 0.40.0 → 0.54.1

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

@@ -0,0 +1,48 @@
+# typed: false
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/semantic_logger/configuration/settings'
+require 'ddtrace/contrib/semantic_logger/patcher'
+
+module Datadog
+  module Contrib
+    module SemanticLogger
+      # Description of SemanticLogger integration
+      class Integration
+        include Contrib::Integration
+
+        # v4 had a migration to `named_tags` instead of `payload`
+        # and has been out for almost 5 years at this point
+        # it's probably reasonable to nudge users to using modern ruby libs
+        MINIMUM_VERSION = Gem::Version.new('4.0.0')
+
+        register_as :semantic_logger
+
+        def self.version
+          Gem.loaded_specs['semantic_logger'] && Gem.loaded_specs['semantic_logger'].version
+        end
+
+        def self.loaded?
+          !defined?(::SemanticLogger::Logger).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
+        end
+
+        # TODO: abstract out the log injection related instrumentation into it's own module so we dont
+        # keep having to do these workarounds
+        def auto_instrument?
+          false
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/semantic_logger/instrumentation'
+
+module Datadog
+  module Contrib
+    # Datadog SemanticLogger integration.
+    module SemanticLogger
+      # Patcher enables patching of 'semantic_logger' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def target_version
+          Integration.version
+        end
+
+        # patch applies our patch
+        def patch
+          ::SemanticLogger::Logger.include(Instrumentation)
+        end
+      end
+    end
+  end
+end

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'
@@ -10,7 +11,7 @@ module Datadog
       # Adds instrumentation to Sequel::Database
       module Database
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # Instance methods for instrumenting Sequel::Database
@@ -24,7 +25,7 @@ module Datadog
               span.service = datadog_pin.service
               span.resource = opts[:query]
               span.span_type = Datadog::Ext::SQL::TYPE
-              Utils.set_analytics_sample_rate(span)
+              Utils.set_common_tags(span)
               span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
               response = super(sql, options)
             end
@@ -52,6 +53,8 @@ module Datadog
                       elsif instance_variable_defined?(:@pool) && @pool
                         @pool.db.opts
                       end
+            sql = sql.is_a?(::Sequel::SQL::Expression) ? literal(sql) : sql.to_s
+
             Utils.parse_opts(sql, opts, db_opts)
           end
         end

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'
@@ -10,7 +11,7 @@ module Datadog
       # Adds instrumentation to Sequel::Dataset
       module Dataset
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # Instance methods for instrumenting Sequel::Dataset
@@ -38,15 +39,16 @@ module Datadog
           private
 
           def trace_execute(super_method, sql, options, &block)
-            opts = Utils.parse_opts(sql, options, db.opts)
+            opts = Utils.parse_opts(sql, options, db.opts, self)
             response = nil
 
             datadog_pin.tracer.trace(Ext::SPAN_QUERY) do |span|
               span.service = datadog_pin.service
               span.resource = opts[:query]
               span.span_type = Datadog::Ext::SQL::TYPE
-              Utils.set_analytics_sample_rate(span)
+              Utils.set_common_tags(span)
               span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
+              span.set_tag(Ext::TAG_PREPARED_NAME, opts[:prepared_name]) if opts[:prepared_name]
               response = super_method.call(sql, options, &block)
             end
             response

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Sequel
@@ -12,6 +13,7 @@ module Datadog
         SERVICE_NAME = 'sequel'.freeze
         SPAN_QUERY = 'sequel.query'.freeze
         TAG_DB_VENDOR = 'sequel.db.vendor'.freeze
+        TAG_PREPARED_NAME = 'sequel.prepared.name'.freeze
       end
     end
   end

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'
@@ -21,11 +22,11 @@ module Datadog
         end
 
         def patch_sequel_database
-          ::Sequel::Database.send(:include, Database)
+          ::Sequel::Database.include(Database)
         end
 
         def patch_sequel_dataset
-          ::Sequel::Dataset.send(:include, Dataset)
+          ::Sequel::Dataset.include(Dataset)
         end
       end
     end

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

@@ -1,3 +1,6 @@
+# typed: true
+require 'ddtrace/ext/integration'
+
 module Datadog
   module Contrib
     module Sequel
@@ -26,21 +29,29 @@ module Datadog
             Datadog::Utils::Database.normalize_vendor(database.database_type.to_s)
           end
 
-          def parse_opts(sql, opts, db_opts)
-            if ::Sequel::VERSION >= '4.37.0' && !sql.is_a?(String)
-              # In 4.37.0, sql was converted to a prepared statement object
-              sql = sql.prepared_sql unless sql.is_a?(Symbol)
+          def parse_opts(sql, opts, db_opts, dataset = nil)
+            # Prepared statements don't provide their sql query in the +sql+ parameter.
+            if !sql.is_a?(String) && (dataset && dataset.respond_to?(:prepared_sql) &&
+              (resolved_sql = dataset.prepared_sql))
+              # The dataset contains the resolved SQL query and prepared statement name.
+              prepared_name = dataset.prepared_statement_name
+              sql = resolved_sql
             end
 
             {
               name: opts[:type],
               query: sql,
+              prepared_name: prepared_name,
               database: db_opts[:database],
               host: db_opts[:host]
             }
           end
 
-          def set_analytics_sample_rate(span)
+          def set_common_tags(span)
+            # Tag as an external peer service
+            span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
+            # Set analytics sample rate
             Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
           end
 

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 
 module Datadog
@@ -22,6 +23,8 @@ module Datadog
           end
 
           option :service_name, default: Ext::SERVICE_NAME
+          option :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
+          option :tag_body, default: false
         end
       end
     end

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
@@ -8,10 +9,16 @@ module Datadog
         def initialize(options = {})
           @tracer = options[:tracer] || configuration[:tracer]
           @shoryuken_service = options[:service_name] || configuration[:service_name]
+          @error_handler = options[:error_handler] || configuration[:error_handler]
         end
 
         def call(worker_instance, queue, sqs_msg, body)
-          @tracer.trace(Ext::SPAN_JOB, service: @shoryuken_service, span_type: Datadog::Ext::AppTypes::WORKER) do |span|
+          @tracer.trace(
+            Ext::SPAN_JOB,
+            service: @shoryuken_service,
+            span_type: Datadog::Ext::AppTypes::WORKER,
+            on_error: @error_handler
+          ) do |span|
             # Set analytics sample rate
             if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
               Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
@@ -24,7 +31,7 @@ module Datadog
             span.set_tag(Ext::TAG_JOB_ID, sqs_msg.message_id)
             span.set_tag(Ext::TAG_JOB_QUEUE, queue)
             span.set_tag(Ext::TAG_JOB_ATTRIBUTES, sqs_msg.attributes) if sqs_msg.respond_to?(:attributes)
-            span.set_tag(Ext::TAG_JOB_BODY, body)
+            span.set_tag(Ext::TAG_JOB_BODY, body) if configuration[:tag_body]
 
             yield
           end

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'
 
@@ -29,6 +30,7 @@ module Datadog
 
           option :service_name, default: Ext::SERVICE_NAME
           option :client_service_name, default: Ext::CLIENT_SERVICE_NAME
+          option :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
         end
       end
     end

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'
 
@@ -11,6 +12,7 @@ module Datadog
         def initialize(options = {})
           super
           @sidekiq_service = options[:service_name] || configuration[:service_name]
+          @error_handler = options[:error_handler] || configuration[:error_handler]
         end
 
         def call(worker, job, queue)
@@ -19,7 +21,8 @@ module Datadog
           service = worker_config(resource, :service_name) || @sidekiq_service
           tag_args = worker_config(resource, :tag_args) || configuration[:tag_args]
 
-          @tracer.trace(Ext::SPAN_JOB, service: service, span_type: Datadog::Ext::AppTypes::WORKER) do |span|
+          @tracer.trace(Ext::SPAN_JOB, service: service, span_type: Datadog::Ext::AppTypes::WORKER,
+                                       on_error: @error_handler) do |span|
             span.resource = resource
             # Set analytics sample rate
             if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
@@ -35,9 +38,7 @@ module Datadog
             span.set_tag(Ext::TAG_JOB_QUEUE, job['queue'])
             span.set_tag(Ext::TAG_JOB_WRAPPER, job['class']) if job['wrapped']
             span.set_tag(Ext::TAG_JOB_DELAY, 1000.0 * (Time.now.utc.to_f - job['enqueued_at'].to_f))
-            if tag_args && !job['args'].nil? && !job['args'].empty?
-              span.set_tag(Ext::TAG_JOB_ARGS, job['args'])
-            end
+            span.set_tag(Ext::TAG_JOB_ARGS, job['args']) if tag_args && !job['args'].nil? && !job['args'].empty?
 
             yield
           end
@@ -57,9 +58,7 @@ module Datadog
             nil
           end
 
-          if worker_klass.respond_to?(:datadog_tracer_config)
-            worker_klass.datadog_tracer_config[key]
-          end
+          worker_klass.datadog_tracer_config[key] if worker_klass.respond_to?(:datadog_tracer_config)
         end
       end
     end

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/sidekiq/ext'
 
@@ -31,7 +32,6 @@ module Datadog
           job['class'].to_s
         end
 
-        #
         def delay_extension_class(job)
           clazz, method = YAML.parse(job['args'].first).children.first.children
 

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)
@@ -23,9 +25,7 @@ module Datadog
           {}.tap do |result|
             headers.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

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
@@ -18,9 +19,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/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
@@ -20,7 +22,7 @@ module Datadog
 
         def register_tracer
           ::Sinatra.send(:register, Datadog::Contrib::Sinatra::Tracer)
-          ::Sinatra::Base.send(:prepend, Sinatra::Tracer::Base)
+          ::Sinatra::Base.prepend(Sinatra::Tracer::Base)
         end
       end
     end