ddtrace 0.49.0 → 0.52.0

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

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

data/lib/ddtrace/contrib/analytics.rb

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

data/lib/ddtrace/contrib/auto_instrument.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace'
 
 module Datadog
@@ -6,7 +7,7 @@ module Datadog
     # AutoInstrumentation enables all integration
     module AutoInstrument
       def self.extended(base)
-        base.send(:extend, Patch)
+        base.extend(Patch)
       end
 
       # Patch adds method for invoking auto_instrumentation
@@ -25,7 +26,7 @@ module Datadog
       def self.patch_all
         integrations = []
 
-        Datadog.registry.each do |integration|
+        Contrib::REGISTRY.each do |integration|
           # some instrumentations are automatically enabled when the `rails` instrumentation is enabled,
           # patching them on their own automatically outside of the rails integration context would
           # cause undesirable service naming, so we exclude them based their auto_instrument? setting.

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

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: ignore
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/aws/ext'
 require 'ddtrace/ext/http'
@@ -56,6 +57,35 @@ module Datadog
           Datadog.configuration[:aws]
         end
       end
+
+      # Removes API request instrumentation from S3 Presign URL creation.
+      #
+      # This is necessary because the S3 SDK invokes the same handler
+      # stack for presigning as it does for sending a real requests.
+      # But presigning does not perform a network request.
+      # There's not information available for our Handler plugin to differentiate
+      # these two types of requests.
+      #
+      # DEV: Since aws-sdk-s3 1.94.1, we only need to check if
+      # `context[:presigned_url] == true` in Datadog::Contrib::Aws::Handler#call
+      # and skip the request if that condition is true. Since there's
+      # no strong reason for us not to support older versions of `aws-sdk-s3`,
+      # this {S3Presigner} monkey-patching is still required.
+      module S3Presigner
+        # Exclude our Handler from the current request's handler stack.
+        #
+        # This is the same approach that the AWS SDK takes to prevent
+        # some of its plugins form interfering with the presigning process:
+        # https://github.com/aws/aws-sdk-ruby/blob/a82c8981c95a8296ffb6269c3c06a4f551d87f7d/gems/aws-sdk-s3/lib/aws-sdk-s3/presigner.rb#L194-L196
+        def sign_but_dont_send(*args, &block)
+          if (request = args[0]).is_a?(::Seahorse::Client::Request)
+            request.handlers.remove(Handler)
+          end
+
+          super(*args, &block)
+        end
+        ruby2_keywords :sign_but_dont_send if respond_to?(:ruby2_keywords, true)
+      end
     end
   end
 end

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

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

data/lib/ddtrace/contrib/aws/parsed_context.rb

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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/aws/ext'
 
@@ -20,6 +21,10 @@ module Datadog
           require 'ddtrace/contrib/aws/services'
 
           add_plugin(Seahorse::Client::Base, *loaded_constants)
+
+          # Special handling for S3 URL Presigning.
+          # @see {Datadog::Contrib::Aws::S3Presigner}
+          ::Aws::S3::Presigner.prepend(S3Presigner) if defined?(::Aws::S3::Presigner)
         end
 
         def add_plugin(*targets)

data/lib/ddtrace/contrib/aws/services.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     # rubocop:disable Metrics/ModuleLength:

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

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

data/lib/ddtrace/contrib/concurrent_ruby/context_composite_executor_service.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'concurrent/executor/executor_service'
 
 module Datadog

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

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

data/lib/ddtrace/contrib/concurrent_ruby/future_patch.rb

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 
 module Datadog
@@ -5,6 +6,7 @@ module Datadog
     module ConcurrentRuby
       # Patcher enables patching of 'Future' class.
       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
 
         # Propagate tracing context in Concurrent::Future
         def patch_future
-          ::Concurrent::Future.send(:include, FuturePatch)
+          ::Concurrent::Future.include(FuturePatch)
         end
       end
     end

data/lib/ddtrace/contrib/configurable.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/configuration/resolver'
 require 'ddtrace/contrib/configuration/settings'
 
@@ -10,7 +11,7 @@ module Datadog
     # fallback.
     module Configurable
       def self.included(base)
-        base.send(:include, InstanceMethods)
+        base.include(InstanceMethods)
       end
 
       # Configurable instance behavior for integrations

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

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

data/lib/ddtrace/contrib/configuration/resolvers/pattern_resolver.rb

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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/configuration/base'
 require 'ddtrace/utils/only_once'
 

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

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/integration'
 require 'ddtrace/ext/net'
 require 'ddtrace/contrib/analytics'
@@ -10,7 +11,7 @@ module Datadog
       # Instruments every interaction with the memcached server
       module Instrumentation
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # InstanceMethods - implementing instrumentation

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

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

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/dalli/ext'
@@ -17,7 +18,7 @@ module Datadog
         end
 
         def patch
-          ::Dalli::Server.send(:include, Instrumentation)
+          ::Dalli::Server.include(Instrumentation)
         end
       end
     end

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

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

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

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

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

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

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

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

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

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

data/lib/ddtrace/contrib/delayed_job/plugin.rb

@@ -1,3 +1,4 @@
+# typed: ignore
 require 'delayed/plugin'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/delayed_job/ext'

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

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

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

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

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

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

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

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

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

@@ -1,8 +1,11 @@
+# typed: true
 module Datadog
   module Contrib
     module Elasticsearch
       # Quantize contains ES-specific resource quantization tools.
       module Quantize
+        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+
         PLACEHOLDER = '?'.freeze
         ID_PLACEHOLDER = '\1?'.freeze
         EXCLUDE_KEYS = [].freeze

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

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

data/lib/ddtrace/contrib/ethon/easy_patch.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/distributed'
 require 'ddtrace/ext/integration'
@@ -11,7 +12,7 @@ module Datadog
       # Ethon EasyPatch
       module EasyPatch
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # InstanceMethods - implementing instrumentation

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

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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/ethon/configuration/settings'
 require 'ddtrace/contrib/configuration/resolvers/pattern_resolver'

data/lib/ddtrace/contrib/ethon/multi_patch.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/distributed'
 require 'ddtrace/ext/integration'
@@ -11,7 +12,7 @@ module Datadog
       module MultiPatch
         def self.included(base)
           # No need to prepend here since add method is included into Multi class
-          base.send(:include, InstanceMethods)
+          base.include(InstanceMethods)
         end
 
         # InstanceMethods - implementing instrumentation

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

@@ -1,8 +1,10 @@
+# typed: true
 module Datadog
   module Contrib
     module Ethon
       # Patcher enables patching of 'ethon' module.
       module Patcher
+        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
         include Contrib::Patcher
 
         module_function
@@ -16,8 +18,8 @@ module Datadog
           require 'ddtrace/contrib/ethon/easy_patch'
           require 'ddtrace/contrib/ethon/multi_patch'
 
-          ::Ethon::Easy.send(:include, EasyPatch)
-          ::Ethon::Multi.send(:include, MultiPatch)
+          ::Ethon::Easy.include(EasyPatch)
+          ::Ethon::Multi.include(MultiPatch)
         end
       end
     end

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

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/excon/configuration/settings'
 require 'ddtrace/contrib/configuration/resolvers/pattern_resolver'

data/lib/ddtrace/contrib/excon/middleware.rb

@@ -1,3 +1,4 @@
+# typed: ignore
 require 'excon'
 require 'ddtrace/ext/http'
 require 'ddtrace/ext/integration'

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

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

data/lib/ddtrace/contrib/extensions.rb

@@ -1,21 +1,35 @@
+# typed: false
 require 'set'
-require 'ddtrace/contrib/registry'
+require 'datadog/contrib'
+require 'ddtrace/configuration/settings'
 
 module Datadog
   module Contrib
     # Extensions that can be added to the base library
     # Adds registry, configuration access for integrations.
+    #
+    # DEV: The Registry should probably be part of the core tracer
+    # as it represents a global tracer repository that is strongly intertwined
+    # with the tracer lifecycle and deeply modifies the tracer initialization
+    # process.
+    # Most of this file should probably live inside the tracer core.
     module Extensions
       def self.extended(base)
-        Datadog.send(:extend, Helpers)
-        Datadog.send(:extend, Configuration)
-        Datadog::Configuration::Settings.send(:include, Configuration::Settings)
+        base.extend(Helpers)
+        base.extend(Configuration)
       end
 
       # Helper methods for Datadog module.
       module Helpers
+        # Returns the global integration registry.
+        #
+        # This method is not safe to use while the tracer is initializing,
+        # thus access to the registry should go through
+        # ::Datadog::Contrib::REGISTRY for internal tracer work.
+        #
+        # External use of this method is always safe.
         def registry
-          configuration.registry
+          Contrib::REGISTRY
         end
       end
 
@@ -60,11 +74,23 @@ module Datadog
         module Settings
           InvalidIntegrationError = Class.new(StandardError)
 
-          def self.included(base)
-            # Add the additional options to the global configuration settings
-            base.instance_eval do
-              option :registry, default: Registry.new
-            end
+          # The registry only holds declarative constant values and cannot be modified.
+          # This option is a no-op and will be removed in the future.
+          #
+          # @deprecated Use `Datadog.registry` instead
+          def registry
+            Datadog.logger.warn('Deprecated access to `Datadog.configuration.registry`, use `Datadog.registry` instead.' \
+                                '`Datadog.configuration.registry` will be removed in a future version.')
+            Contrib::REGISTRY
+          end
+
+          # The registry only holds declarative constant values and cannot be modified.
+          # This option is a no-op and will be removed in the future.
+          #
+          # @deprecated The registry is now a global constant, and can't be overwritten.
+          def registry=(_arg)
+            Datadog.logger.warn('Setting a custom registry is no longer supported and was ignored. ' \
+                                'Remove this assignment from your configuration to stop seeing this warning.')
           end
 
           # For the provided `integration_name`, resolves a matching configuration
@@ -125,7 +151,7 @@ module Datadog
           end
 
           def fetch_integration(name)
-            registry[name] ||
+            Contrib::REGISTRY[name] ||
               raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
           end