ddtrace 1.0.0 → 1.9.0

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

@@ -1,9 +1,11 @@
 # typed: false
 
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/mysql2/ext'
+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
@@ -20,10 +22,13 @@ module Datadog
             def query(sql, options = {})
               service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
 
-              Tracing.trace(Ext::SPAN_QUERY, service: service) do |span|
+              Tracing.trace(Ext::SPAN_QUERY, service: service) do |span, trace_op|
                 span.resource = sql
                 span.span_type = Tracing::Metadata::Ext::SQL::TYPE
 
+                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)
+
                 span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
                 span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_QUERY)
 
@@ -37,6 +42,12 @@ module Datadog
                 span.set_tag(Ext::TAG_DB_NAME, query_options[:database])
                 span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, query_options[:host])
                 span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, query_options[:port])
+
+                propagation_mode = Contrib::Propagation::SqlComment::Mode.new(comment_propagation)
+
+                Contrib::Propagation::SqlComment.annotate!(span, propagation_mode)
+                sql = Contrib::Propagation::SqlComment.prepend_comment(sql, span, trace_op, propagation_mode)
+
                 super(sql, options)
               end
             end
@@ -54,6 +65,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/mysql2/integration.rb

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

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

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

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

@@ -1,7 +1,7 @@
 # typed: false
 
-require 'datadog/core'
-require 'datadog/core/utils/only_once'
+require_relative '../../core'
+require_relative '../../core/utils/only_once'
 
 module Datadog
   module Tracing
@@ -19,6 +19,10 @@ module Datadog
         # Prepended instance methods for all patchers
         # @public_api
         module CommonMethods
+          attr_accessor \
+            :patch_error_result,
+            :patch_successful
+
           def patch_name
             self.class != Class && self.class != Module ? self.class.name : name
           end
@@ -35,6 +39,7 @@ module Datadog
                 super.tap do
                   # Emit a metric
                   Datadog.health_metrics.instrumentation_patched(1, tags: default_tags)
+                  @patch_successful = true
                 end
               rescue StandardError => e
                 on_patch_error(e)
@@ -48,6 +53,12 @@ module Datadog
             # Log the error
             Datadog.logger.error("Failed to apply #{patch_name} patch. Cause: #{e} Location: #{Array(e.backtrace).first}")
 
+            @patch_error_result = {
+              type: e.class.name,
+              message: e.message,
+              line: Array(e.backtrace).first
+            }
+
             # Emit a metric
             tags = default_tags
             tags << "error:#{e.class.name}"
@@ -55,14 +66,15 @@ module Datadog
             Datadog.health_metrics.error_instrumentation_patch(1, tags: tags)
           end
 
-          private
-
           def default_tags
             ["patcher:#{patch_name}"].tap do |tags|
               tags << "target_version:#{target_version}" if respond_to?(:target_version) && !target_version.nil?
+              super.each { |t| tags << t } if defined?(super)
             end
           end
 
+          private
+
           def patch_only_once
             # NOTE: This is not thread-safe
             @patch_only_once ||= Core::Utils::OnlyOnce.new

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

@@ -0,0 +1,50 @@
+# typed: false
+
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+require_relative '../../propagation/sql_comment/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Pg
+        module Configuration
+          # Custom settings for the Pg integration
+          # @public_api
+          class Settings < Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+              o.lazy
+            end
+
+            option :analytics_enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+              o.lazy
+            end
+
+            option :analytics_sample_rate do |o|
+              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+              o.lazy
+            end
+
+            option :service_name do |o|
+              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.lazy
+            end
+
+            option :comment_propagation do |o|
+              o.default do
+                ENV.fetch(
+                  Contrib::Propagation::SqlComment::Ext::ENV_DBM_PROPAGATION_MODE,
+                  Contrib::Propagation::SqlComment::Ext::DISABLED
+                )
+              end
+              o.lazy
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Pg
+        # pg integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_PG_ENABLED'.freeze
+          ENV_SERVICE_NAME = 'DD_TRACE_PG_SERVICE_NAME'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_PG_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_PG_ANALYTICS_SAMPLE_RATE'.freeze
+          DEFAULT_PEER_SERVICE_NAME = 'pg'.freeze
+          SPAN_EXEC = 'pg.exec'.freeze
+          SPAN_EXEC_PARAMS = 'pg.exec.params'.freeze
+          SPAN_EXEC_PREPARED = 'pg.exec.prepared'.freeze
+          SPAN_ASYNC_EXEC = 'pg.async.exec'.freeze
+          SPAN_ASYNC_EXEC_PARAMS = 'pg.async.exec.params'.freeze
+          SPAN_ASYNC_EXEC_PREPARED = 'pg.async.exec.prepared'.freeze
+          SPAN_SYNC_EXEC = 'pg.sync.exec'.freeze
+          SPAN_SYNC_EXEC_PARAMS = 'pg.sync.exec.params'.freeze
+          SPAN_SYNC_EXEC_PREPARED = 'pg.sync.exec.prepared'.freeze
+          TAG_DB_NAME = 'pg.db.name'.freeze
+          TAG_COMPONENT = 'pg'.freeze
+          TAG_OPERATION_QUERY = 'query'.freeze
+
+          TAG_SYSTEM = 'postgresql'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,168 @@
+# typed: false
+
+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
+    module Contrib
+      module Pg
+        # PG::Connection patch module
+        module Instrumentation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # PG::Connection patch methods
+          module InstanceMethods
+            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, &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, &block)
+              trace(Ext::SPAN_EXEC_PREPARED, statement_name: statement_name, block: block) do |_, wrapped_block|
+                super(statement_name, params, *args, &wrapped_block)
+              end
+            end
+
+            # 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
+
+            # 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
+
+            # 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, &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, &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, &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, sql: nil, statement_name: nil, block: 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, trace_op|
+                annotate_span_with_query!(span, service)
+                # Set analytics sample rate
+                Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+                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
+
+            def annotate_span_with_query!(span, service)
+              span.set_tag(Ext::TAG_DB_NAME, db)
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_QUERY)
+              span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
+
+              # Tag as an external peer service
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, service)
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host)
+
+              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)
+              span.set_tag(Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME, host)
+              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(Contrib::Ext::DB::TAG_ROW_COUNT, result.ntuples)
+            end
+
+            def datadog_configuration
+              Datadog.configuration.tracing[:pg]
+            end
+
+            def analytics_enabled?
+              datadog_configuration[:analytics_enabled]
+            end
+
+            def analytics_sample_rate
+              datadog_configuration[:analytics_sample_rate]
+            end
+
+            def comment_propagation
+              datadog_configuration[:comment_propagation]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: false
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Pg
+        # Description of pg integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('0.18.4')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :pg
+
+          def self.version
+            Gem.loaded_specs['pg'] && Gem.loaded_specs['pg'].version
+          end
+
+          def self.loaded?
+            !defined?(::PG).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# typed: ignore
+
+require_relative '../patcher'
+require_relative 'instrumentation'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Pg
+        # Patcher enables patching of 'pg' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            patch_pg_connection
+          end
+
+          def patch_pg_connection
+            ::PG::Connection.include(Instrumentation)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 # 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 +26,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

@@ -8,6 +8,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

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

@@ -1,8 +1,7 @@
 # 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

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

@@ -1,8 +1,8 @@
 # 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,9 @@
 # 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,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,33 @@
+# 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
+            KEY_TRACEPARENT = 'traceparent'.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