ddtrace 0.50.0 → 0.53.0

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'
 

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,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/rack/configuration/settings'
 require 'ddtrace/contrib/rack/patcher'

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-require 'ddtrace'
+# typed: ignore
 
 # Railtie to include AutoInstrumentation in rails loading
 class DatadogAutoInstrumentRailtie < Rails::Railtie

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

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

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

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

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

@@ -1,12 +1,16 @@
+# 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'
+require 'ddtrace/contrib/lograge/integration'
+require 'ddtrace/contrib/semantic_logger/integration'
 
 require 'ddtrace/contrib/rails/ext'
 require 'ddtrace/contrib/rails/utils'
@@ -42,10 +46,14 @@ 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)
           end
         end
 
@@ -53,7 +61,7 @@ module Datadog
           # We set defaults here instead of in the patcher because we need to wait
           # for the Rails application to be fully initialized.
           datadog_config[:rails].tap do |config|
-            config[:service_name] ||= (Datadog.configuration.service || Utils.app_name)
+            config[:service_name] ||= (Datadog.configure.service_without_fallback || Utils.app_name)
             config[:database_service] ||= "#{config[:service_name]}-#{Contrib::ActiveRecord::Utils.adapter_name}"
             config[:controller_service] ||= config[:service_name]
             config[:cache_service] ||= "#{config[:service_name]}-cache"
@@ -88,6 +96,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)
 
@@ -110,6 +127,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[:service_name]}-#{Contrib::ActiveJob::Ext::SERVICE_NAME}",
+            log_injection: rails_config[:log_injection]
+          )
+        end
+
         def self.activate_active_record!(datadog_config, rails_config)
           return unless defined?(::ActiveRecord)
 
@@ -118,6 +145,26 @@ module Datadog
             service_name: rails_config[:database_service]
           )
         end
+
+        def self.activate_lograge!(datadog_config, rails_config)
+          return unless defined?(::Lograge)
+
+          if rails_config[:log_injection]
+            datadog_config.use(
+              :lograge
+            )
+          end
+        end
+
+        def self.activate_semantic_logger!(datadog_config, rails_config)
+          return unless defined?(::SemanticLogger)
+
+          if rails_config[:log_injection]
+            datadog_config.use(
+              :semantic_logger
+            )
+          end
+        end
       end
     end
   end

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.
@@ -6,46 +7,6 @@ module Datadog
       module LogInjection
         module_function
 
-        def add_lograge_logger(app)
-          # custom_options defaults to nil and can be either a hash or a lambda which returns a hash
-          # https://github.com/roidrage/lograge/blob/1729eab7956bb95c5992e4adab251e4f93ff9280/lib/lograge.rb#L28
-          if (custom_options = app.config.lograge.custom_options).nil?
-            # if it's not set, we set to a lambda that returns DD tracing context
-            app.config.lograge.custom_options = lambda do |_event|
-              # Retrieves trace information for current thread
-              correlation = Datadog.tracer.active_correlation
-
-              datadog_trace_log_hash(correlation)
-            end
-          # check if lambda, if so then define a new lambda which invokes the original lambda and
-          # merges the returned hash with the the DD tracing context hash.
-          elsif custom_options.respond_to?(:call)
-            app.config.lograge.custom_options = lambda do |event|
-              # invoke original lambda
-              result = custom_options.call(event)
-              # Retrieves trace information for current thread
-              correlation = Datadog.tracer.active_correlation
-              # merge original lambda with datadog context
-              result.merge(datadog_trace_log_hash(correlation))
-            end
-          # otherwise if it's just a static hash, we have to wrap that hash in a lambda to retrieve
-          # the DD tracing context, then merge the tracing context with the original static hash.
-          # don't modify if custom_options is not an accepted format.
-          elsif custom_options.is_a?(Hash)
-            app.config.lograge.custom_options = lambda do |_event|
-              # Retrieves trace information for current thread
-              correlation = Datadog.tracer.active_correlation
-
-              # merge original lambda with datadog context
-              custom_options.merge(datadog_trace_log_hash(correlation))
-            end
-          end
-        rescue StandardError => e
-          # TODO: can we use Datadog.logger at this point?
-          Datadog.logger.warn("Unable to add Datadog Trace context to Lograge: #{e.message}")
-          false
-        end
-
         def add_as_tagged_logging_logger(app)
           # we want to check if the current logger is a tagger logger instance
           # log_tags defaults to nil so we have to set as an array if nothing exists yet

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,8 +1,10 @@
+# typed: ignore
 require 'ddtrace/contrib/rails/utils'
 require 'ddtrace/contrib/rails/framework'
 require 'ddtrace/contrib/rails/middlewares'
 require 'ddtrace/contrib/rails/log_injection'
 require 'ddtrace/contrib/rack/middlewares'
+require 'ddtrace/contrib/semantic_logger/patcher'
 require 'ddtrace/utils/only_once'
 
 module Datadog
@@ -43,32 +45,42 @@ 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)
           should_warn = true
           # check if lograge key exists
           # Note: Rails executes initializers sequentially based on alphabetical order,
-          # and lograge config could occur after dd config.
-          # Checking for `app.config.lograge.enabled` may yield a false negative.
-          # Instead we should naively add custom options if `config.lograge` exists from the lograge Railtie,
-          # since the custom options get ignored without lograge explicitly being enabled.
-          # See: https://github.com/roidrage/lograge/blob/1729eab7956bb95c5992e4adab251e4f93ff9280/lib/lograge/railtie.rb#L7-L12
-          if app.config.respond_to?(:lograge)
-            Datadog::Contrib::Rails::LogInjection.add_lograge_logger(app)
-            should_warn = false
-          end
+          # and lograge config could occur after datadog config.
+          # So checking for `app.config.lograge.enabled` may yield a false negative,
+          # and adding custom options naively if `config.lograge` exists from the lograge Railtie,
+          # is inconsistent since a lograge initializer would override it.
+          # Instead, we patch Lograge `custom_options` internals directly
+          # as part of Rails framework patching
+          # and just flag off the warning log here.
+          # SemanticLogger we similarly patch in the after_initiaize block, and should flag
+          # off the warning log here if we know we'll patch this gem later.
+          should_warn = false if app.config.respond_to?(:lograge) || defined?(::SemanticLogger)
 
           # if lograge isn't set, check if tagged logged is enabled.
           # if so, add proc that injects trace identifiers for tagged logging.

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/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'

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'

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

@@ -0,0 +1,19 @@
+# typed: false
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/semantic_logger/ext'
+
+module Datadog
+  module Contrib
+    module SemanticLogger
+      module Configuration
+        # Custom settings for the SemanticLogger integration
+        class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# typed: true
+module Datadog
+  module Contrib
+    module SemanticLogger
+      # SemanticLogger integration constants
+      module Ext
+        ENV_ENABLED = 'DD_TRACE_SEMANTIC_LOGGER_ENABLED'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: true
+module Datadog
+  module Contrib
+    module SemanticLogger
+      # Instrumentation for SemanticLogger
+      module Instrumentation
+        def self.included(base)
+          base.prepend(InstanceMethods)
+        end
+
+        # Instance methods for configuration
+        module InstanceMethods
+          def log(log, message = nil, progname = nil, &block)
+            original_named_tags = log.named_tags || {}
+
+            # Retrieves trace information for current thread
+            correlation = Datadog.tracer.active_correlation
+            # merge original lambda with datadog context
+
+            datadog_trace_log_hash = {
+              # Adds IDs as tags to log output
+              dd: {
+                # To preserve precision during JSON serialization, use strings for large numbers
+                trace_id: correlation.trace_id.to_s,
+                span_id: correlation.span_id.to_s,
+                env: correlation.env.to_s,
+                service: correlation.service.to_s,
+                version: correlation.version.to_s
+              },
+              ddsource: ['ruby']
+            }
+
+            # # if the user already has conflicting log_tags
+            # # we want them to clobber ours, because we should allow them to override
+            # # if needed.
+            log.named_tags = datadog_trace_log_hash.merge(original_named_tags)
+            super(log, message, progname, &block)
+          end
+        end
+      end
+    end
+  end
+end

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'