ddtrace 0.46.0 → 0.51.0

data/lib/ddtrace/contrib/active_support/cache/redis.rb

@@ -35,11 +35,7 @@ module Datadog
           end
 
           # Decorate Cache patcher with Redis support
-          Cache::Patcher.instance_eval do
-            class << self
-              prepend Redis::Patcher
-            end
-          end
+          Cache::Patcher.singleton_class.prepend(Redis::Patcher)
         end
       end
     end

data/lib/ddtrace/contrib/active_support/notifications/event.rb

@@ -10,8 +10,8 @@ module Datadog
         # invoke Event.subscribe! to more easily subscribe to an event.
         module Event
           def self.included(base)
-            base.send(:include, Subscriber)
-            base.send(:extend, ClassMethods)
+            base.include(Subscriber)
+            base.extend(ClassMethods)
             base.send(:on_subscribe) { base.subscribe }
           end
 

data/lib/ddtrace/contrib/active_support/notifications/subscriber.rb

@@ -9,7 +9,7 @@ module Datadog
         # Creates subscriptions that are wrapped with tracing.
         module Subscriber
           def self.included(base)
-            base.send(:extend, ClassMethods)
+            base.extend(ClassMethods)
           end
 
           # Class methods that are implemented in the inheriting class.

data/lib/ddtrace/contrib/auto_instrument.rb

@@ -6,7 +6,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
@@ -19,7 +19,6 @@ module Datadog
           else
             AutoInstrument.patch_all
           end
-          AutoInstrument.patch_all
         end
       end
 

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

@@ -56,6 +56,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/patcher.rb

@@ -20,6 +20,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
         end
 
         def add_plugin(*targets)

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

@@ -99,6 +99,7 @@ module Datadog
         STS
         SWF
         ServiceCatalog
+        Schemas
         Shield
         SimpleDB
         Snowball

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

@@ -20,7 +20,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

@@ -3,74 +3,98 @@ require 'ddtrace/contrib/configuration/settings'
 
 module Datadog
   module Contrib
-    # Defines configurable behavior for integrations
+    # Defines configurable behavior for integrations.
+    #
+    # This module is responsible for coordination between
+    # the configuration resolver and default configuration
+    # fallback.
     module Configurable
       def self.included(base)
-        base.send(:include, InstanceMethods)
+        base.include(InstanceMethods)
       end
 
       # Configurable instance behavior for integrations
       module InstanceMethods
+        # Provides a new configuration instance for this integration.
+        #
+        # This method normally needs to be overridden for each integration
+        # as their settings, defaults and environment variables are
+        # specific for each integration.
+        #
+        # DEV(1.0): Rename to `new_configuration`, make it protected.
+        # DEV(1.0):
+        # DEV(1.0): This method always provides a new instance of the configuration object for
+        # DEV(1.0): the current integration, not the currently effective default configuration.
+        # DEV(1.0): This is a misnomer of its function.
+        # DEV(1.0):
+        # DEV(1.0): Unfortunately, change this would be a breaking change for all custom integrations,
+        # DEV(1.0): thus we have to be very intentional with the right time to make this change.
+        # DEV(1.0): Currently marking this for a 1.0 milestone.
         def default_configuration
           Configuration::Settings.new
         end
 
-        def reset_configuration!
-          @configurations = nil
-          @resolver = nil
-        end
+        # Get matching configuration by matcher.
+        # If no match, returns the default configuration instance.
+        def configuration(matcher = :default)
+          return default_configuration_instance if matcher == :default
 
-        # Get matching configuration for key.
-        # If no match, returns default configuration.
-        def configuration(key = :default)
-          configurations[configuration_key(key)]
+          resolver.get(matcher) || default_configuration_instance
         end
 
-        # If the key has matching configuration explicitly defined for it,
-        # then return true. Otherwise return false.
-        # Note: a resolver's resolve method should not return a fallback value
-        # See: https://github.com/DataDog/dd-trace-rb/issues/1204
-        def configuration_for?(key)
-          key = resolver.resolve(key) unless key == :default
-          configurations.key?(key)
+        # Resolves the matching configuration for integration-specific value.
+        # If no match, returns the default configuration instance.
+        def resolve(value)
+          return default_configuration_instance if value == :default
+
+          resolver.resolve(value) || default_configuration_instance
         end
 
+        # Returns all registered matchers and their respective configurations.
         def configurations
-          @configurations ||= {
-            default: default_configuration
-          }
+          resolver.configurations.merge(default: default_configuration_instance)
         end
 
-        # Create or update configuration with provided settings.
-        def configure(key, options = {}, &block)
-          key ||= :default
-
-          # Get or add the configuration
-          config = configuration_for?(key) ? configuration(key) : add_configuration(key)
+        # Create or update configuration associated with `matcher` with
+        # the provided `options` and `&block`.
+        def configure(matcher = :default, options = {}, &block)
+          config = if matcher == :default
+                     default_configuration_instance
+                   else
+                     # Get or add the configuration
+                     resolver.get(matcher) || resolver.add(matcher, default_configuration)
+                   end
 
           # Apply the settings
           config.configure(options, &block)
           config
         end
 
-        protected
-
-        def resolver
-          @resolver ||= Configuration::Resolver.new
+        # Resets all configuration options
+        def reset_configuration!
+          @resolver = nil
+          @default_configuration = nil
         end
 
-        def add_configuration(key)
-          resolver.add(key)
-          config_key = resolver.resolve(key)
-          configurations[config_key] = default_configuration
-        end
+        protected
 
-        def configuration_key(key)
-          return :default if key.nil? || key == :default
+        # DEV(1.0): Rename to `default_configuration`, make it public.
+        # DEV(1.0): See comment on `default_configuration` for more information.
+        def default_configuration_instance
+          @default_configuration ||= default_configuration # rubocop:disable Naming/MemoizedInstanceVariableName
+        end
 
-          key = resolver.resolve(key)
-          key = :default unless configurations.key?(key)
-          key
+        # Overridable configuration resolver.
+        #
+        # This resolver is responsible for performing the matching
+        # of `#configure(matcher)` `matcher`s with `value`s provided
+        # in subsequent calls to `#resolve(value)`.
+        #
+        # By default, the `value` in `#resolve(value)` must be equal
+        # to the `matcher` object provided in `#configure(matcher)`
+        # to retrieve the associated configuration.
+        def resolver
+          @resolver ||= Configuration::Resolver.new
         end
       end
     end

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

@@ -1,14 +1,79 @@
 module Datadog
   module Contrib
     module Configuration
-      # Resolves a configuration key to a Datadog::Contrib::Configuration:Settings object
+      # Resolves an integration-specific matcher to an associated
+      # object.
+      #
+      # Integrations that perform any configuration matching
+      # based on patterns might want to override this class
+      # to provide richer matching. For example, match configuration
+      # based on: HTTP request parameters, request headers,
+      # async queue name.
+      #
+      # When overriding this class, for simple use cases, only
+      # overriding `#parse_matcher` might suffice. See
+      # `#parse_matcher`'s documentation for more information.
       class Resolver
-        def resolve(key)
-          key
+        attr_reader :configurations
+
+        def initialize
+          @configurations = {}
+        end
+
+        # Adds a new `matcher`, associating with it a `value`.
+        #
+        # This `value` is returned when `#resolve` is called
+        # with a matching value for this matcher. When multiple
+        # matchers would match, `#resolve` returns the latest
+        # added one.
+        #
+        # The `matcher` can be transformed internally by the
+        # `#parse_matcher` method before being stored.
+        #
+        # The `value` can also be retrieved by calling `#get`
+        # with the same `matcher` added by this method.
+        #
+        # @param [Object] matcher integration-specific matcher
+        # @param [Object] value arbitrary value to be associated with `matcher`
+        def add(matcher, value)
+          @configurations[parse_matcher(matcher)] = value
+        end
+
+        # Retrieves the stored value for a `matcher`
+        # previously stored by `#add`.
+        #
+        # @param [Object] matcher integration-specific matcher
+        # @return [Object] previously stored `value` from `#add`, or `nil` if not found
+        def get(matcher)
+          @configurations[parse_matcher(matcher)]
+        end
+
+        # Matches an arbitrary value against the configured
+        # matchers previously set with `#add`.
+        #
+        # If multiple matchers would match, returns the latest one.
+        #
+        # @param [Object] value integration-specific value
+        # @return [Object] matching `value` configured at `#add`, or `nil` if none match
+        def resolve(value)
+          @configurations[value]
         end
 
-        def add(key)
-          key
+        protected
+
+        # Converts `matcher` into an appropriate key
+        # for the internal Hash storage.
+        #
+        # It's recommended to override this method,
+        # instead of the public methods, if the
+        # integration can simply convert both
+        # `matcher` (provided to `#add`) and `value`
+        # (provided to `#resolve`) to the same value.
+        #
+        # @param [Object] matcher integration-specific matcher
+        # @return [Object] processed matcher
+        def parse_matcher(matcher)
+          matcher
         end
       end
     end

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

@@ -5,30 +5,32 @@ module Datadog
     module Configuration
       # Resolves a value to a configuration key
       module Resolvers
-        # Matches strings against Regexps.
-        class PatternResolver < Datadog::Contrib::Configuration::Resolver
-          def resolve(name)
-            return if patterns.empty?
+        # Matches Strings and Regexps against `object.to_s` objects
+        # and Procs against plain objects.
+        class PatternResolver < Contrib::Configuration::Resolver
+          def resolve(value)
+            return if configurations.empty?
 
             # Try to find a matching pattern
-            patterns.find do |pattern|
-              if pattern.is_a?(Proc)
-                (pattern === name)
-              else
-                (pattern === name.to_s) ||
-                  (pattern == name) # Only required during configuration time.
-              end
+            _, config = configurations.reverse_each.find do |matcher, _|
+              matcher === if matcher.is_a?(Proc)
+                            value
+                          else
+                            value.to_s
+                          end
             end
-          end
 
-          def add(pattern)
-            patterns << (pattern.is_a?(Regexp) || pattern.is_a?(Proc) ? pattern : pattern.to_s)
+            config
           end
 
-          private
+          protected
 
-          def patterns
-            @patterns ||= Set.new
+          def parse_matcher(matcher)
+            if matcher.is_a?(Regexp) || matcher.is_a?(Proc)
+              matcher
+            else
+              matcher.to_s
+            end
           end
         end
       end

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

@@ -1,4 +1,5 @@
 require 'ddtrace/configuration/base'
+require 'ddtrace/utils/only_once'
 
 module Datadog
   module Contrib
@@ -7,6 +8,8 @@ module Datadog
       class Settings
         include Datadog::Configuration::Base
 
+        DEPRECATION_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
         option :analytics_enabled, default: false
         option :analytics_sample_rate, default: 1.0
         option :enabled, default: true
@@ -14,7 +17,7 @@ module Datadog
         option :tracer do |o|
           o.delegate_to { Datadog.tracer }
           o.on_set do |_value|
-            log_deprecation_warning(:tracer)
+            log_deprecation_warning
           end
         end
 
@@ -41,11 +44,9 @@ module Datadog
           the correct tracer internally.
           ).freeze
 
-        include Datadog::Patcher # DEV includes #do_once here. We should move that logic to a generic component.
-
-        def log_deprecation_warning(method_name)
-          do_once(method_name) do
-            Datadog.logger.warn("#{method_name}:#{DEPRECATION_WARNING}:#{caller.join("\n")}")
+        def log_deprecation_warning
+          DEPRECATION_WARN_ONLY_ONCE.run do
+            Datadog.logger.warn("tracer:#{DEPRECATION_WARNING}:#{caller.join("\n")}")
           end
         end
       end

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

@@ -10,7 +10,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/patcher.rb

@@ -17,7 +17,7 @@ module Datadog
         end
 
         def patch
-          ::Dalli::Server.send(:include, Instrumentation)
+          ::Dalli::Server.include(Instrumentation)
         end
       end
     end