datadog 2.8.0 → 2.39.0

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'ext'
+require_relative "ext"
 
 module Datadog
   module Tracing
@@ -11,7 +11,7 @@ module Datadog
         NO_SOURCE = [].freeze
 
         def self.fetch_service_name(env, default)
-          ENV.fetch(env) do
+          DATADOG_ENV.fetch(env) do
             if Datadog.configuration.tracing.contrib.global_default_service_name.enabled
               return Datadog.configuration.service
             end
@@ -21,9 +21,14 @@ module Datadog
         end
 
         def self.set_peer_service!(span, sources)
+          config = Datadog.configuration.tracing.contrib
+
+          # If `peer_service_defaults` is disabled, we only read peer service from an explicitly set `peer.service` tag
+          sources = Datadog::Tracing::Contrib::SpanAttributeSchema::REFLEXIVE_SOURCES unless config.peer_service_defaults
+
           # Acquire all peer.service values as well as any potential remapping
           peer_service_val, peer_service_source = set_peer_service_from_source(span, sources)
-          remap_val = Datadog.configuration.tracing.contrib.peer_service_mapping[peer_service_val]
+          remap_val = config.peer_service_mapping[peer_service_val]
 
           # Only continue to setting peer.service if actual source is found
           return false unless peer_service_source
@@ -82,7 +87,7 @@ module Datadog
         private_class_method :filter_peer_service_sources
 
         def self.not_empty_tag?(tag)
-          tag && (tag != '')
+          tag && (tag != "")
         end
 
         private_class_method :not_empty_tag?

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

@@ -8,10 +8,10 @@ module Datadog
         class << self
           def call(value)
             [].tap do |array|
-              value.split(',').each do |e|
+              value.split(",").each do |e|
                 next unless e
 
-                v = e.split('-')
+                v = e.split("-")
 
                 case v.length
                 when 0 then next

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

@@ -5,9 +5,17 @@ module Datadog
     module Contrib
       # Useful checking whether the defined range covers status code
       class StatusRangeMatcher
+        attr_reader :ranges
+
         def initialize(ranges)
-          @ranges = Array(ranges)
+          # Steep: https://github.com/ruby/rbs/issues/1874
+          @ranges = Array(ranges) # steep:ignore IncompatibleAssignment
+        end
+
+        def +(other)
+          StatusRangeMatcher.new(@ranges + other.ranges)
         end
+        alias_method :concat, :+
 
         def include?(status)
           @ranges.any? do |e|
@@ -19,6 +27,10 @@ module Datadog
             end
           end
         end
+
+        def to_s
+          @ranges.map { |range| range.is_a?(Range) ? "#{range.begin}-#{range.end}" : range.to_s }.join(",")
+        end
       end
     end
   end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../../configuration/settings'
-require_relative '../ext'
+require_relative "../../configuration/settings"
+require_relative "../ext"
 
 module Datadog
   module Tracing

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

@@ -7,19 +7,19 @@ module Datadog
         # Stripe integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_STRIPE_ENABLED'
+          ENV_ENABLED = "DD_TRACE_STRIPE_ENABLED"
           # @!visibility private
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_STRIPE_ANALYTICS_ENABLED'
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_STRIPE_ANALYTICS_SAMPLE_RATE'
-          SPAN_REQUEST = 'stripe.request'
-          SPAN_TYPE_REQUEST = 'custom'
-          TAG_COMPONENT = 'stripe'
-          TAG_OPERATION_REQUEST = 'request'
-          TAG_REQUEST_HTTP_STATUS = 'stripe.request.http_status'
-          TAG_REQUEST_ID = 'stripe.request.id'
-          TAG_REQUEST_METHOD = 'stripe.request.method'
-          TAG_REQUEST_NUM_RETRIES = 'stripe.request.num_retries'
-          TAG_REQUEST_PATH = 'stripe.request.path'
+          ENV_ANALYTICS_ENABLED = "DD_TRACE_STRIPE_ANALYTICS_ENABLED"
+          ENV_ANALYTICS_SAMPLE_RATE = "DD_TRACE_STRIPE_ANALYTICS_SAMPLE_RATE"
+          SPAN_REQUEST = "stripe.request"
+          SPAN_TYPE_REQUEST = "custom"
+          TAG_COMPONENT = "stripe"
+          TAG_OPERATION_REQUEST = "request"
+          TAG_REQUEST_HTTP_STATUS = "stripe.request.http_status"
+          TAG_REQUEST_ID = "stripe.request.id"
+          TAG_REQUEST_METHOD = "stripe.request.method"
+          TAG_REQUEST_NUM_RETRIES = "stripe.request.num_retries"
+          TAG_REQUEST_PATH = "stripe.request.path"
         end
       end
     end

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../integration'
-require_relative 'configuration/settings'
-require_relative 'patcher'
+require_relative "../integration"
+require_relative "configuration/settings"
+require_relative "patcher"
 
 module Datadog
   module Tracing
@@ -12,13 +12,13 @@ module Datadog
         class Integration
           include Contrib::Integration
 
-          MINIMUM_VERSION = Gem::Version.new('5.15.0')
+          MINIMUM_VERSION = Gem::Version.new("5.15.0")
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :stripe
 
           def self.version
-            Gem.loaded_specs['stripe'] && Gem.loaded_specs['stripe'].version
+            Gem.loaded_specs["stripe"]&.version
           end
 
           def self.loaded?

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../patcher'
-require_relative 'request'
+require_relative "../patcher"
+require_relative "request"
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/stripe/request.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../../metadata/ext'
-require_relative '../../analytics'
-require_relative 'ext'
+require_relative "../../metadata/ext"
+require_relative "../../analytics"
+require_relative "ext"
 
 module Datadog
   module Tracing
@@ -54,8 +54,8 @@ module Datadog
             span.set_tag(Ext::TAG_REQUEST_METHOD, event.method)
             span.set_tag(Ext::TAG_REQUEST_PATH, event.path)
             span.set_tag(Ext::TAG_REQUEST_NUM_RETRIES, event.num_retries.to_s)
-          rescue StandardError => e
-            Datadog.logger.debug(e.message)
+          rescue => e
+            Datadog.logger.debug { "#{e.class}: #{e.message}" }
           end
 
           def configuration

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../../configuration/settings'
-require_relative '../ext'
+require_relative "../../configuration/settings"
+require_relative "../ext"
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/sucker_punch/exception_handler.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'sucker_punch'
+require "sucker_punch"
 
 module Datadog
   module Tracing

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

@@ -7,20 +7,20 @@ module Datadog
         # SuckerPunch integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_SUCKER_PUNCH_ENABLED'
+          ENV_ENABLED = "DD_TRACE_SUCKER_PUNCH_ENABLED"
           # @!visibility private
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_SUCKER_PUNCH_ANALYTICS_ENABLED'
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SUCKER_PUNCH_ANALYTICS_SAMPLE_RATE'
-          SERVICE_NAME = 'sucker_punch'
-          SPAN_PERFORM = 'sucker_punch.perform'
-          SPAN_PERFORM_ASYNC = 'sucker_punch.perform_async'
-          SPAN_PERFORM_IN = 'sucker_punch.perform_in'
-          TAG_PERFORM_IN = 'sucker_punch.perform_in'
-          TAG_QUEUE = 'sucker_punch.queue'
-          TAG_COMPONENT = 'sucker_punch'
-          TAG_OPERATION_PERFORM = 'perform'
-          TAG_OPERATION_PERFORM_ASYNC = 'perform_async'
-          TAG_OPERATION_PERFORM_IN = 'perform_in'
+          ENV_ANALYTICS_ENABLED = "DD_TRACE_SUCKER_PUNCH_ANALYTICS_ENABLED"
+          ENV_ANALYTICS_SAMPLE_RATE = "DD_TRACE_SUCKER_PUNCH_ANALYTICS_SAMPLE_RATE"
+          SERVICE_NAME = "sucker_punch"
+          SPAN_PERFORM = "sucker_punch.perform"
+          SPAN_PERFORM_ASYNC = "sucker_punch.perform_async"
+          SPAN_PERFORM_IN = "sucker_punch.perform_in"
+          TAG_PERFORM_IN = "sucker_punch.perform_in"
+          TAG_QUEUE = "sucker_punch.queue"
+          TAG_COMPONENT = "sucker_punch"
+          TAG_OPERATION_PERFORM = "perform"
+          TAG_OPERATION_PERFORM_ASYNC = "perform_async"
+          TAG_OPERATION_PERFORM_IN = "perform_in"
         end
       end
     end

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'sucker_punch'
+require "sucker_punch"
 
-require_relative '../../metadata/ext'
-require_relative '../analytics'
-require_relative 'ext'
+require_relative "../../metadata/ext"
+require_relative "../analytics"
+require_relative "ext"
 
 module Datadog
   module Tracing
@@ -86,6 +86,7 @@ module Datadog
 
               def __with_instrumentation(name)
                 Datadog::Tracing.trace(name, service: datadog_configuration[:service_name]) do |span|
+                  span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_SVC_SRC, Ext::TAG_COMPONENT)
                   span.type = Datadog::Tracing::Metadata::Ext::AppTypes::TYPE_WORKER
                   span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
                   span.set_tag(Ext::TAG_QUEUE, to_s)

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../integration'
-require_relative 'configuration/settings'
-require_relative 'patcher'
+require_relative "../integration"
+require_relative "configuration/settings"
+require_relative "patcher"
 
 module Datadog
   module Tracing
@@ -12,13 +12,13 @@ module Datadog
         class Integration
           include Contrib::Integration
 
-          MINIMUM_VERSION = Gem::Version.new('2.0.0')
+          MINIMUM_VERSION = Gem::Version.new("2.0.0")
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :sucker_punch, auto_patch: true
 
           def self.version
-            Gem.loaded_specs['sucker_punch'] && Gem.loaded_specs['sucker_punch'].version
+            Gem.loaded_specs["sucker_punch"]&.version
           end
 
           def self.loaded?

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../patcher'
-require_relative 'ext'
+require_relative "../patcher"
+require_relative "ext"
 
 module Datadog
   module Tracing
@@ -18,8 +18,8 @@ module Datadog
           end
 
           def patch
-            require_relative 'exception_handler'
-            require_relative 'instrumentation'
+            require_relative "exception_handler"
+            require_relative "instrumentation"
 
             ExceptionHandler.patch!
             Instrumentation.patch!

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      # Miscellaneous support methods to aid in the creation of integrations.
+      module Support
+        module_function
+
+        # Checks if a constant is loaded in a module, handling autoloaded constants correctly.
+        #
+        # This method is particularly useful when you need to check if a constant is fully loaded,
+        # not just defined. It handles the special case of autoloaded constants, which return
+        # non-nil for `defined?` even when they haven't been loaded yet.
+        #
+        # @param base_module [Module] the module to check for the constant
+        # @param constant [Symbol] the name of the constant to check
+        # @return [Boolean] true if the constant has been loaded, false otherwise
+        def fully_loaded?(base_module, constant)
+          # Autoload constants return `constant` for `defined?`, but that doesn't mean they are loaded...
+          base_module.const_defined?(constant) &&
+            # ... to check that we need to call `autoload?`. If it returns `nil`, it's loaded.
+            base_module.autoload?(constant).nil?
+        end
+      end
+    end
+  end
+end

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative '../../configuration/settings'
-require_relative '../ext'
+require_relative "../../configuration/settings"
+require_relative "../ext"
 
-require_relative '../../propagation/sql_comment'
+require_relative "../../propagation/sql_comment"
 
 module Datadog
   module Tracing
@@ -51,6 +51,12 @@ module Datadog
               o.default false
             end
 
+            option :inject_sql_basehash do |o|
+              o.type :bool
+              o.env Contrib::Propagation::SqlComment::Ext::ENV_DBM_INJECT_SQL_BASEHASH
+              o.default false
+            end
+
             option :peer_service do |o|
               o.type :string, nilable: true
               o.env Ext::ENV_PEER_SERVICE

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

@@ -7,19 +7,19 @@ module Datadog
         # Trilogy integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_TRILOGY_ENABLED'
-          ENV_SERVICE_NAME = 'DD_TRACE_TRILOGY_SERVICE_NAME'
-          ENV_PEER_SERVICE = 'DD_TRACE_TRILOGY_PEER_SERVICE'
+          ENV_ENABLED = "DD_TRACE_TRILOGY_ENABLED"
+          ENV_SERVICE_NAME = "DD_TRACE_TRILOGY_SERVICE_NAME"
+          ENV_PEER_SERVICE = "DD_TRACE_TRILOGY_PEER_SERVICE"
 
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_TRILOGY_ANALYTICS_ENABLED'
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_TRILOGY_ANALYTICS_SAMPLE_RATE'
-          DEFAULT_PEER_SERVICE_NAME = 'trilogy'
-          SPAN_QUERY = 'trilogy.query'
-          TAG_DB_NAME = 'trilogy.db.name'
-          TAG_COMPONENT = 'trilogy'
-          TAG_OPERATION_QUERY = 'query'
-          TAG_SYSTEM = 'mysql'
-          PEER_SERVICE_SOURCES = (Array[Ext::TAG_DB_NAME] + Contrib::Ext::DB::PEER_SERVICE_SOURCES).freeze
+          ENV_ANALYTICS_ENABLED = "DD_TRACE_TRILOGY_ANALYTICS_ENABLED"
+          ENV_ANALYTICS_SAMPLE_RATE = "DD_TRACE_TRILOGY_ANALYTICS_SAMPLE_RATE"
+          DEFAULT_PEER_SERVICE_NAME = "trilogy"
+          SPAN_QUERY = "trilogy.query"
+          TAG_DB_NAME = "trilogy.db.name"
+          TAG_COMPONENT = "trilogy"
+          TAG_OPERATION_QUERY = "query"
+          TAG_SYSTEM = "mysql"
+          PEER_SERVICE_SOURCES = ([Ext::TAG_DB_NAME] + Contrib::Ext::DB::PEER_SERVICE_SOURCES).freeze
         end
       end
     end

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative '../../metadata/ext'
-require_relative '../analytics'
-require_relative 'ext'
-require_relative '../ext'
-require_relative '../propagation/sql_comment'
-require_relative '../propagation/sql_comment/mode'
+require_relative "../../metadata/ext"
+require_relative "../analytics"
+require_relative "ext"
+require_relative "../ext"
+require_relative "../propagation/sql_comment"
+require_relative "../propagation/sql_comment/mode"
 
 module Datadog
   module Tracing
@@ -23,6 +23,7 @@ module Datadog
               service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
 
               Tracing.trace(Ext::SPAN_QUERY, service: service) do |span, trace_op|
+                span.set_tag(Tracing::Metadata::Ext::TAG_SVC_SRC, Ext::TAG_COMPONENT)
                 span.resource = sql
                 span.type = Tracing::Metadata::Ext::SQL::TYPE
 
@@ -33,11 +34,6 @@ module Datadog
                   )
                 end
 
-                # Tag original global service name if not used
-                if span.service != Datadog.configuration.service
-                  span.set_tag(Tracing::Contrib::Ext::Metadata::TAG_BASE_SERVICE, Datadog.configuration.service)
-                end
-
                 span.set_tag(Contrib::Ext::DB::TAG_SYSTEM, Ext::TAG_SYSTEM)
                 span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
 
@@ -57,7 +53,9 @@ module Datadog
                 Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
 
                 propagation_mode = Contrib::Propagation::SqlComment::Mode.new(
-                  comment_propagation, datadog_configuration[:append_comment]
+                  comment_propagation,
+                  datadog_configuration[:append_comment],
+                  datadog_configuration[:inject_sql_basehash]
                 )
 
                 Contrib::Propagation::SqlComment.annotate!(span, propagation_mode)

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../integration'
-require_relative 'configuration/settings'
-require_relative 'patcher'
+require_relative "../integration"
+require_relative "configuration/settings"
+require_relative "patcher"
 
 module Datadog
   module Tracing
@@ -12,13 +12,13 @@ module Datadog
         class Integration
           include Contrib::Integration
 
-          MINIMUM_VERSION = Gem::Version.new('2.0.0')
+          MINIMUM_VERSION = Gem::Version.new("2.0.0")
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :trilogy
 
           def self.version
-            Gem.loaded_specs['trilogy'] && Gem.loaded_specs['trilogy'].version
+            Gem.loaded_specs["trilogy"]&.version
           end
 
           def self.loaded?

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../patcher'
-require_relative 'instrumentation'
+require_relative "../patcher"
+require_relative "instrumentation"
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/utils/database.rb

@@ -6,9 +6,9 @@ module Datadog
       module Utils
         # Common database-related utility functions.
         module Database
-          VENDOR_DEFAULT = 'defaultdb'
-          VENDOR_POSTGRES = 'postgres'
-          VENDOR_SQLITE = 'sqlite'
+          VENDOR_DEFAULT = "defaultdb"
+          VENDOR_POSTGRES = "postgres"
+          VENDOR_SQLITE = "sqlite"
 
           module_function
 
@@ -16,9 +16,9 @@ module Datadog
             case vendor
             when nil
               VENDOR_DEFAULT
-            when 'postgresql'
+            when "postgresql"
               VENDOR_POSTGRES
-            when 'sqlite3'
+            when "sqlite3"
               VENDOR_SQLITE
             else
               vendor

data/lib/datadog/tracing/contrib/utils/quantization/{hash.rb → hash_formatter.rb}

@@ -6,11 +6,13 @@ module Datadog
       module Utils
         module Quantization
           # Quantization for Hash
-          module Hash
-            PLACEHOLDER = '?'
+          module HashFormatter
+            PLACEHOLDER = "?"
             EXCLUDE_KEYS = [].freeze
             SHOW_KEYS = [].freeze
-            DEFAULT_OPTIONS = {
+
+            # Steep: https://github.com/soutaro/steep/issues/363
+            DEFAULT_OPTIONS = { # steep:ignore IncompatibleAssignment
               exclude: EXCLUDE_KEYS,
               show: SHOW_KEYS,
               placeholder: PLACEHOLDER
@@ -21,7 +23,7 @@ module Datadog
             def format(hash_obj, options = {})
               options ||= {}
               format!(hash_obj, options)
-            rescue StandardError
+            rescue
               options[:placeholder] || PLACEHOLDER
             end
 
@@ -66,7 +68,7 @@ module Datadog
             def format_array(value, options)
               if value.any? { |v| v.class <= ::Hash || v.class <= Array }
                 first_entry = format_value(value.first, options)
-                value.size > 1 ? [first_entry, options[:placeholder]] : [first_entry]
+                (value.size > 1) ? [first_entry, options[:placeholder]] : [first_entry]
                 # Otherwise short-circuit and return single placeholder
               else
                 [options[:placeholder]]
@@ -77,19 +79,19 @@ module Datadog
               {}.tap do |options|
                 # Show
                 # If either is :all, value becomes :all
-                options[:show] =  if original[:show] == :all || additional[:show] == :all
-                                    :all
-                                  else
-                                    (original[:show] || []).dup.concat(additional[:show] || []).uniq
-                                  end
+                options[:show] = if original[:show] == :all || additional[:show] == :all
+                  :all
+                else
+                  (original[:show] || []).dup.concat(additional[:show] || []).uniq
+                end
 
                 # Exclude
                 # If either is :all, value becomes :all
                 options[:exclude] = if original[:exclude] == :all || additional[:exclude] == :all
-                                      :all
-                                    else
-                                      (original[:exclude] || []).dup.concat(additional[:exclude] || []).uniq
-                                    end
+                  :all
+                else
+                  (original[:exclude] || []).dup.concat(additional[:exclude] || []).uniq
+                end
 
                 options[:placeholder] = additional[:placeholder] || original[:placeholder]
               end