ddtrace 1.12.1 → 1.18.0

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

@@ -6,7 +6,7 @@ module Datadog
   module Tracing
     module Contrib
       module ConcurrentRuby
-        # wraps existing executor to carry over trace context
+        # Wraps existing executor to carry over trace context
         class ContextCompositeExecutorService
           include Concurrent::ExecutorService
 
@@ -16,20 +16,20 @@ module Datadog
             @composited_executor = composited_executor
           end
 
-          # post method runs the task within composited executor - in a different thread
+          # 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)
-            tracer = Tracing.send(:tracer)
-            parent_context = tracer.provider.context
-
-            @composited_executor.post(*args) do
-              begin
-                original_context = tracer.provider.context
-                tracer.provider.context = parent_context
-                yield
-              ensure
-                # Restore context in case the current thread gets reused
-                tracer.provider.context = original_context
-              end
+            digest = Tracing.active_trace && 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
+            # pushes them (possibly transformed) as block args
+            executor.post(*args) do |*block_args|
+              Tracing.continue_trace!(digest)
+
+              # Pass the executor-provided block args as they should have been
+              # originally passed without composition, see ChainPromise#on_resolvable
+              yield(*block_args)
             end
           end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Tracing
     module Contrib
@@ -5,8 +7,8 @@ module Datadog
         # ConcurrentRuby integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          APP = 'concurrent-ruby'.freeze
-          ENV_ENABLED = 'DD_TRACE_CONCURRENT_RUBY_ENABLED'.freeze
+          APP = 'concurrent-ruby'
+          ENV_ENABLED = 'DD_TRACE_CONCURRENT_RUBY_ENABLED'
         end
       end
     end

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

@@ -8,17 +8,10 @@ module Datadog
       module ConcurrentRuby
         # This patches the Future - to wrap executor service using ContextCompositeExecutorService
         module FuturePatch
-          def self.included(base)
-            base.class_eval do
-              alias_method :ns_initialize_without_datadog, :ns_initialize
-              remove_method(:ns_initialize)
+          def ns_initialize(value, opts)
+            super(value, opts)
 
-              def ns_initialize(value, opts)
-                ns_initialize_without_datadog(value, opts)
-
-                @executor = ContextCompositeExecutorService.new(@executor)
-              end
-            end
+            @executor = ContextCompositeExecutorService.new(@executor)
           end
         end
       end

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

@@ -20,7 +20,8 @@ module Datadog
           end
 
           def self.loaded?
-            !defined?(::Concurrent::Future).nil?
+            # Concurrent::Future is deprecated in favour of Concurrent::Promises::Future
+            !defined?(::Concurrent::Promises::Future).nil? || !defined?(::Concurrent::Future).nil?
           end
 
           def self.compatible?

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

@@ -19,11 +19,18 @@ module Datadog
           def patch
             require_relative 'future_patch'
             patch_future
+            require_relative 'promises_future_patch'
+            patch_promises_future
           end
 
           # Propagate tracing context in Concurrent::Future
           def patch_future
-            ::Concurrent::Future.include(FuturePatch)
+            ::Concurrent::Future.prepend(FuturePatch) if defined?(::Concurrent::Future)
+          end
+
+          # Propagate tracing context in Concurrent::Promises::Future
+          def patch_promises_future
+            ::Concurrent::Promises.singleton_class.prepend(PromisesFuturePatch) if defined?(::Concurrent::Promises::Future)
           end
         end
       end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'context_composite_executor_service'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ConcurrentRuby
+        # This patches the Future - to wrap executor service using ContextCompositeExecutorService
+        module PromisesFuturePatch
+          def future_on(default_executor, *args, &task)
+            unless default_executor.is_a?(ContextCompositeExecutorService)
+              default_executor = ContextCompositeExecutorService.new(default_executor)
+            end
+
+            super(default_executor, *args, &task)
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -12,18 +12,21 @@ 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
 
             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|
@@ -33,7 +36,17 @@ module Datadog
                   Ext::DEFAULT_PEER_SERVICE_NAME
                 )
               end
-              o.lazy
+            end
+
+            option :peer_service do |o|
+              o.type :string, nilable: true
+              o.env Ext::ENV_PEER_SERVICE
+            end
+
+            option :command_enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_COMMAND_ENABLED
+              o.default false
             end
           end
         end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Tracing
     module Contrib
@@ -5,18 +7,31 @@ module Datadog
         # Dalli integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_DALLI_ENABLED'.freeze
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_DALLI_ANALYTICS_ENABLED'.freeze
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DALLI_ANALYTICS_SAMPLE_RATE'.freeze
-          ENV_SERVICE_NAME = 'DD_TRACE_DALLI_SERVICE_NAME'.freeze
+          # DEV: Even though this is the dalli integration, all spans are named `memcached.*`.
+          # DEV: This happens because such spans have special treatment in backend, with memcached-specific handling.
+          # DEV: If add support for the `memcached` gem (not popular as of 2023), we'll have issues with span naming
+          # DEV: conflicts.
+          ENV_ENABLED = 'DD_TRACE_DALLI_ENABLED'
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_DALLI_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DALLI_ANALYTICS_SAMPLE_RATE'
+          # DEV: This is named `*_MEMCACHED_*` because the spans it refer to are `memcached.*` and this variable
+          # DEV: is a global flag that affects all memcached spans generated by any Datadog product.
+          ENV_COMMAND_ENABLED = 'DD_TRACE_MEMCACHED_COMMAND_ENABLED'
+          ENV_SERVICE_NAME = 'DD_TRACE_DALLI_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_DALLI_PEER_SERVICE'
+
           QUANTIZE_MAX_CMD_LENGTH = 100
-          DEFAULT_PEER_SERVICE_NAME = 'memcached'.freeze
-          SPAN_COMMAND = 'memcached.command'.freeze
-          SPAN_TYPE_COMMAND = 'memcached'.freeze
-          TAG_COMMAND = 'memcached.command'.freeze
-          TAG_COMPONENT = 'dalli'.freeze
-          TAG_OPERATION_COMMAND = 'command'.freeze
-          TAG_SYSTEM = 'memcached'.freeze
+          DEFAULT_PEER_SERVICE_NAME = 'memcached'
+          SPAN_COMMAND = 'memcached.command'
+          SPAN_TYPE_COMMAND = 'memcached'
+          TAG_COMMAND = 'memcached.command'
+          TAG_COMPONENT = 'dalli'
+          TAG_OPERATION_COMMAND = 'command'
+          TAG_SYSTEM = 'memcached'
+          PEER_SERVICE_SOURCES = Array[
+            Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
+            Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,].freeze
         end
       end
     end

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

@@ -22,16 +22,22 @@ module Datadog
                 span.service = datadog_configuration[:service_name]
                 span.span_type = Ext::SPAN_TYPE_COMMAND
 
+                if datadog_configuration[:peer_service]
+                  span.set_tag(
+                    Tracing::Metadata::Ext::TAG_PEER_SERVICE,
+                    datadog_configuration[:peer_service]
+                  )
+                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(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
 
                 span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
                 span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_COMMAND)
-
-                # Tag as an external peer service
-                if Contrib::SpanAttributeSchema.default_span_attribute_schema?
-                  span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
-                end
-
                 span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, hostname)
 
                 # Set analytics sample rate
@@ -44,9 +50,12 @@ module Datadog
 
                 span.set_tag(Contrib::Ext::DB::TAG_SYSTEM, Ext::TAG_SYSTEM)
 
-                cmd = Quantize.format_command(op, args)
-                span.set_tag(Ext::TAG_COMMAND, cmd)
+                if datadog_configuration[:command_enabled]
+                  cmd = Quantize.format_command(op, args)
+                  span.set_tag(Ext::TAG_COMMAND, cmd)
+                end
 
+                Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
                 super
               end
             end

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

@@ -13,23 +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
 
             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 :client_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/delayed_job/ext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Tracing
     module Contrib
@@ -5,20 +7,20 @@ module Datadog
         # DelayedJob integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_DELAYED_JOB_ENABLED'.freeze
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_DELAYED_JOB_ANALYTICS_ENABLED'.freeze
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'.freeze
-          SPAN_JOB = 'delayed_job'.freeze
-          SPAN_ENQUEUE = 'delayed_job.enqueue'.freeze
-          SPAN_RESERVE_JOB = 'delayed_job.reserve_job'.freeze
-          TAG_ATTEMPTS = 'delayed_job.attempts'.freeze
-          TAG_ID = 'delayed_job.id'.freeze
-          TAG_PRIORITY = 'delayed_job.priority'.freeze
-          TAG_QUEUE = 'delayed_job.queue'.freeze
-          TAG_COMPONENT = 'delayed_job'.freeze
-          TAG_OPERATION_ENQUEUE = 'enqueue'.freeze
-          TAG_OPERATION_JOB = 'job'.freeze
-          TAG_OPERATION_RESERVE_JOB = 'reserve_job'.freeze
+          ENV_ENABLED = 'DD_TRACE_DELAYED_JOB_ENABLED'
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_DELAYED_JOB_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'
+          SPAN_JOB = 'delayed_job'
+          SPAN_ENQUEUE = 'delayed_job.enqueue'
+          SPAN_RESERVE_JOB = 'delayed_job.reserve_job'
+          TAG_ATTEMPTS = 'delayed_job.attempts'
+          TAG_ID = 'delayed_job.id'
+          TAG_PRIORITY = 'delayed_job.priority'
+          TAG_QUEUE = 'delayed_job.queue'
+          TAG_COMPONENT = 'delayed_job'
+          TAG_OPERATION_ENQUEUE = 'enqueue'
+          TAG_OPERATION_JOB = 'job'
+          TAG_OPERATION_RESERVE_JOB = 'reserve_job'
         end
       end
     end

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

@@ -12,18 +12,21 @@ 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
 
             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 :quantize, default: {}
@@ -35,7 +38,11 @@ module Datadog
                   Ext::DEFAULT_PEER_SERVICE_NAME
                 )
               end
-              o.lazy
+            end
+
+            option :peer_service do |o|
+              o.type :string, nilable: true
+              o.env Ext::ENV_PEER_SERVICE
             end
           end
         end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Tracing
     module Contrib
@@ -5,21 +7,25 @@ module Datadog
         # Elasticsearch integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_ELASTICSEARCH_ENABLED'.freeze
-          ENV_SERVICE_NAME = 'DD_TRACE_ELASTICSEARCH_SERVICE_NAME'.freeze
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ELASTICSEARCH_ANALYTICS_ENABLED'.freeze
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ELASTICSEARCH_ANALYTICS_SAMPLE_RATE'.freeze
-          DEFAULT_PEER_SERVICE_NAME = 'elasticsearch'.freeze
-          SPAN_QUERY = 'elasticsearch.query'.freeze
-          SPAN_TYPE_QUERY = 'elasticsearch'.freeze
-          TAG_BODY = 'elasticsearch.body'.freeze
-          TAG_METHOD = 'elasticsearch.method'.freeze
-          TAG_PARAMS = 'elasticsearch.params'.freeze
-          TAG_URL = 'elasticsearch.url'.freeze
-          TAG_COMPONENT = 'elasticsearch'.freeze
-          TAG_OPERATION_QUERY = 'query'.freeze
-
-          TAG_SYSTEM = 'elasticsearch'.freeze
+          ENV_ENABLED = 'DD_TRACE_ELASTICSEARCH_ENABLED'
+          ENV_SERVICE_NAME = 'DD_TRACE_ELASTICSEARCH_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_ELASTICSEARCH_PEER_SERVICE'
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ELASTICSEARCH_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ELASTICSEARCH_ANALYTICS_SAMPLE_RATE'
+          DEFAULT_PEER_SERVICE_NAME = 'elasticsearch'
+          SPAN_QUERY = 'elasticsearch.query'
+          SPAN_TYPE_QUERY = 'elasticsearch'
+          TAG_BODY = 'elasticsearch.body'
+          TAG_METHOD = 'elasticsearch.method'
+          TAG_PARAMS = 'elasticsearch.params'
+          TAG_URL = 'elasticsearch.url'
+          TAG_COMPONENT = 'elasticsearch'
+          TAG_OPERATION_QUERY = 'query'
+          TAG_SYSTEM = 'elasticsearch'
+          PEER_SERVICE_SOURCES = Array[
+            Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
+            Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,].freeze
         end
       end
     end