ddtrace 1.5.2 → 1.6.1

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

@@ -5,6 +5,9 @@ require_relative '../analytics'
 require_relative '../ext'
 require_relative 'ext'
 
+require_relative '../propagation/sql_comment'
+require_relative '../propagation/sql_comment/mode'
+
 module Datadog
   module Tracing
     module Contrib
@@ -18,68 +21,77 @@ module Datadog
           # PG::Connection patch methods
           module InstanceMethods
             def exec(sql, *args)
-              trace(Ext::SPAN_EXEC, resource: sql) do
-                super(sql, *args)
+              trace(Ext::SPAN_EXEC, sql: sql) do |sql_statement|
+                super(sql_statement, *args)
               end
             end
 
             def exec_params(sql, params, *args)
-              trace(Ext::SPAN_EXEC_PARAMS, resource: sql) do
-                super(sql, params, *args)
+              trace(Ext::SPAN_EXEC_PARAMS, sql: sql) do |sql_statement|
+                super(sql_statement, params, *args)
               end
             end
 
             def exec_prepared(statement_name, params, *args)
-              trace(Ext::SPAN_EXEC_PREPARED, resource: statement_name) do
+              trace(Ext::SPAN_EXEC_PREPARED, statement_name: statement_name) do
                 super(statement_name, params, *args)
               end
             end
 
             def async_exec(sql, *args)
-              trace(Ext::SPAN_ASYNC_EXEC, resource: sql) do
-                super(sql, *args)
+              trace(Ext::SPAN_ASYNC_EXEC, sql: sql) do |sql_statement|
+                super(sql_statement, *args)
               end
             end
 
             def async_exec_params(sql, params, *args)
-              trace(Ext::SPAN_ASYNC_EXEC_PARAMS, resource: sql) do
-                super(sql, params, *args)
+              trace(Ext::SPAN_ASYNC_EXEC_PARAMS, sql: sql) do |sql_statement|
+                super(sql_statement, params, *args)
               end
             end
 
             def async_exec_prepared(statement_name, params, *args)
-              trace(Ext::SPAN_ASYNC_EXEC_PREPARED, resource: statement_name) do
+              trace(Ext::SPAN_ASYNC_EXEC_PREPARED, statement_name: statement_name) do
                 super(statement_name, params, *args)
               end
             end
 
             def sync_exec(sql, *args)
-              trace(Ext::SPAN_SYNC_EXEC, resource: sql) do
-                super(sql, *args)
+              trace(Ext::SPAN_SYNC_EXEC, sql: sql) do |sql_statement|
+                super(sql_statement, *args)
               end
             end
 
             def sync_exec_params(sql, params, *args)
-              trace(Ext::SPAN_SYNC_EXEC_PARAMS, resource: sql) do
-                super(sql, params, *args)
+              trace(Ext::SPAN_SYNC_EXEC_PARAMS, sql: sql) do |sql_statement|
+                super(sql_statement, params, *args)
               end
             end
 
             def sync_exec_prepared(statement_name, params, *args)
-              trace(Ext::SPAN_SYNC_EXEC_PREPARED, resource: statement_name) do
+              trace(Ext::SPAN_SYNC_EXEC_PREPARED, statement_name: statement_name) do
                 super(statement_name, params, *args)
               end
             end
 
             private
 
-            def trace(name, resource:)
+            def trace(name, sql: nil, statement_name: nil)
               service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
+              resource = statement_name || sql
+
               Tracing.trace(name, service: service, resource: resource, type: Tracing::Metadata::Ext::SQL::TYPE) do |span|
                 annotate_span_with_query!(span, service)
                 # Set analytics sample rate
                 Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
-                result = yield
+
+                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, propagation_mode)
+                end
+
+                result = yield(propagated_sql_statement)
                 annotate_span_with_result!(span, result)
                 result
               end
@@ -98,7 +110,7 @@ module Datadog
 
               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::SPAN_SYSTEM)
+              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)
@@ -121,6 +133,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/propagation/sql_comment/comment.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# typed: false
+
+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,32 @@
+# typed: false
+
+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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# typed: false
+
+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,49 @@
+# typed: false
+
+require_relative 'sql_comment/comment'
+require_relative 'sql_comment/ext'
+
+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?
+
+            # PENDING: Until `traceparent`` implementation in `full` mode
+            # span_op.set_tag(Ext::TAG_DBM_TRACE_INJECTED, true) if mode.full?
+          end
+
+          def self.prepend_comment(sql, span_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
+            }
+
+            # PENDING: Until `traceparent`` implementation in `full` mode
+            # tags.merge!(trace_context(span_op)) if mode.full?
+
+            "#{Comment.new(tags)} #{sql}"
+          end
+
+          def self.datadog_configuration
+            Datadog.configuration
+          end
+
+          # TODO: Derive from trace
+          def self.trace_context(_)
+            {
+              # traceparent: '00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01'
+            }.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/rack/middlewares.rb

@@ -56,16 +56,18 @@ module Datadog
             # Find out if this is rack within rack
             previous_request_span = env[Ext::RACK_ENV_REQUEST_SPAN]
 
+            return @app.call(env) if previous_request_span
+
             # Extract distributed tracing context before creating any spans,
             # so that all spans will be added to the distributed trace.
-            if configuration[:distributed_tracing] && previous_request_span.nil?
+            if configuration[:distributed_tracing]
               trace_digest = Tracing::Propagation::HTTP.extract(env)
               Tracing.continue_trace!(trace_digest)
             end
 
             # Create a root Span to keep track of frontend web servers
             # (i.e. Apache, nginx) if the header is properly set
-            frontend_span = compute_queue_time(env) if previous_request_span.nil?
+            frontend_span = compute_queue_time(env)
 
             trace_options = { span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND }
             trace_options[:service] = configuration[:service_name] if configuration[:service_name]
@@ -127,6 +129,10 @@ module Datadog
             request_headers_tags = parse_request_headers(request_header_collection)
             response_headers_tags = parse_response_headers(headers || {})
 
+            # Since it could be mutated, it would be more accurate to fetch from the original env,
+            # e.g. ActionDispatch::ShowExceptions middleware with Rails exceptions_app configuration
+            original_request_method = original_env['REQUEST_METHOD']
+
             # request_headers is subject to filtering and configuration so we
             # get the user agent separately
             user_agent = parse_user_agent_header(request_header_collection)
@@ -138,11 +144,11 @@ module Datadog
             # 4. Fallback with verb + status, eq `GET 200`
             request_span.resource ||=
               if configuration[:middleware_names] && env['RESPONSE_MIDDLEWARE']
-                "#{env['RESPONSE_MIDDLEWARE']}##{env['REQUEST_METHOD']}"
+                "#{env['RESPONSE_MIDDLEWARE']}##{original_request_method}"
               elsif trace.resource_override?
                 trace.resource
               else
-                "#{env['REQUEST_METHOD']} #{status}".strip
+                "#{original_request_method} #{status}".strip
               end
 
             # Overrides the trace resource if it never been set
@@ -161,7 +167,7 @@ module Datadog
             Contrib::Analytics.set_measured(request_span)
 
             if request_span.get_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD).nil?
-              request_span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, env['REQUEST_METHOD'])
+              request_span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, original_request_method)
             end
 
             url = parse_url(env, original_env)

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

@@ -19,6 +19,8 @@ module Datadog
           TYPE = 'redis'.freeze
           TAG_COMPONENT = 'redis'.freeze
           TAG_OPERATION_COMMAND = 'command'.freeze
+          TAG_SYSTEM = 'redis'.freeze
+          TAG_DATABASE_INDEX = 'db.redis.database_index'.freeze
         end
       end
     end

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

@@ -21,7 +21,8 @@ module Datadog
             def call(*args, &block)
               response = nil
               Tracing.trace(Contrib::Redis::Ext::SPAN_COMMAND) do |span|
-                span.service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
+                span.service = Datadog.configuration_for(redis_instance, :service_name) ||
+                  datadog_configuration[:service_name]
                 span.span_type = Contrib::Redis::Ext::TYPE
                 span.resource = get_command(args)
                 Contrib::Redis::Tags.set_common_tags(self, span)
@@ -35,7 +36,8 @@ module Datadog
             def call_pipeline(*args, &block)
               response = nil
               Tracing.trace(Contrib::Redis::Ext::SPAN_COMMAND) do |span|
-                span.service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
+                span.service = Datadog.configuration_for(redis_instance, :service_name) ||
+                  datadog_configuration[:service_name]
                 span.span_type = Contrib::Redis::Ext::TYPE
                 commands = get_pipeline_commands(args)
                 span.resource = commands.any? ? commands.join("\n") : '(none)'

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

@@ -13,6 +13,7 @@ module Datadog
           include Contrib::Integration
 
           MINIMUM_VERSION = Gem::Version.new('3.2')
+          MAX_VERSION = Gem::Version.new('5')
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :redis, auto_patch: true
@@ -26,7 +27,7 @@ module Datadog
           end
 
           def self.compatible?
-            super && version >= MINIMUM_VERSION
+            super && version >= MINIMUM_VERSION && version < MAX_VERSION
           end
 
           def new_configuration

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

@@ -12,6 +12,41 @@ module Datadog
         module Patcher
           include Contrib::Patcher
 
+          # Patch for redis instance
+          module InstancePatch
+            def self.included(base)
+              base.prepend(InstanceMethods)
+            end
+
+            # Instance method patch for redis instance
+            module InstanceMethods
+              # `options` could be frozen
+              def initialize(options = {})
+                super(options.merge(redis_instance: self))
+              end
+            end
+          end
+
+          # Patch for redis client
+          module ClientPatch
+            def self.included(base)
+              base.prepend(InstanceMethods)
+            end
+
+            # Instance method patch for redis client
+            module InstanceMethods
+              def initialize(options = {})
+                @redis_instance = options.delete(:redis_instance)
+
+                super(options)
+              end
+
+              private
+
+              attr_reader :redis_instance
+            end
+          end
+
           module_function
 
           def target_version
@@ -26,6 +61,11 @@ module Datadog
             require_relative 'quantize'
             require_relative 'instrumentation'
 
+            # InstancePatch and ClientPatch allows the client object to access pin on redis instance
+            ::Redis.include(InstancePatch)
+            ::Redis::Client.include(ClientPatch)
+
+            # TODO: To support redis-rb 5.x, Redis::Client -> RedisClient
             ::Redis::Client.include(Instrumentation)
           end
         end

data/lib/datadog/tracing/contrib/redis/tags.rb

@@ -3,6 +3,7 @@
 require_relative '../../metadata/ext'
 require_relative '../analytics'
 require_relative 'ext'
+require_relative '../ext'
 
 module Datadog
   module Tracing
@@ -22,8 +23,12 @@ module Datadog
               # Set analytics sample rate
               Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
+              span.set_tag Contrib::Ext::DB::TAG_SYSTEM, Ext::TAG_SYSTEM
+
               span.set_tag Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, client.host
               span.set_tag Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, client.port
+
+              span.set_tag Ext::TAG_DATABASE_INDEX, client.db.to_s
               span.set_tag Ext::TAG_DB, client.db
               span.set_tag Ext::TAG_RAW_COMMAND, span.resource if show_command_args?
             end

data/lib/datadog/tracing/contrib/rest_client/request_patch.rb

@@ -34,6 +34,8 @@ module Datadog
             def datadog_tag_request(uri, span)
               span.resource = method.to_s.upcase
 
+              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_REQUEST)
 

data/lib/datadog/tracing/contrib/sinatra/env.rb

@@ -13,14 +13,12 @@ module Datadog
         module Env
           module_function
 
-          def datadog_span(env, app)
-            request_span = env[Ext::RACK_ENV_REQUEST_SPAN]
-            request_span && request_span[app]
+          def datadog_span(env)
+            env[Ext::RACK_ENV_SINATRA_REQUEST_SPAN]
           end
 
-          def set_datadog_span(env, app, span)
-            hash = (env[Ext::RACK_ENV_REQUEST_SPAN] ||= {})
-            hash[app] = span
+          def set_datadog_span(env, span)
+            env[Ext::RACK_ENV_SINATRA_REQUEST_SPAN] = span
           end
 
           def request_header_tags(env, headers)
@@ -40,24 +38,15 @@ module Datadog
             "HTTP_#{name.to_s.upcase.gsub(/[-\s]/, '_')}"
           end
 
-          # Was a Sinatra already traced in this request?
-          # We don't want to create spans for intermediate Sinatra
-          # middlewares that don't match the request at hand.
-          def middleware_traced?(env)
-            env[Ext::RACK_ENV_MIDDLEWARE_TRACED]
-          end
-
-          def set_middleware_traced(env, bool)
-            env[Ext::RACK_ENV_MIDDLEWARE_TRACED] = bool
-          end
+          def route_path(env, use_script_names: Datadog.configuration.tracing[:sinatra][:resource_script_names])
+            return unless env['sinatra.route']
 
-          # The start time of the top-most Sinatra middleware.
-          def middleware_start_time(env)
-            env[Ext::RACK_ENV_MIDDLEWARE_START_TIME]
-          end
-
-          def set_middleware_start_time(env, time = Time.now.utc)
-            env[Ext::RACK_ENV_MIDDLEWARE_START_TIME] = time
+            _, path = env['sinatra.route'].split(' ', 2)
+            if use_script_names
+              env['SCRIPT_NAME'].to_s + path
+            else
+              path
+            end
           end
         end
       end

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

@@ -10,9 +10,7 @@ module Datadog
           ENV_ENABLED = 'DD_TRACE_SINATRA_ENABLED'.freeze
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_SINATRA_ANALYTICS_ENABLED'.freeze
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SINATRA_ANALYTICS_SAMPLE_RATE'.freeze
-          RACK_ENV_REQUEST_SPAN = 'datadog.sinatra_request_span'.freeze
-          RACK_ENV_MIDDLEWARE_START_TIME = 'datadog.sinatra_middleware_start_time'.freeze
-          RACK_ENV_MIDDLEWARE_TRACED = 'datadog.sinatra_middleware_traced'.freeze
+          RACK_ENV_SINATRA_REQUEST_SPAN = 'datadog.sinatra_request_span'.freeze
           SPAN_RENDER_TEMPLATE = 'sinatra.render_template'.freeze
           SPAN_REQUEST = 'sinatra.request'.freeze
           SPAN_ROUTE = 'sinatra.route'.freeze
@@ -25,6 +23,12 @@ module Datadog
           TAG_SCRIPT_NAME = 'sinatra.script_name'.freeze
           TAG_TEMPLATE_ENGINE = 'sinatra.template_engine'.freeze
           TAG_TEMPLATE_NAME = 'sinatra.template_name'.freeze
+
+          # === Deprecated: To be removed ===
+          RACK_ENV_REQUEST_SPAN = 'datadog.sinatra_request_span'.freeze
+          RACK_ENV_MIDDLEWARE_START_TIME = 'datadog.sinatra_middleware_start_time'.freeze
+          RACK_ENV_MIDDLEWARE_TRACED = 'datadog.sinatra_middleware_traced'.freeze
+          # === Deprecated: To be removed ===
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: false
 
 require_relative '../../../core/utils/only_once'
 require_relative '../patcher'
@@ -58,7 +58,7 @@ module Datadog
           end
 
           def register_tracer
-            ::Sinatra.send(:register, Contrib::Sinatra::Tracer)
+            ::Sinatra::Base.register(Contrib::Sinatra::Tracer)
             ::Sinatra::Base.prepend(Sinatra::Tracer::Base)
           end