ddtrace 1.12.1 → 1.23.2

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Tracing
     module Contrib
@@ -5,14 +7,15 @@ module Datadog
         # ActionPack integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_ACTION_PACK_ENABLED'.freeze
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_PACK_ANALYTICS_ENABLED'.freeze
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_PACK_ANALYTICS_SAMPLE_RATE'.freeze
-          SPAN_ACTION_CONTROLLER = 'rails.action_controller'.freeze
-          TAG_COMPONENT = 'action_pack'.freeze
-          TAG_OPERATION_CONTROLLER = 'controller'.freeze
-          TAG_ROUTE_ACTION = 'rails.route.action'.freeze
-          TAG_ROUTE_CONTROLLER = 'rails.route.controller'.freeze
+          ENV_ENABLED = 'DD_TRACE_ACTION_PACK_ENABLED'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_PACK_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_PACK_ANALYTICS_SAMPLE_RATE'
+          SPAN_ACTION_CONTROLLER = 'rails.action_controller'
+          TAG_COMPONENT = 'action_pack'
+          TAG_OPERATION_CONTROLLER = 'controller'
+          TAG_ROUTE_ACTION = 'rails.route.action'
+          TAG_ROUTE_CONTROLLER = 'rails.route.controller'
         end
       end
     end

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

@@ -10,18 +10,22 @@ module Datadog
           # @public_api
           class Settings < Contrib::Configuration::Settings
             option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ANALYTICS_ENABLED
+              o.default false
             end
 
             option :analytics_sample_rate do |o|
-              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
-              o.lazy
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
             end
 
             option :service_name

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Tracing
     module Contrib
@@ -5,16 +7,17 @@ module Datadog
         # ActionView integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_ACTION_VIEW_ENABLED'.freeze
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_VIEW_ANALYTICS_ENABLED'.freeze
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_VIEW_ANALYTICS_SAMPLE_RATE'.freeze
-          SPAN_RENDER_PARTIAL = 'rails.render_partial'.freeze
-          SPAN_RENDER_TEMPLATE = 'rails.render_template'.freeze
-          TAG_COMPONENT = 'action_view'.freeze
-          TAG_LAYOUT = 'rails.layout'.freeze
-          TAG_OPERATION_RENDER_PARTIAL = 'render_partial'.freeze
-          TAG_OPERATION_RENDER_TEMPLATE = 'render_template'.freeze
-          TAG_TEMPLATE_NAME = 'rails.template_name'.freeze
+          ENV_ENABLED = 'DD_TRACE_ACTION_VIEW_ENABLED'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_VIEW_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_VIEW_ANALYTICS_SAMPLE_RATE'
+          SPAN_RENDER_PARTIAL = 'rails.render_partial'
+          SPAN_RENDER_TEMPLATE = 'rails.render_template'
+          TAG_COMPONENT = 'action_view'
+          TAG_LAYOUT = 'rails.layout'
+          TAG_OPERATION_RENDER_PARTIAL = 'render_partial'
+          TAG_OPERATION_RENDER_TEMPLATE = 'render_template'
+          TAG_TEMPLATE_NAME = 'rails.template_name'
         end
       end
     end

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

@@ -13,22 +13,29 @@ module Datadog
           # @public_api
           class Settings < Contrib::Configuration::Settings
             option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ANALYTICS_ENABLED
+              o.default false
             end
 
             option :analytics_sample_rate do |o|
-              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
-              o.lazy
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
             end
 
             option :service_name
-            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+            option :error_handler do |o|
+              o.type :proc
+              o.default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
+            end
           end
         end
       end

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

@@ -1,35 +1,38 @@
+# frozen_string_literal: true
+
 module Datadog
   module Tracing
     module Contrib
       module ActiveJob
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_ACTIVE_JOB_ENABLED'.freeze
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_ENABLED'.freeze
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_SAMPLE_RATE'.freeze
+          ENV_ENABLED = 'DD_TRACE_ACTIVE_JOB_ENABLED'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_SAMPLE_RATE'
 
-          SPAN_DISCARD = 'active_job.discard'.freeze
-          SPAN_ENQUEUE = 'active_job.enqueue'.freeze
-          SPAN_ENQUEUE_RETRY = 'active_job.enqueue_retry'.freeze
-          SPAN_PERFORM = 'active_job.perform'.freeze
-          SPAN_RETRY_STOPPED = 'active_job.retry_stopped'.freeze
+          SPAN_DISCARD = 'active_job.discard'
+          SPAN_ENQUEUE = 'active_job.enqueue'
+          SPAN_ENQUEUE_RETRY = 'active_job.enqueue_retry'
+          SPAN_PERFORM = 'active_job.perform'
+          SPAN_RETRY_STOPPED = 'active_job.retry_stopped'
 
-          TAG_COMPONENT = 'active_job'.freeze
-          TAG_OPERATION_DISCARD = 'discard'.freeze
-          TAG_OPERATION_ENQUEUE = 'enqueue'.freeze
-          TAG_OPERATION_ENQUEUE_AT = 'enqueue_at'.freeze
-          TAG_OPERATION_ENQUEUE_RETRY = 'enqueue_retry'.freeze
-          TAG_OPERATION_PERFORM = 'perform'.freeze
-          TAG_OPERATION_RETRY_STOPPED = 'retry_stopped'.freeze
+          TAG_COMPONENT = 'active_job'
+          TAG_OPERATION_DISCARD = 'discard'
+          TAG_OPERATION_ENQUEUE = 'enqueue'
+          TAG_OPERATION_ENQUEUE_AT = 'enqueue_at'
+          TAG_OPERATION_ENQUEUE_RETRY = 'enqueue_retry'
+          TAG_OPERATION_PERFORM = 'perform'
+          TAG_OPERATION_RETRY_STOPPED = 'retry_stopped'
 
-          TAG_ADAPTER = 'active_job.adapter'.freeze
-          TAG_JOB_ERROR = 'active_job.job.error'.freeze
-          TAG_JOB_EXECUTIONS = 'active_job.job.executions'.freeze
-          TAG_JOB_ID = 'active_job.job.id'.freeze
-          TAG_JOB_PRIORITY = 'active_job.job.priority'.freeze
-          TAG_JOB_QUEUE = 'active_job.job.queue'.freeze
-          TAG_JOB_RETRY_WAIT = 'active_job.job.retry_wait'.freeze
-          TAG_JOB_SCHEDULED_AT = 'active_job.job.scheduled_at'.freeze
+          TAG_ADAPTER = 'active_job.adapter'
+          TAG_JOB_ERROR = 'active_job.job.error'
+          TAG_JOB_EXECUTIONS = 'active_job.job.executions'
+          TAG_JOB_ID = 'active_job.job.id'
+          TAG_JOB_PRIORITY = 'active_job.job.priority'
+          TAG_JOB_QUEUE = 'active_job.job.queue'
+          TAG_JOB_RETRY_WAIT = 'active_job.job.retry_wait'
+          TAG_JOB_SCHEDULED_AT = 'active_job.job.scheduled_at'
         end
       end
     end

data/lib/datadog/tracing/contrib/active_job/log_injection.rb

@@ -9,7 +9,7 @@ module Datadog
           def self.included(base)
             base.class_eval do
               around_perform do |_, block|
-                if logger.respond_to?(:tagged)
+                if Datadog.configuration.tracing.log_injection && logger.respond_to?(:tagged)
                   logger.tagged(Tracing.log_correlation, &block)
                 else
                   block.call

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

@@ -21,7 +21,7 @@ module Datadog
 
           def patch
             Events.subscribe!
-            inject_log_correlation if Datadog.configuration.tracing.log_injection
+            inject_log_correlation
           end
 
           def inject_log_correlation

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

@@ -12,18 +12,22 @@ module Datadog
           # @public_api
           class Settings < Contrib::Configuration::Settings
             option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ANALYTICS_ENABLED
+              o.default false
             end
 
             option :analytics_sample_rate do |o|
-              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
-              o.lazy
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
             end
           end
         end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Tracing
     module Contrib
@@ -5,16 +7,17 @@ module Datadog
         # ActiveModelSerializers integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ENABLED'.freeze
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_ENABLED'.freeze
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_SAMPLE_RATE'.freeze
-          SPAN_RENDER = 'active_model_serializers.render'.freeze
-          SPAN_SERIALIZE = 'active_model_serializers.serialize'.freeze
-          TAG_ADAPTER = 'active_model_serializers.adapter'.freeze
-          TAG_COMPONENT = 'active_model_serializers'.freeze
-          TAG_OPERATION_RENDER = 'render'.freeze
-          TAG_OPERATION_SERIALIZE = 'serialize'.freeze
-          TAG_SERIALIZER = 'active_model_serializers.serializer'.freeze
+          ENV_ENABLED = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ENABLED'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_SAMPLE_RATE'
+          SPAN_RENDER = 'active_model_serializers.render'
+          SPAN_SERIALIZE = 'active_model_serializers.serialize'
+          TAG_ADAPTER = 'active_model_serializers.adapter'
+          TAG_COMPONENT = 'active_model_serializers'
+          TAG_OPERATION_RENDER = 'render'
+          TAG_OPERATION_SERIALIZE = 'serialize'
+          TAG_SERIALIZER = 'active_model_serializers.serializer'
         end
       end
     end

data/lib/datadog/tracing/contrib/active_record/configuration/resolver.rb

@@ -65,9 +65,14 @@ module Datadog
 
               config
             rescue => e
+              # Resolving a valid database configuration should not raise an exception,
+              # but if it does, it can be due to adding a broken pattern match prior to this call.
+              #
+              # `db_config` input may contain sensitive information such as passwords,
+              # hence provide a succinct summary for the error logging.
               Datadog.logger.error(
-                "Failed to resolve ActiveRecord configuration key #{db_config.inspect}. " \
-                "Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+                'Failed to resolve ActiveRecord database configuration. '\
+                "Cause: #{e.class.name} Source: #{Array(e.backtrace).first}"
               )
 
               nil
@@ -85,23 +90,32 @@ module Datadog
               normalized
             rescue => e
               Datadog.logger.error(
-                "Failed to resolve ActiveRecord configuration key #{matcher.inspect}. " \
-                "Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+                "Failed to resolve key #{matcher.inspect}. " \
+                "Cause: #{e.class.name} Source: #{Array(e.backtrace).first}"
               )
+
+              nil
             end
 
+            #
+            # `::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver` exists from 4+ til from 6.0.x
+            #
+            # `::ActiveRecord::DatabaseConfigurations` was introduced from 6+,
+            # but from 6.1.x, it was refactored to encapsulates the resolving logic, hence removing the resolver
+            #
             def connection_resolver
-              @resolver ||= if defined?(::ActiveRecord::Base.configurations.resolve)
-                              ::ActiveRecord::DatabaseConfigurations.new(active_record_configuration)
-                            elsif defined?(::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver)
-                              ::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(
-                                active_record_configuration
-                              )
-                            else
-                              Contrib::ActiveRecord::Vendor::ConnectionAdapters::ConnectionSpecification::Resolver.new(
-                                active_record_configuration
-                              )
-                            end
+              @resolver ||=
+                # From 6.1+
+                if defined?(::ActiveRecord::Base.configurations.resolve)
+                  ::ActiveRecord::DatabaseConfigurations.new(active_record_configuration)
+                # From 4+ to 6.0.x
+                elsif defined?(::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver)
+                  ::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(active_record_configuration)
+                else
+                  Contrib::ActiveRecord::Vendor::ConnectionAdapters::ConnectionSpecification::Resolver.new(
+                    active_record_configuration
+                  )
+                end
             end
 
             def resolve_connection_key(key)

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

@@ -13,18 +13,22 @@ module Datadog
           # @public_api
           class Settings < Contrib::Configuration::Settings
             option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ANALYTICS_ENABLED
+              o.default false
             end
 
             option :analytics_sample_rate do |o|
-              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
-              o.lazy
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
             end
 
             option :service_name do |o|
@@ -34,7 +38,6 @@ module Datadog
                   Utils.adapter_name
                 )
               end
-              o.lazy
             end
           end
         end

data/lib/datadog/tracing/contrib/active_record/events/sql.rb

@@ -45,14 +45,10 @@ module Datadog
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_SQL)
 
-              # Tag as an external peer service
-              if Contrib::SpanAttributeSchema.default_span_attribute_schema?
-                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              if service_name != Datadog.configuration.service
+                span.set_tag(Tracing::Contrib::Ext::Metadata::TAG_BASE_SERVICE, Datadog.configuration.service)
               end
 
-              # TODO: Populate hostname for JDBC connections
-              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, config[:host]) if config[:host]
-
               # Set analytics sample rate
               if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
                 Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Tracing
     module Contrib
@@ -5,21 +7,22 @@ module Datadog
         # ActiveRecord integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_ACTIVE_RECORD_ENABLED'.freeze
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_RECORD_ANALYTICS_ENABLED'.freeze
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_RECORD_ANALYTICS_SAMPLE_RATE'.freeze
-          SERVICE_NAME = 'active_record'.freeze
-          SPAN_INSTANTIATION = 'active_record.instantiation'.freeze
-          SPAN_SQL = 'active_record.sql'.freeze
-          SPAN_TYPE_INSTANTIATION = 'custom'.freeze
-          TAG_COMPONENT = 'active_record'.freeze
-          TAG_OPERATION_INSTANTIATION = 'instantiation'.freeze
-          TAG_OPERATION_SQL = 'sql'.freeze
-          TAG_DB_CACHED = 'active_record.db.cached'.freeze
-          TAG_DB_NAME = 'active_record.db.name'.freeze
-          TAG_DB_VENDOR = 'active_record.db.vendor'.freeze
-          TAG_INSTANTIATION_CLASS_NAME = 'active_record.instantiation.class_name'.freeze
-          TAG_INSTANTIATION_RECORD_COUNT = 'active_record.instantiation.record_count'.freeze
+          ENV_ENABLED = 'DD_TRACE_ACTIVE_RECORD_ENABLED'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_RECORD_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_RECORD_ANALYTICS_SAMPLE_RATE'
+          SERVICE_NAME = 'active_record'
+          SPAN_INSTANTIATION = 'active_record.instantiation'
+          SPAN_SQL = 'active_record.sql'
+          SPAN_TYPE_INSTANTIATION = 'custom'
+          TAG_COMPONENT = 'active_record'
+          TAG_OPERATION_INSTANTIATION = 'instantiation'
+          TAG_OPERATION_SQL = 'sql'
+          TAG_DB_CACHED = 'active_record.db.cached'
+          TAG_DB_NAME = 'active_record.db.name'
+          TAG_DB_VENDOR = 'active_record.db.vendor'
+          TAG_INSTANTIATION_CLASS_NAME = 'active_record.instantiation.class_name'
+          TAG_INSTANTIATION_RECORD_COUNT = 'active_record.instantiation.record_count'
         end
       end
     end

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

@@ -113,7 +113,7 @@ module Datadog
 
           # @return [Hash]
           def self.db_config(connection_pool)
-            if ::Rails::VERSION::MAJOR >= 6 && ::Rails::VERSION::MINOR >= 1
+            if connection_pool.respond_to? :db_config
               connection_pool.db_config.configuration_hash
             else
               connection_pool.spec.config