ddtrace 1.2.0 → 1.10.1

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

@@ -1,9 +1,10 @@
-# typed: false
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative '../ext'
+require_relative 'ext'
 
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/pg/ext'
+require_relative '../propagation/sql_comment'
+require_relative '../propagation/sql_comment/mode'
 
 module Datadog
   module Tracing
@@ -17,71 +18,102 @@ module Datadog
 
           # PG::Connection patch methods
           module InstanceMethods
-            def exec(sql, *args)
-              trace(Ext::SPAN_EXEC, resource: sql) do
-                super(sql, *args)
+            def exec(sql, *args, &block)
+              trace(Ext::SPAN_EXEC, sql: sql, block: block) do |sql_statement, wrapped_block|
+                super(sql_statement, *args, &wrapped_block)
               end
             end
 
-            def exec_params(sql, params, *args)
-              trace(Ext::SPAN_EXEC_PARAMS, resource: sql) do
-                super(sql, params, *args)
+            def exec_params(sql, params, *args, &block)
+              trace(Ext::SPAN_EXEC_PARAMS, sql: sql, block: block) do |sql_statement, wrapped_block|
+                super(sql_statement, params, *args, &wrapped_block)
               end
             end
 
-            def exec_prepared(statement_name, params, *args)
-              trace(Ext::SPAN_EXEC_PREPARED, resource: statement_name) do
-                super(statement_name, params, *args)
+            def exec_prepared(statement_name, params, *args, &block)
+              trace(Ext::SPAN_EXEC_PREPARED, statement_name: statement_name, block: block) do |_, wrapped_block|
+                super(statement_name, params, *args, &wrapped_block)
               end
             end
 
-            def async_exec(sql, *args)
-              trace(Ext::SPAN_ASYNC_EXEC, resource: sql) do
-                super(sql, *args)
+            # async_exec is an alias to exec
+            def async_exec(sql, *args, &block)
+              trace(Ext::SPAN_ASYNC_EXEC, sql: sql, block: block) do |sql_statement, wrapped_block|
+                super(sql_statement, *args, &wrapped_block)
               end
             end
 
-            def async_exec_params(sql, params, *args)
-              trace(Ext::SPAN_ASYNC_EXEC_PARAMS, resource: sql) do
-                super(sql, params, *args)
+            # async_exec_params is an alias to exec_params
+            def async_exec_params(sql, params, *args, &block)
+              trace(Ext::SPAN_ASYNC_EXEC_PARAMS, sql: sql, block: block) do |sql_statement, wrapped_block|
+                super(sql_statement, params, *args, &wrapped_block)
               end
             end
 
-            def async_exec_prepared(statement_name, params, *args)
-              trace(Ext::SPAN_ASYNC_EXEC_PREPARED, resource: statement_name) do
-                super(statement_name, params, *args)
+            # async_exec_prepared is an alias to exec_prepared
+            def async_exec_prepared(statement_name, params, *args, &block)
+              trace(Ext::SPAN_ASYNC_EXEC_PREPARED, statement_name: statement_name, block: block) do |_, wrapped_block|
+                super(statement_name, params, *args, &wrapped_block)
               end
             end
 
-            def sync_exec(sql, *args)
-              trace(Ext::SPAN_SYNC_EXEC, resource: sql) do
-                super(sql, *args)
+            def sync_exec(sql, *args, &block)
+              trace(Ext::SPAN_SYNC_EXEC, sql: sql, block: block) do |sql_statement, wrapped_block|
+                super(sql_statement, *args, &wrapped_block)
               end
             end
 
-            def sync_exec_params(sql, params, *args)
-              trace(Ext::SPAN_SYNC_EXEC_PARAMS, resource: sql) do
-                super(sql, params, *args)
+            def sync_exec_params(sql, params, *args, &block)
+              trace(Ext::SPAN_SYNC_EXEC_PARAMS, sql: sql, block: block) do |sql_statement, wrapped_block|
+                super(sql_statement, params, *args, &wrapped_block)
               end
             end
 
-            def sync_exec_prepared(statement_name, params, *args)
-              trace(Ext::SPAN_SYNC_EXEC_PREPARED, resource: statement_name) do
-                super(statement_name, params, *args)
+            def sync_exec_prepared(statement_name, params, *args, &block)
+              trace(Ext::SPAN_SYNC_EXEC_PREPARED, statement_name: statement_name, block: block) do |_, wrapped_block|
+                super(statement_name, params, *args, &wrapped_block)
               end
             end
 
             private
 
-            def trace(name, resource:)
+            def trace(name, sql: nil, statement_name: nil, block: nil)
               service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
-              Tracing.trace(name, service: service, resource: resource, type: Tracing::Metadata::Ext::SQL::TYPE) do |span|
+              resource = statement_name || sql
+
+              Tracing.trace(
+                name,
+                service: service,
+                resource: resource,
+                type: Tracing::Metadata::Ext::SQL::TYPE
+              ) do |span, trace_op|
                 annotate_span_with_query!(span, service)
                 # Set analytics sample rate
                 Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
-                result = yield
-                annotate_span_with_result!(span, result)
-                result
+
+                if sql
+                  propagation_mode = Contrib::Propagation::SqlComment::Mode.new(comment_propagation)
+                  Contrib::Propagation::SqlComment.annotate!(span, propagation_mode)
+                  propagated_sql_statement = Contrib::Propagation::SqlComment.prepend_comment(
+                    sql,
+                    span,
+                    trace_op,
+                    propagation_mode
+                  )
+                end
+
+                # Read metadata from PG::Result
+                if block
+                  yield(propagated_sql_statement, proc do |result|
+                    ret = block.call(result)
+                    annotate_span_with_result!(span, result)
+                    ret
+                  end)
+                else
+                  result = yield(propagated_sql_statement)
+                  annotate_span_with_result!(span, result)
+                  result
+                end
               end
             end
 
@@ -96,9 +128,9 @@ module Datadog
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, service)
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host)
 
-              span.set_tag(Tracing::Metadata::Ext::DB::TAG_INSTANCE, db)
-              span.set_tag(Tracing::Metadata::Ext::DB::TAG_USER, user)
-              span.set_tag(Tracing::Metadata::Ext::DB::TAG_SYSTEM, Ext::SPAN_SYSTEM)
+              span.set_tag(Contrib::Ext::DB::TAG_INSTANCE, db)
+              span.set_tag(Contrib::Ext::DB::TAG_USER, user)
+              span.set_tag(Contrib::Ext::DB::TAG_SYSTEM, Ext::TAG_SYSTEM)
 
               span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, host)
               span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, port)
@@ -106,8 +138,9 @@ module Datadog
               span.set_tag(Tracing::Metadata::Ext::NET::TAG_DESTINATION_PORT, port)
             end
 
+            # @param [PG::Result] result
             def annotate_span_with_result!(span, result)
-              span.set_tag(Tracing::Metadata::Ext::DB::TAG_ROW_COUNT, result.ntuples)
+              span.set_tag(Contrib::Ext::DB::TAG_ROW_COUNT, result.ntuples)
             end
 
             def datadog_configuration
@@ -121,6 +154,10 @@ module Datadog
             def analytics_sample_rate
               datadog_configuration[:analytics_sample_rate]
             end
+
+            def comment_propagation
+              datadog_configuration[:comment_propagation]
+            end
           end
         end
       end

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

@@ -1,8 +1,6 @@
-# typed: false
-
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/pg/configuration/settings'
-require 'datadog/tracing/contrib/pg/patcher'
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
 
 module Datadog
   module Tracing

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

@@ -1,7 +1,5 @@
-# typed: ignore
-
-require 'datadog/tracing/contrib/patcher'
-require 'datadog/tracing/contrib/pg/instrumentation'
+require_relative '../patcher'
+require_relative 'instrumentation'
 
 module Datadog
   module Tracing

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

@@ -1,7 +1,5 @@
-# typed: false
-
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/presto/ext'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing
@@ -26,7 +24,10 @@ module Datadog
               o.lazy
             end
 
-            option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
+            option :service_name do |o|
+              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.lazy
+            end
           end
         end
       end

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

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Tracing
     module Contrib
@@ -8,6 +6,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_PRESTO_ENABLED'.freeze
+          ENV_SERVICE_NAME = 'DD_TRACE_PRESTO_SERVICE_NAME'.freeze
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_PRESTO_ANALYTICS_ENABLED'.freeze
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_PRESTO_ANALYTICS_SAMPLE_RATE'.freeze
           DEFAULT_PEER_SERVICE_NAME = 'presto'.freeze
@@ -25,6 +24,7 @@ module Datadog
           TAG_COMPONENT = 'presto'.freeze
           TAG_OPERATION_QUERY = 'query'.freeze
           TAG_OPERATION_KILL = 'kill'.freeze
+          TAG_SYSTEM = 'presto'.freeze
         end
       end
     end

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

@@ -1,8 +1,5 @@
-# typed: true
-
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/presto/ext'
+require_relative '../../metadata/ext'
+require_relative 'ext'
 
 module Datadog
   module Tracing
@@ -82,6 +79,9 @@ module Datadog
               def decorate!(span, operation)
                 span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
                 span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, operation)
+                span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
+
+                span.set_tag(Contrib::Ext::DB::TAG_SYSTEM, Ext::TAG_SYSTEM)
 
                 if (host_port = @options[:server])
                   host, port = Core::Utils.extract_host_port(host_port)

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

@@ -1,8 +1,6 @@
-# typed: false
-
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/presto/configuration/settings'
-require 'datadog/tracing/contrib/presto/patcher'
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
 
 module Datadog
   module Tracing

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

@@ -1,9 +1,7 @@
-# typed: true
-
-require 'datadog/core/utils/only_once'
-require 'datadog/tracing/contrib/patcher'
-require 'datadog/tracing/contrib/presto/ext'
-require 'datadog/tracing/contrib/presto/instrumentation'
+require_relative '../../../core/utils/only_once'
+require_relative '../patcher'
+require_relative 'ext'
+require_relative 'instrumentation'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/propagation/sql_comment/comment.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Propagation
+        module SqlComment
+          # To be prepended to a sql statement.
+          class Comment
+            def initialize(hash)
+              @hash = hash
+            end
+
+            def to_s
+              @string ||= begin
+                ret = String.new
+
+                @hash.each do |key, value|
+                  next if value.nil?
+
+                  # Url encode
+                  value = ERB::Util.url_encode(value)
+
+                  # Escape SQL
+                  ret << "#{key}='#{value}',"
+                end
+
+                # Remove the last `,`
+                ret.chop!
+
+                "/*#{ret}*/"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/propagation/sql_comment/ext.rb

@@ -0,0 +1,31 @@
+module Datadog
+  module Tracing
+    module Contrib
+      module Propagation
+        module SqlComment
+          module Ext
+            ENV_DBM_PROPAGATION_MODE = 'DD_DBM_PROPAGATION_MODE'.freeze
+
+            # The default mode for sql comment propagation
+            DISABLED = 'disabled'.freeze
+
+            # The `service` mode propagates service configuration
+            SERVICE = 'service'.freeze
+
+            # The `full` mode propagates service configuration + trace context
+            FULL = 'full'.freeze
+
+            # The value should be `true` when `full` mode
+            TAG_DBM_TRACE_INJECTED = '_dd.dbm_trace_injected'.freeze
+
+            KEY_DATABASE_SERVICE = 'dddbs'.freeze
+            KEY_ENVIRONMENT = 'dde'.freeze
+            KEY_PARENT_SERVICE = 'ddps'.freeze
+            KEY_VERSION = 'ddpv'.freeze
+            KEY_TRACEPARENT = 'traceparent'.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/propagation/sql_comment/mode.rb

@@ -0,0 +1,26 @@
+require_relative 'ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Propagation
+        # Implements sql comment propagation related contracts.
+        module SqlComment
+          Mode = Struct.new(:mode) do
+            def enabled?
+              service? || full?
+            end
+
+            def service?
+              mode == Ext::SERVICE
+            end
+
+            def full?
+              mode == Ext::FULL
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/propagation/sql_comment.rb

@@ -0,0 +1,45 @@
+require_relative 'sql_comment/comment'
+require_relative 'sql_comment/ext'
+
+require_relative '../../distributed/trace_context'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Propagation
+        # Implements sql comment propagation related contracts.
+        module SqlComment
+          def self.annotate!(span_op, mode)
+            return unless mode.enabled?
+
+            span_op.set_tag(Ext::TAG_DBM_TRACE_INJECTED, true) if mode.full?
+          end
+
+          # Inject span_op and trace_op instead of TraceDigest to improve memory usage
+          # for `disabled` and `service` mode
+          def self.prepend_comment(sql, span_op, trace_op, mode)
+            return sql unless mode.enabled?
+
+            tags = {
+              Ext::KEY_DATABASE_SERVICE => span_op.service,
+              Ext::KEY_ENVIRONMENT => datadog_configuration.env,
+              Ext::KEY_PARENT_SERVICE => datadog_configuration.service,
+              Ext::KEY_VERSION => datadog_configuration.version
+            }
+
+            if mode.full?
+              tags[Ext::KEY_TRACEPARENT] =
+                Tracing::Distributed::TraceContext.new(fetcher: nil).send(:build_traceparent, trace_op.to_digest)
+            end
+
+            "#{Comment.new(tags)} #{sql}"
+          end
+
+          def self.datadog_configuration
+            Datadog.configuration
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,5 @@
-# typed: false
-
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/qless/ext'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing

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

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Tracing
     module Contrib

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

@@ -1,8 +1,6 @@
-# typed: false
-
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/qless/configuration/settings'
-require 'datadog/tracing/contrib/qless/patcher'
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
 
 module Datadog
   module Tracing

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

@@ -1,7 +1,4 @@
-# typed: true
-
-require 'datadog/tracing'
-require 'datadog/tracing/contrib/patcher'
+require_relative '../patcher'
 
 module Datadog
   module Tracing
@@ -9,7 +6,6 @@ module Datadog
       module Qless
         # Patcher enables patching of 'qless' module.
         module Patcher
-          include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
           include Contrib::Patcher
 
           module_function

data/lib/datadog/tracing/contrib/qless/qless_job.rb

@@ -1,10 +1,7 @@
-# typed: false
-
 require 'qless'
 
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/analytics'
+require_relative '../../metadata/ext'
+require_relative '../analytics'
 
 module Datadog
   module Tracing
@@ -36,6 +33,9 @@ module Datadog
 
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_JOB)
+              span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CONSUMER)
+
+              span.set_tag(Contrib::Ext::Messaging::TAG_SYSTEM, Ext::TAG_COMPONENT)
 
               # Set analytics sample rate
               if Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])

data/lib/datadog/tracing/contrib/qless/tracer_cleaner.rb

@@ -1,7 +1,3 @@
-# typed: true
-
-require 'datadog/tracing'
-
 module Datadog
   module Tracing
     module Contrib

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

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-# typed: false
-
-require 'datadog/tracing/span_operation'
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/que/ext'
+require_relative '../../../span_operation'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# typed: strict
-
 module Datadog
   module Tracing
     module Contrib

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

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-# typed: false
-
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/que/ext'
-require 'datadog/tracing/contrib/que/configuration/settings'
-require 'datadog/tracing/contrib/que/patcher'
+require_relative '../integration'
+require_relative 'ext'
+require_relative 'configuration/settings'
+require_relative 'patcher'
 
 module Datadog
   module Tracing

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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-# typed: false
-
-require 'datadog/tracing/contrib/que/tracer'
+require_relative 'tracer'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/que/tracer.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-# typed: true
-
-require 'datadog/tracing/contrib/analytics'
+require_relative '../analytics'
 
 module Datadog
   module Tracing
@@ -18,6 +16,8 @@ module Datadog
             }
 
             Tracing.trace(Ext::SPAN_JOB, **trace_options) do |request_span|
+              request_span.set_tag(Contrib::Ext::Messaging::TAG_SYSTEM, Ext::TAG_COMPONENT)
+
               request_span.resource = job.class.name.to_s
 
               request_span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
@@ -33,6 +33,8 @@ module Datadog
               request_span.set_tag(Ext::TAG_JOB_ARGS, job.que_attrs[:args]) if configuration[:tag_args]
               request_span.set_tag(Ext::TAG_JOB_DATA, job.que_attrs[:data]) if configuration[:tag_data]
 
+              request_span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CONSUMER)
+
               set_sample_rate(request_span)
               Contrib::Analytics.set_measured(request_span)
 

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

@@ -1,7 +1,5 @@
-# typed: false
-
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/racecar/ext'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/racecar/event.rb

@@ -1,10 +1,7 @@
-# typed: true
-
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/active_support/notifications/event'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/racecar/ext'
+require_relative '../../metadata/ext'
+require_relative '../active_support/notifications/event'
+require_relative '../analytics'
+require_relative 'ext'
 
 module Datadog
   module Tracing
@@ -38,6 +35,7 @@ module Datadog
               span.service = configuration[:service_name]
               span.resource = payload[:consumer_class]
 
+              span.set_tag(Contrib::Ext::Messaging::TAG_SYSTEM, Ext::TAG_MESSAGING_SYSTEM)
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
 
               # Tag as an external peer service