ddtrace 1.4.2 → 1.19.0

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

@@ -1,8 +1,11 @@
-# typed: false
+# frozen_string_literal: true
 
 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
@@ -18,16 +21,30 @@ module Datadog
           module InstanceMethods
             def query(sql, options = {})
               service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
+              on_error = Datadog.configuration_for(self, :on_error) || datadog_configuration[:on_error]
 
-              Tracing.trace(Ext::SPAN_QUERY, service: service) do |span|
+              Tracing.trace(Ext::SPAN_QUERY, service: service, on_error: on_error) do |span, trace_op|
                 span.resource = sql
                 span.span_type = Tracing::Metadata::Ext::SQL::TYPE
 
+                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(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)
 
-                # 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, query_options[:host])
 
                 # Set analytics sample rate
@@ -36,6 +53,19 @@ 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])
+
+                Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
+
+                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
@@ -53,6 +83,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,5 +1,3 @@
-# typed: false
-
 require_relative '../integration'
 require_relative 'configuration/settings'
 require_relative 'patcher'

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

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 require_relative '../patcher'
 require_relative 'instrumentation'

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module OpenSearch
+        module Configuration
+          # Custom settings for the OpenSearch integration
+          # @public_api
+          class Settings < Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+
+            option :analytics_enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ANALYTICS_ENABLED
+              o.default false
+            end
+
+            option :analytics_sample_rate do |o|
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
+            end
+
+            option :quantize, default: {}
+
+            option :service_name do |o|
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
+            end
+
+            option :peer_service do |o|
+              o.type :string, nilable: true
+              o.env Ext::ENV_PEER_SERVICE
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module OpenSearch
+        # OpenSearch integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_OPENSEARCH_ENABLED'
+          ENV_SERVICE_NAME = 'DD_TRACE_OPENSEARCH_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_OPENSEARCH_PEER_SERVICE'
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_OPENSEARCH_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_OPENSEARCH_ANALYTICS_SAMPLE_RATE'
+          DEFAULT_PEER_SERVICE_NAME = 'opensearch'
+          SPAN_QUERY = 'opensearch.query'
+          SPAN_TYPE_QUERY = 'opensearch'
+          TAG_COMPONENT = 'opensearch'
+          TAG_SYSTEM = 'opensearch'
+          TAG_METHOD = 'http.method'
+          TAG_PATH = 'http.url_details.path'
+          TAG_PARAMS = 'opensearch.params'
+          TAG_BODY = 'opensearch.body'
+          TAG_URL = 'http.url'
+          TAG_HOST = 'http.url_details.host'
+          TAG_PORT = 'http.url_details.port'
+          TAG_SCHEME = 'http.url_details.scheme'
+          TAG_RESPONSE_CONTENT_LENGTH = 'http.response.content_length'
+          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
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module OpenSearch
+        # Description of OpenSearch integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('1.0.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :opensearch, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs['opensearch-ruby'] \
+              && Gem.loaded_specs['opensearch-ruby'].version
+          end
+
+          def self.loaded?
+            !defined?(::OpenSearch::Transport).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/opensearch/patcher.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative '../ext'
+require_relative '../integration'
+require_relative '../patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module OpenSearch
+        # Patcher enables patching of 'opensearch' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def patch
+            require 'uri'
+            require 'json'
+            require_relative 'quantize'
+
+            ::OpenSearch::Transport::Client.prepend(Client)
+          end
+
+          # Patches OpenSearch::Transport::Client module
+          module Client
+            # rubocop:disable Metrics/MethodLength
+            # rubocop:disable Metrics/AbcSize
+            def perform_request(method, path, params = {}, body = nil, headers = nil)
+              response = nil
+              # rubocop:disable Metrics/BlockLength
+              Tracing.trace('opensearch.query', service: datadog_configuration[:service_name]) do |span|
+                begin
+                  # Set generic tags
+                  span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                  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)
+
+                  # Set argument tags
+                  span.set_tag(OpenSearch::Ext::TAG_METHOD, method)
+                  span.set_tag(OpenSearch::Ext::TAG_PATH, path)
+
+                  tag_params(params, span)
+                  tag_body(body, span)
+
+                  # Parse url
+                  original_url = transport.get_connection.full_url(path, {})
+                  url = URI.parse(original_url)
+                  host = url.host
+                  port = url.port
+                  scheme = url.scheme
+                  # Set url.user to nil to remove sensitive information (i.e. user's username and password)
+                  url.user = nil
+
+                  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
+
+                  # Set url tags
+                  span.set_tag(OpenSearch::Ext::TAG_URL, url)
+                  span.set_tag(OpenSearch::Ext::TAG_HOST, host)
+                  span.set_tag(OpenSearch::Ext::TAG_PORT, port)
+                  span.set_tag(OpenSearch::Ext::TAG_SCHEME, scheme)
+
+                  span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host) if host
+
+                  # Define span resource
+                  quantized_url = OpenSearch::Quantize.format_url(url)
+                  span.resource = "#{method} #{quantized_url}"
+                  Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
+                rescue StandardError => e
+                  Datadog.logger.error(e.message)
+                ensure
+                  begin
+                    response = super
+                  rescue => e
+                    status_code = ::OpenSearch::Transport::Transport::ERRORS.key(e.class)
+                    span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, status_code) if status_code
+                    raise
+                  end
+                  # Set post-response tags
+                  span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, response.status)
+                  if response.headers['content-length']
+                    span.set_tag(
+                      OpenSearch::Ext::TAG_RESPONSE_CONTENT_LENGTH,
+                      response.headers['content-length'].to_i
+                    )
+                  end
+                end
+              end
+              # rubocop:enable Metrics/BlockLength
+              # rubocop:enable Metrics/AbcSize
+              response
+            end
+
+            def tag_params(params, span)
+              return unless params
+
+              params = JSON.generate(params) unless params.is_a?(String)
+              span.set_tag(OpenSearch::Ext::TAG_PARAMS, params)
+            end
+
+            def tag_body(body, span)
+              return unless body
+
+              body = JSON.generate(body) unless body.is_a?(String)
+              quantize_options = datadog_configuration[:quantize]
+              quantized_body = OpenSearch::Quantize.format_body(
+                body,
+                quantize_options
+              )
+              span.set_tag(OpenSearch::Ext::TAG_BODY, quantized_body)
+            end
+
+            def datadog_configuration
+              Datadog.configuration.tracing[:opensearch]
+            end
+          end
+          # rubocop:enable Metrics/MethodLength
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/opensearch/quantize.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative '../utils/quantization/hash'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module OpenSearch
+        # Removes sensitive data from OpenSearch strings (i.e. url and body).
+        module Quantize
+          PLACEHOLDER = '/?'
+          DEFAULT_PLACEHOLDER = '?'
+          EXCLUDE_KEYS = [].freeze
+          SHOW_KEYS = [:_index, :_type, :_id].freeze
+          DEFAULT_OPTIONS = {
+            exclude: EXCLUDE_KEYS,
+            show: SHOW_KEYS,
+            placeholder: PLACEHOLDER
+          }.freeze
+
+          module_function
+
+          def format_url(url)
+            # Url does not contain path, so just replace last digit(s) with '?' if '/' precedes the digit(s)
+            url.to_s.gsub(%r{/\d+$}, PLACEHOLDER)
+          end
+
+          # Use Elasticsearch implementation
+          def format_body(body, options = {})
+            format_body!(body, options)
+          rescue StandardError
+            options[:placeholder] || DEFAULT_PLACEHOLDER
+          end
+
+          def format_body!(body, options = {})
+            options = merge_options(DEFAULT_OPTIONS, options)
+
+            # Determine if bulk query or not, based on content
+            statements = body.end_with?("\n") ? body.split("\n") : [body]
+
+            # Parse each statement and quantize them.
+            statements.collect do |string|
+              reserialize_json(string, options[:placeholder]) do |obj|
+                Contrib::Utils::Quantization::Hash.format(obj, options)
+              end
+            end.join("\n")
+          end
+
+          def merge_options(original, additional)
+            {}.tap do |options|
+              # Show
+              # If either is :all, value becomes :all
+              options[:show] = if original[:show] == :all || additional[:show] == :all
+                                 :all
+                               else
+                                 (original[:show] || []).dup.concat(additional[:show] || []).uniq
+                               end
+
+              # Exclude
+              options[:exclude] = (original[:exclude] || []).dup.concat(additional[:exclude] || []).uniq
+            end
+          end
+
+          # Parses a JSON object from a string, passes its value
+          # to the block provided, and dumps its result back to JSON.
+          # If JSON parsing fails, it prints fail_value.
+          def reserialize_json(string, fail_value = DEFAULT_PLACEHOLDER)
+            return string unless block_given?
+
+            begin
+              JSON.dump(yield(JSON.parse(string)))
+            rescue JSON::ParserError
+              # If it can't parse/dump, don't raise an error.
+              fail_value
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 module Datadog
   module Tracing

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

@@ -1,6 +1,3 @@
-# typed: false
-
-require_relative '../../core'
 require_relative '../../core/utils/only_once'
 
 module Datadog
@@ -66,14 +63,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

@@ -1,8 +1,10 @@
-# typed: false
+# frozen_string_literal: true
 
 require_relative '../../configuration/settings'
 require_relative '../ext'
 
+require_relative '../../propagation/sql_comment/ext'
+
 module Datadog
   module Tracing
     module Contrib
@@ -12,21 +14,47 @@ 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 :error_handler do |o|
+              o.type :proc
+              o.default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
             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|
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
+            end
+
+            option :comment_propagation do |o|
+              o.type :string
+              o.env Contrib::Propagation::SqlComment::Ext::ENV_DBM_PROPAGATION_MODE
+              o.default Contrib::Propagation::SqlComment::Ext::DISABLED
             end
 
-            option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
+            option :peer_service do |o|
+              o.type :string, nilable: true
+              o.env Ext::ENV_PEER_SERVICE
+            end
           end
         end
       end

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

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 module Datadog
   module Tracing
@@ -7,23 +7,26 @@ module Datadog
         # 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_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_SYSTEM = 'postgresql'.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
+          ENV_ENABLED = 'DD_TRACE_PG_ENABLED'
+          ENV_SERVICE_NAME = 'DD_TRACE_PG_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_PG_PEER_SERVICE'
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_PG_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_PG_ANALYTICS_SAMPLE_RATE'
+          DEFAULT_PEER_SERVICE_NAME = 'pg'
+          SPAN_EXEC = 'pg.exec'
+          SPAN_EXEC_PARAMS = 'pg.exec.params'
+          SPAN_EXEC_PREPARED = 'pg.exec.prepared'
+          SPAN_ASYNC_EXEC = 'pg.async.exec'
+          SPAN_ASYNC_EXEC_PARAMS = 'pg.async.exec.params'
+          SPAN_ASYNC_EXEC_PREPARED = 'pg.async.exec.prepared'
+          SPAN_SYNC_EXEC = 'pg.sync.exec'
+          SPAN_SYNC_EXEC_PARAMS = 'pg.sync.exec.params'
+          SPAN_SYNC_EXEC_PREPARED = 'pg.sync.exec.prepared'
+          TAG_DB_NAME = 'pg.db.name'
+          TAG_COMPONENT = 'pg'
+          TAG_OPERATION_QUERY = 'query'
+          TAG_SYSTEM = 'postgresql'
+          PEER_SERVICE_SOURCES = Contrib::Ext::DB::PEER_SERVICE_SOURCES.freeze
         end
       end
     end