ddtrace 0.42.0 → 0.52.0

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

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

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'
@@ -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,4 @@
+# typed: true
 require 'ddtrace/ext/integration'
 
 module Datadog
@@ -30,12 +31,11 @@ module Datadog
 
           def parse_opts(sql, opts, db_opts, dataset = nil)
             # Prepared statements don't provide their sql query in the +sql+ parameter.
-            unless sql.is_a?(String)
-              if 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
+            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
 
             {

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

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'

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

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

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'
 
@@ -23,9 +24,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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'sinatra/base'
 
 require 'ddtrace/ext/app_types'
@@ -104,19 +105,26 @@ 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)
-              if request.script_name && !request.script_name.empty?
-                span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name)
-              end
+              span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name) if request.script_name && !request.script_name.empty?
 
               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 # DEV: Is it possible for sinatra_request_span to ever be nil here?
+                sinatra_request_span.resource = span.resource
+              end
+
               Contrib::Analytics.set_measured(span)
 
               super

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/sinatra/ext'
 require 'ddtrace/contrib/sinatra/env'
@@ -8,13 +9,15 @@ module Datadog
     module Sinatra
       # Middleware used for automatically tagging configured headers and handle request span
       class TracerMiddleware
-        def initialize(app, app_instance: nil)
+        def initialize(app, opt = {})
           @app = app
-          @app_instance = app_instance
+          @app_instance = opt[:app_instance]
         end
 
         # rubocop:disable Metrics/AbcSize
         # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/PerceivedComplexity
         def call(env)
           # Set the trace context (e.g. distributed tracing)
           if configuration[:distributed_tracing] && tracer.provider.context.trace_id.nil?
@@ -26,7 +29,9 @@ module Datadog
             Ext::SPAN_REQUEST,
             service: configuration[:service_name],
             span_type: Datadog::Ext::HTTP::TYPE_INBOUND,
-            resource: env['REQUEST_METHOD']
+            # this is kept nil until we set a correct one (either in the route or with a fallback in the ensure below)
+            # the nil signals that there's no good one yet and is also seen by profiler, when sampling the resource
+            resource: nil,
           ) do |span|
             begin
               Sinatra::Env.set_datadog_span(env, @app_instance, span)
@@ -40,12 +45,14 @@ module Datadog
               request = ::Sinatra::Request.new(env)
               span.set_tag(Datadog::Ext::HTTP::URL, request.path)
               span.set_tag(Datadog::Ext::HTTP::METHOD, request.request_method)
-              if request.script_name && !request.script_name.empty?
-                span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name)
-              end
+              span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name) if request.script_name && !request.script_name.empty?
 
               span.set_tag(Ext::TAG_APP_NAME, @app_instance.settings.name)
 
+              # If this app handled the request, then Contrib::Sinatra::Tracer OR Contrib::Sinatra::Base set the
+              # resource; if no resource was set, let's use a fallback
+              span.resource = env['REQUEST_METHOD'] if span.resource.nil?
+
               # TODO: This backfills the non-matching Sinatra app with a "#{method} #{path}"
               # TODO: resource name. This shouldn't be the case, as that app has never handled
               # TODO: the response with that resource.