datadog 2.12.0 → 2.22.0

data/lib/datadog/tracing/contrib/active_support/cache/events/cache.rb

@@ -38,16 +38,22 @@ module Datadog
 
               # DEV: Look for other uses of `ActiveSupport::Cache::Store#instrument`, to find other useful event keys.
               MAPPING = {
-                'cache_delete.active_support' => { resource: Ext::RESOURCE_CACHE_DELETE },
-                'cache_read.active_support' => { resource: Ext::RESOURCE_CACHE_GET },
-                'cache_read_multi.active_support' => { resource: Ext::RESOURCE_CACHE_MGET, multi_key: true },
-                'cache_write.active_support' => { resource: Ext::RESOURCE_CACHE_SET },
-                'cache_write_multi.active_support' => { resource: Ext::RESOURCE_CACHE_MSET, multi_key: true }
+                'cache_delete.active_support' => {resource: Ext::RESOURCE_CACHE_DELETE},
+                'cache_read.active_support' => {resource: Ext::RESOURCE_CACHE_GET},
+                'cache_read_multi.active_support' => {resource: Ext::RESOURCE_CACHE_MGET, multi_key: true},
+                'cache_write.active_support' => {resource: Ext::RESOURCE_CACHE_SET},
+                'cache_write_multi.active_support' => {resource: Ext::RESOURCE_CACHE_MSET, multi_key: true}
               }.freeze
 
-              def trace?(event, _payload)
+              def trace?(event, payload)
                 return false if !Tracing.enabled? || !configuration.enabled
 
+                if (cache_store = configuration[:cache_store])
+                  store = cache_backend(payload[:store])
+
+                  return false unless cache_store.include?(store)
+                end
+
                 # DEV-3.0: Backwards compatibility code for the 2.x gem series.
                 # DEV-3.0: See documentation at {Datadog::Tracing::Contrib::ActiveSupport::Cache::Instrumentation}
                 # DEV-3.0: for the complete information about this backwards compatibility code.
@@ -62,7 +68,10 @@ module Datadog
               end
 
               def on_start(span, event, _id, payload)
-                key = payload[:key]
+                # Since Rails 8, `dd_original_keys` contains the denormalized key provided by the user.
+                # In previous versions, the denormalized key is stored in the official `key` attribute.
+                # We fall back to `key`, even in Rails 8, as a defensive measure.
+                key = payload[:dd_original_keys] || payload[:key]
                 store = payload[:store]
 
                 mapping = MAPPING.fetch(event)
@@ -84,7 +93,7 @@ module Datadog
                 if Datadog.configuration.tracing[:active_support][:cache_key].enabled
                   set_cache_key(span, key, mapping[:multi_key])
                 end
-              rescue StandardError => e
+              rescue => e
                 Datadog.logger.error(e.message)
                 Datadog::Core::Telemetry::Logger.report(e)
               end

data/lib/datadog/tracing/contrib/active_support/cache/instrumentation.rb

@@ -184,6 +184,39 @@ module Datadog
                 super(operation, key, polyfill_options)
               end
             end
+
+            # Save the original, user-supplied cache key, before it gets normalized.
+            #
+            # Normalized keys can include internal implementation detail,
+            # for example FileStore keys include temp directory names, which
+            # changes on every run, making it impossible to group by the cache key afterward.
+            # Also, the user is never exposed to the normalized key, and only sets/gets using the
+            # original key.
+            module PreserveOriginalKey
+              # Stores the original keys in the options hash, as an array of keys.
+              # It's important to keep all the keys for multi-key operations.
+              # For single-key operations, the key is stored as an array of a single element.
+              def normalize_key(key, options)
+                orig_keys = options[:dd_original_keys] || []
+                orig_keys << key
+                options[:dd_original_keys] = orig_keys
+
+                super
+              end
+
+              # Ensure we don't pollute the default Store instance `options` in {PreserveOriginalKey#normalize_key}.
+              # In most cases, `merged_options` returns a new hash,
+              # but we check for cases where it reuses the instance hash.
+              def merged_options(call_options)
+                ret = super
+
+                if ret.equal?(options)
+                  ret.dup
+                else
+                  ret
+                end
+              end
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/active_support/cache/patcher.rb

@@ -22,6 +22,10 @@ module Datadog
             def patch
               Events.subscribe!
 
+              if Integration.version >= Gem::Version.new('8.0.0')
+                ::ActiveSupport::Cache::Store.prepend(Cache::Instrumentation::PreserveOriginalKey)
+              end
+
               # Backfill the `:store` key in the ActiveSupport event payload for older Rails.
               if Integration.version < Gem::Version.new('6.1.0')
                 ::ActiveSupport::Cache::Store.prepend(Cache::Instrumentation::Store)

data/lib/datadog/tracing/contrib/active_support/cache/redis.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative '../../support'
 require_relative 'patcher'
 
 module Datadog
@@ -34,10 +35,7 @@ module Datadog
               # @see https://github.com/rails/rails/blob/d0dcb8fa6073a0c4d42600c15e82e3bb386b27d3/activesupport/lib/active_support/cache/redis_cache_store.rb#L4
               def patch_redis_cache_store?(meth)
                 Gem.loaded_specs['redis'] &&
-                  # Autoload constants return `constant` for `defined?`, but that doesn't mean they are loaded...
-                  defined?(::ActiveSupport::Cache::RedisCacheStore) &&
-                  # ... to check that we need to call `autoload?` and check if it returns `nil`, meaning it's loaded.
-                  ::ActiveSupport::Cache.autoload?(:RedisCacheStore).nil? &&
+                  Support.fully_loaded?(::ActiveSupport::Cache, :RedisCacheStore) &&
                   ::ActiveSupport::Cache::RedisCacheStore.instance_methods(false).include?(meth)
               end
 

data/lib/datadog/tracing/contrib/active_support/configuration/settings.rb

@@ -49,6 +49,19 @@ module Datadog
                 o.default true
               end
             end
+
+            # Specifies which cache stores to trace.
+            # Accepts a list, with the same format as `config.cache_store`
+            # (e.g. `memory_store`, `file_store`, or symbols like `:file_store`).
+            # Defaults to `nil`, which traces all cache stores.
+            # @see https://github.com/rails/rails/blob/b7520a13adda46c0cc5f3fb4a4c1726633af2bba/guides/source/caching_with_rails.md?plain=1#L576-L582
+            option :cache_store do |o|
+              o.type :array, nilable: true
+              o.default nil
+              o.after_set do |stores|
+                stores&.map!(&:to_s) # Convert symbols to strings to match the Rails configuration format
+              end
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/active_support/integration.rb

@@ -24,7 +24,7 @@ module Datadog
           end
 
           def self.version
-            Gem.loaded_specs['activesupport'] && Gem.loaded_specs['activesupport'].version
+            Gem.loaded_specs['activesupport']&.version
           end
 
           def self.loaded?

data/lib/datadog/tracing/contrib/active_support/notifications/event.rb

@@ -67,7 +67,8 @@ module Datadog
                   payload[:exception] # Fallback for ActiveSupport < 5.0
               end
 
-              def on_start(_span, _event, _id, _payload); end
+              def on_start(_span, _event, _id, _payload)
+              end
 
               def on_finish(span, _event, _id, payload)
                 record_exception(span, payload)

data/lib/datadog/tracing/contrib/active_support/notifications/subscription.rb

@@ -122,8 +122,8 @@ module Datadog
               end
 
               def run(span, name, id, payload)
-                @block.call(span, name, id, payload) if @block
-              rescue StandardError => e
+                @block&.call(span, name, id, payload)
+              rescue => e
                 Datadog.logger.debug(
                   "ActiveSupport::Notifications handler for '#{name}' failed: #{e.class.name} #{e.message}"
                 )
@@ -144,13 +144,11 @@ module Datadog
 
               def run(event, key, *args)
                 blocks_for(key).each do |callback|
-                  begin
-                    callback.call(event, key, *args)
-                  rescue StandardError => e
-                    Datadog.logger.debug(
-                      "ActiveSupport::Notifications '#{key}' callback for '#{event}' failed: #{e.class.name} #{e.message}"
-                    )
-                  end
+                  callback.call(event, key, *args)
+                rescue => e
+                  Datadog.logger.debug(
+                    "ActiveSupport::Notifications '#{key}' callback for '#{event}' failed: #{e.class.name} #{e.message}"
+                  )
                 end
               end
 

data/lib/datadog/tracing/contrib/aws/ext.rb

@@ -33,7 +33,7 @@ module Datadog
           TAG_RULE_NAME = 'rulename'
           TAG_STATE_MACHINE_NAME = 'statemachinename'
           TAG_BUCKET_NAME = 'bucketname'
-          PEER_SERVICE_SOURCES = Array[TAG_QUEUE_NAME,
+          PEER_SERVICE_SOURCES = [TAG_QUEUE_NAME,
             TAG_TOPIC_NAME,
             TAG_STREAM_NAME,
             TAG_TABLE_NAME,

data/lib/datadog/tracing/contrib/aws/instrumentation.rb

@@ -35,6 +35,16 @@ module Datadog
             span.type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
             span.name = Ext::SPAN_COMMAND
             span.resource = context.safely(:resource)
+
+            # Set error on the span if the Response Status Code is in error range
+            if Tracing::Metadata::Ext::HTTP::ERROR_RANGE.cover?(context.safely(:status_code))
+              # At this point we do not have any additional diagnostics
+              # besides the HTTP status code which is recorded in the span tags
+              # later in this method.
+              # Just set the span as errored.
+              span.set_error(nil)
+            end
+
             aws_service = span.resource.split('.')[0]
             span.set_tag(Ext::TAG_AWS_SERVICE, aws_service)
             params = context.safely(:params)
@@ -77,7 +87,7 @@ module Datadog
             span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, context.safely(:status_code))
 
             Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
-          rescue StandardError => e
+          rescue => e
             Datadog.logger.error(e.message)
             Datadog::Core::Telemetry::Logger.report(e)
           end
@@ -113,7 +123,7 @@ module Datadog
               request.handlers.remove(Handler)
             end
 
-            super(*args, &block)
+            super
           end
 
           ruby2_keywords :sign_but_dont_send if respond_to?(:ruby2_keywords, true)

data/lib/datadog/tracing/contrib/aws/parsed_context.rb

@@ -11,7 +11,9 @@ module Datadog
           end
 
           def safely(attr, fallback = nil)
-            public_send(attr) rescue fallback
+            public_send(attr)
+          rescue
+            fallback
           end
 
           def resource
@@ -26,8 +28,12 @@ module Datadog
             context.params
           end
 
+          def http_response
+            context.http_response
+          end
+
           def status_code
-            context.http_response.status_code
+            http_response.status_code
           end
 
           def http_method

data/lib/datadog/tracing/contrib/aws/patcher.rb

@@ -43,7 +43,11 @@ 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
+              begin
+                constants << ::Aws.const_get(service, false).const_get(:Client, false)
+              rescue
+                next
+              end
             end
           end
 

data/lib/datadog/tracing/contrib/aws/service/base.rb

@@ -7,7 +7,8 @@ module Datadog
         module Service
           # Base class for all AWS service-specific tag handlers.
           class Base
-            def add_tags(span, params); end
+            def add_tags(span, params)
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/aws/service/dynamodb.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './base'
+require_relative 'base'
 require_relative '../ext'
 
 module Datadog

data/lib/datadog/tracing/contrib/aws/service/eventbridge.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './base'
+require_relative 'base'
 require_relative '../ext'
 
 module Datadog

data/lib/datadog/tracing/contrib/aws/service/kinesis.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './base'
+require_relative 'base'
 require_relative '../ext'
 
 module Datadog

data/lib/datadog/tracing/contrib/aws/service/s3.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './base'
+require_relative 'base'
 require_relative '../ext'
 
 module Datadog

data/lib/datadog/tracing/contrib/aws/service/sns.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './base'
+require_relative 'base'
 require_relative '../ext'
 
 module Datadog

data/lib/datadog/tracing/contrib/aws/service/sqs.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './base'
+require_relative 'base'
 require_relative '../ext'
 
 module Datadog

data/lib/datadog/tracing/contrib/aws/service/states.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './base'
+require_relative 'base'
 require_relative '../ext'
 
 module Datadog

data/lib/datadog/tracing/contrib/aws/services.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative './service/sqs'
-require_relative './service/sns'
-require_relative './service/dynamodb'
-require_relative './service/kinesis'
-require_relative './service/eventbridge'
-require_relative './service/states'
-require_relative './service/s3'
+require_relative 'service/sqs'
+require_relative 'service/sns'
+require_relative 'service/dynamodb'
+require_relative 'service/kinesis'
+require_relative 'service/eventbridge'
+require_relative 'service/states'
+require_relative 'service/s3'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/component.rb

@@ -9,13 +9,13 @@ module Datadog
           # Register a callback to be invoked when components are reconfigured.
           # @param name [String] the name of the integration
           # @param callback [Proc] the callback to invoke
-          # @yieldparam config [Datadog::Configuration] the configuration to pass to callbacks
+          # @yieldparam config [Datadog::Core::Configuration::Settings] the configuration to pass to callbacks
           def register(name, &callback)
             @registry[name] = callback
           end
 
           # Invoke all registered callbacks with the given configuration.
-          # @param config [Datadog::Configuration] the configuration to pass to callbacks
+          # @param config [Datadog::Core::Configuration::Settings] the configuration to pass to callbacks
           def configure(config)
             @registry.each do |name, callback|
               callback.call(config)

data/lib/datadog/tracing/contrib/concurrent_ruby/async_patch.rb

@@ -9,7 +9,7 @@ module Datadog
         # This patches the Async - to wrap executor service using ContextCompositeExecutorService
         module AsyncPatch
           def initialize(delegate)
-            super(delegate)
+            super
 
             @executor = ContextCompositeExecutorService.new(@executor)
           end

data/lib/datadog/tracing/contrib/concurrent_ruby/context_composite_executor_service.rb

@@ -19,7 +19,7 @@ module Datadog
           # post method runs the task within composited executor - in a different thread. The original arguments are
           # captured to be propagated to the composited executor post method
           def post(*args, &task)
-            digest = Tracing.active_trace && Tracing.active_trace.to_digest
+            digest = Tracing.active_trace&.to_digest
             executor = @composited_executor.is_a?(Symbol) ? Concurrent.executor(@composited_executor) : @composited_executor
 
             # Pass the original arguments to the composited executor, which

data/lib/datadog/tracing/contrib/concurrent_ruby/future_patch.rb

@@ -9,7 +9,7 @@ module Datadog
         # This patches the Future - to wrap executor service using ContextCompositeExecutorService
         module FuturePatch
           def ns_initialize(value, opts)
-            super(value, opts)
+            super
 
             @executor = ContextCompositeExecutorService.new(@executor)
           end

data/lib/datadog/tracing/contrib/concurrent_ruby/integration.rb

@@ -21,7 +21,7 @@ module Datadog
           end
 
           def self.version
-            Gem.loaded_specs['concurrent-ruby'] && Gem.loaded_specs['concurrent-ruby'].version
+            Gem.loaded_specs['concurrent-ruby']&.version
           end
 
           def self.loaded?

data/lib/datadog/tracing/contrib/concurrent_ruby/promises_future_patch.rb

@@ -13,7 +13,7 @@ module Datadog
               default_executor = ContextCompositeExecutorService.new(default_executor)
             end
 
-            super(default_executor, *args, &task)
+            super
           end
         end
       end

data/lib/datadog/tracing/contrib/configurable.rb

@@ -43,14 +43,14 @@ module Datadog
           # the provided `options` and `&block`.
           def configure(matcher = :default, options = {}, &block)
             config = if matcher == :default
-                       default_configuration
-                     else
-                       # Get or add the configuration
-                       resolver.get(matcher) || resolver.add(matcher, new_configuration)
-                     end
+              default_configuration
+            else
+              # Get or add the configuration
+              resolver.get(matcher) || resolver.add(matcher, new_configuration)
+            end
 
             # Apply the settings
-            config.configure(options, &block) if config
+            config&.configure(options, &block)
             config
           end
 

data/lib/datadog/tracing/contrib/configuration/resolvers/pattern_resolver.rb

@@ -17,10 +17,10 @@ module Datadog
               # Try to find a matching pattern
               _, config = configurations.reverse_each.find do |matcher, _|
                 matcher === if matcher.is_a?(Proc)
-                              value
-                            else
-                              value.to_s
-                            end
+                  value
+                else
+                  value.to_s
+                end
               end
 
               config

data/lib/datadog/tracing/contrib/configuration/settings.rb

@@ -22,7 +22,7 @@ module Datadog
           end
 
           def configure(options = {})
-            self.class.options.each do |name, _value|
+            self.class.options.each_key do |name|
               self[name] = options[name] if options.key?(name)
             end
 

data/lib/datadog/tracing/contrib/dalli/ext.rb

@@ -29,10 +29,11 @@ module Datadog
           TAG_COMPONENT = 'dalli'
           TAG_OPERATION_COMMAND = 'command'
           TAG_SYSTEM = 'memcached'
-          PEER_SERVICE_SOURCES = Array[
+          PEER_SERVICE_SOURCES = [
             Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
             Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
-            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,].freeze
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,
+          ].freeze
         end
       end
     end

data/lib/datadog/tracing/contrib/dalli/integration.rb

@@ -19,7 +19,7 @@ module Datadog
           register_as :dalli, auto_patch: true
 
           def self.version
-            Gem.loaded_specs['dalli'] && Gem.loaded_specs['dalli'].version
+            Gem.loaded_specs['dalli']&.version
           end
 
           def self.loaded?

data/lib/datadog/tracing/contrib/delayed_job/integration.rb

@@ -18,7 +18,7 @@ module Datadog
           register_as :delayed_job
 
           def self.version
-            Gem.loaded_specs['delayed_job'] && Gem.loaded_specs['delayed_job'].version
+            Gem.loaded_specs['delayed_job']&.version
           end
 
           def self.loaded?

data/lib/datadog/tracing/contrib/elasticsearch/ext.rb

@@ -23,10 +23,11 @@ module Datadog
           TAG_COMPONENT = 'elasticsearch'
           TAG_OPERATION_QUERY = 'query'
           TAG_SYSTEM = 'elasticsearch'
-          PEER_SERVICE_SOURCES = Array[
+          PEER_SERVICE_SOURCES = [
             Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
             Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
-            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,].freeze
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,
+          ].freeze
         end
       end
     end

data/lib/datadog/tracing/contrib/elasticsearch/integration.rb

@@ -20,10 +20,10 @@ module Datadog
           def self.version
             # elastic-transport gem for version >= 8.0.0
             # elasticsearch-transport gem for version < 8.0.0
-            Gem.loaded_specs['elastic-transport'] \
-              && Gem.loaded_specs['elastic-transport'].version || \
-              Gem.loaded_specs['elasticsearch-transport'] \
-                && Gem.loaded_specs['elasticsearch-transport'].version
+
+            Gem.loaded_specs['elastic-transport']&.version ||
+
+              Gem.loaded_specs['elasticsearch-transport']&.version
           end
 
           def self.loaded?