ddtrace 0.40.0 → 0.54.1

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/active_support/cache/instrumentation'
 
@@ -17,8 +18,11 @@ module Datadog
 
           def patch
             patch_cache_store_read
+            patch_cache_store_read_multi
             patch_cache_store_fetch
+            patch_cache_store_fetch_multi
             patch_cache_store_write
+            patch_cache_store_write_multi
             patch_cache_store_delete
           end
 
@@ -27,19 +31,37 @@ module Datadog
           end
 
           def patch_cache_store_read
-            cache_store_class(:read).send(:prepend, Cache::Instrumentation::Read)
+            cache_store_class(:read).prepend(Cache::Instrumentation::Read)
+          end
+
+          def patch_cache_store_read_multi
+            cache_store_class(:read_multi).prepend(Cache::Instrumentation::ReadMulti)
           end
 
           def patch_cache_store_fetch
-            cache_store_class(:fetch).send(:prepend, Cache::Instrumentation::Fetch)
+            cache_store_class(:fetch).prepend(Cache::Instrumentation::Fetch)
+          end
+
+          def patch_cache_store_fetch_multi
+            klass = cache_store_class(:fetch_multi)
+            return unless klass.public_method_defined?(:fetch_multi)
+
+            klass.prepend(Cache::Instrumentation::FetchMulti)
           end
 
           def patch_cache_store_write
-            cache_store_class(:write).send(:prepend, Cache::Instrumentation::Write)
+            cache_store_class(:write).prepend(Cache::Instrumentation::Write)
+          end
+
+          def patch_cache_store_write_multi
+            klass = cache_store_class(:write_multi)
+            return unless klass.public_method_defined?(:write_multi)
+
+            klass.prepend(Cache::Instrumentation::WriteMulti)
           end
 
           def patch_cache_store_delete
-            cache_store_class(:delete).send(:prepend, Cache::Instrumentation::Delete)
+            cache_store_class(:delete).prepend(Cache::Instrumentation::Delete)
           end
         end
       end

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/active_support/cache/patcher'
 
 module Datadog
@@ -35,11 +36,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/configuration/settings.rb

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

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module ActiveSupport
@@ -12,12 +13,15 @@ module Datadog
         QUANTIZE_CACHE_MAX_KEY_SIZE = 300
         RESOURCE_CACHE_DELETE = 'DELETE'.freeze
         RESOURCE_CACHE_GET = 'GET'.freeze
+        RESOURCE_CACHE_MGET = 'MGET'.freeze
         RESOURCE_CACHE_SET = 'SET'.freeze
+        RESOURCE_CACHE_MSET = 'MSET'.freeze
         SERVICE_CACHE = 'active_support-cache'.freeze
         SPAN_CACHE = 'rails.cache'.freeze
         SPAN_TYPE_CACHE = 'cache'.freeze
         TAG_CACHE_BACKEND = 'rails.cache.backend'.freeze
         TAG_CACHE_KEY = 'rails.cache.key'.freeze
+        TAG_CACHE_KEY_MULTI = 'rails.cache.keys'.freeze
       end
     end
   end

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

@@ -1,8 +1,9 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/active_support/configuration/settings'
 require 'ddtrace/contrib/active_support/patcher'
-
 require 'ddtrace/contrib/active_support/cache/redis'
+require 'ddtrace/contrib/rails/utils'
 
 module Datadog
   module Contrib
@@ -27,6 +28,12 @@ module Datadog
           super && version >= MINIMUM_VERSION
         end
 
+        # enabled by rails integration so should only auto instrument
+        # if detected that it is being used without rails
+        def auto_instrument?
+          !Datadog::Contrib::Rails::Utils.railtie_supported?
+        end
+
         def default_configuration
           Configuration::Settings.new
         end

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/active_support/notifications/subscriber'
 
 module Datadog
@@ -10,8 +11,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
 
@@ -20,7 +21,8 @@ module Datadog
           module ClassMethods
             DEFAULT_TRACER = -> { Datadog.tracer }
 
-            def subscribe!
+            # Publicly exposes protected method `subscribe!`
+            def subscribe! # rubocop:disable Lint/UselessMethodDefinition
               super
             end
 
@@ -56,6 +58,16 @@ module Datadog
             def tracer
               DEFAULT_TRACER
             end
+
+            def report_if_exception(span, payload)
+              exception = payload_exception(payload)
+              span.set_error(payload[:exception]) if exception
+            end
+
+            def payload_exception(payload)
+              payload[:exception_object] ||
+                payload[:exception] # Fallback for ActiveSupport < 5.0
+            end
           end
         end
       end

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'set'
 require 'ddtrace/contrib/active_support/notifications/subscription'
 
@@ -9,7 +10,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.
@@ -36,6 +37,7 @@ module Datadog
             # Should be triggered by the inheriting class.
             def subscribe!
               return subscribed? if subscribed? || on_subscribe_block.nil?
+
               on_subscribe_block.call
               @subscribed = true
             end

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

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Contrib
     module ActiveSupport
@@ -9,7 +10,8 @@ module Datadog
             :options
 
           def initialize(tracer, span_name, options, &block)
-            raise ArgumentError, 'Must be given a block!' unless block_given?
+            raise ArgumentError, 'Must be given a block!' unless block
+
             @tracer = tracer
             @span_name = span_name
             @options = options
@@ -38,21 +40,23 @@ module Datadog
           end
 
           def before_trace(&block)
-            callbacks.add(:before_trace, &block) if block_given?
+            callbacks.add(:before_trace, &block) if block
           end
 
           def after_trace(&block)
-            callbacks.add(:after_trace, &block) if block_given?
+            callbacks.add(:after_trace, &block) if block
           end
 
           def subscribe(pattern)
             return false if subscribers.key?(pattern)
+
             subscribers[pattern] = ::ActiveSupport::Notifications.subscribe(pattern, self)
             true
           end
 
           def unsubscribe(pattern)
             return false unless subscribers.key?(pattern)
+
             ::ActiveSupport::Notifications.unsubscribe(subscribers[pattern])
             subscribers.delete(pattern)
             true
@@ -60,7 +64,8 @@ module Datadog
 
           def unsubscribe_all
             return false if subscribers.empty?
-            subscribers.keys.each { |pattern| unsubscribe(pattern) }
+
+            subscribers.each_key { |pattern| unsubscribe(pattern) }
             true
           end
 
@@ -76,8 +81,8 @@ module Datadog
 
             # Start a trace
             tracer.trace(@span_name, @options.dup).tap do |span|
-              # Assign start time if provided
-              span.start_time = start unless start.nil?
+              # Start span if time is provided
+              span.start(start) unless start.nil?
               payload[:datadog_span] = span
             end
           end
@@ -131,7 +136,7 @@ module Datadog
             end
 
             def add(key, &block)
-              blocks_for(key) << block if block_given?
+              blocks_for(key) << block if block
             end
 
             def run(event, key, *args)

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

@@ -0,0 +1,48 @@
+# typed: false
+
+module Datadog
+  module Contrib
+    # Extensions for auto instrumentation added to the base library
+    # AutoInstrumentation enables all integration
+    module AutoInstrument
+      def self.extended(base)
+        base.extend(Patch)
+      end
+
+      # Patch adds method for invoking auto_instrumentation
+      module Patch
+        def add_auto_instrument
+          super
+
+          if Datadog::Contrib::Rails::Utils.railtie_supported?
+            require 'ddtrace/contrib/rails/auto_instrument_railtie'
+          else
+            AutoInstrument.patch_all
+          end
+        end
+      end
+
+      def self.patch_all
+        integrations = []
+
+        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.
+          # we also don't want to mix rspec/cucumber integration in as rspec is env we run tests in.
+          next unless integration.klass.auto_instrument?
+
+          integrations << integration.name
+        end
+
+        Datadog.configure do |c|
+          c.reduce_log_verbosity
+          # This will activate auto-instrumentation for Rails
+          integrations.each do |integration_name|
+            c.use integration_name
+          end
+        end
+      end
+    end
+  end
+end

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,5 +1,8 @@
+# typed: ignore
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/aws/ext'
+require 'ddtrace/ext/http'
+require 'ddtrace/ext/integration'
 
 module Datadog
   module Contrib
@@ -25,10 +28,13 @@ module Datadog
 
         def annotate!(span, context)
           span.service = configuration[:service_name]
-          span.span_type = Datadog::Ext::AppTypes::WEB
+          span.span_type = Datadog::Ext::HTTP::TYPE_OUTBOUND
           span.name = Ext::SPAN_COMMAND
           span.resource = context.safely(:resource)
 
+          # Tag as an external peer service
+          span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
           # Set analytics sample rate
           if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
             Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
@@ -51,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,5 +1,5 @@
+# typed: false
 require 'ddtrace/contrib/patcher'
-require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/aws/ext'
 
 module Datadog
@@ -21,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)
@@ -36,6 +40,7 @@ module Datadog
 
           available_services.each_with_object([]) do |service, constants|
             next if ::Aws.autoload?(service)
+
             constants << ::Aws.const_get(service, false).const_get(:Client, false) rescue next
           end
         end

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     # rubocop:disable Metrics/ModuleLength:
@@ -52,6 +53,7 @@ module Datadog
         ElasticLoadBalancingV2
         ElasticTranscoder
         ElasticsearchService
+        EventBridge
         Firehose
         GameLift
         Glacier
@@ -98,12 +100,14 @@ module Datadog
         STS
         SWF
         ServiceCatalog
+        Schemas
         Shield
         SimpleDB
         Snowball
         States
         StorageGateway
         Support
+        Textract
         WAF
         WAFRegional
         WorkDocs

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,74 +1,101 @@
+# typed: true
 require 'ddtrace/contrib/configuration/resolver'
 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.
-        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