ddtrace 0.34.1 → 1.23.1

data/lib/datadog/tracing/contrib/mongodb/subscribers.rb

@@ -0,0 +1,139 @@
+require_relative '../analytics'
+require_relative 'ext'
+require_relative '../ext'
+require_relative 'parsers'
+require_relative '../../metadata/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module MongoDB
+        # `MongoCommandSubscriber` listens to all events from the `Monitoring`
+        # system available in the Mongo driver.
+        class MongoCommandSubscriber
+          # rubocop:disable Metrics/AbcSize
+          def started(event)
+            return unless Tracing.enabled?
+
+            service = Datadog.configuration_for(event.address, :service_name) \
+                      || Datadog.configuration.tracing[:mongo, event.address.seed][:service_name]
+
+            # start a trace and store it in the current thread; using the `operation_id`
+            # is safe since it's a unique id used to link events together. Also only one
+            # thread is involved in this execution so thread-local storage should be safe. Reference:
+            # https://github.com/mongodb/mongo-ruby-driver/blob/master/lib/mongo/monitoring.rb#L70
+            # https://github.com/mongodb/mongo-ruby-driver/blob/master/lib/mongo/monitoring/publishable.rb#L38-L56
+            span = Tracing.trace(Ext::SPAN_COMMAND, service: service, span_type: Ext::SPAN_TYPE_COMMAND)
+            set_span(event, span)
+
+            # build a quantized Query using the Parser module
+            query = MongoDB.query_builder(event.command_name, event.database_name, event.command)
+            serialized_query = query.to_s
+
+            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_COMMAND)
+
+            span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, event.address.host)
+
+            # Set analytics sample rate
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+            # add operation tags; the full query is stored and used as a resource,
+            # since it has been quantized and reduced
+            span.set_tag(Ext::TAG_DB, query['database'])
+            span.set_tag(Ext::TAG_COLLECTION, query['collection'])
+            span.set_tag(Ext::DB::TAG_COLLECTION, query['collection'])
+            span.set_tag(Ext::TAG_OPERATION, query['operation'])
+            span.set_tag(Ext::TAG_QUERY, serialized_query)
+            span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, event.address.host)
+            span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, event.address.port)
+
+            Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
+
+            # set the resource with the quantized query
+            span.resource = serialized_query
+          end
+          # rubocop:enable Metrics/AbcSize
+
+          def failed(event)
+            span = get_span(event)
+            return unless span
+
+            # the failure is not a real exception because it's handled by
+            # the framework itself, so we set only the error and the message
+            span.set_error(event)
+          rescue StandardError => e
+            Datadog.logger.debug("error when handling MongoDB 'failed' event: #{e}")
+          ensure
+            # whatever happens, the Span must be removed from the local storage and
+            # it must be finished to prevent any leak
+            span.finish unless span.nil?
+            clear_span(event)
+          end
+
+          def succeeded(event)
+            span = get_span(event)
+            return unless span
+
+            # add fields that are available only after executing the query
+            rows = event.reply.fetch('n', nil)
+            span.set_tag(Ext::TAG_ROWS, rows) unless rows.nil?
+          rescue StandardError => e
+            Datadog.logger.debug("error when handling MongoDB 'succeeded' event: #{e}")
+          ensure
+            # whatever happens, the Span must be removed from the local storage and
+            # it must be finished to prevent any leak
+            span.finish unless span.nil?
+            clear_span(event)
+          end
+
+          private
+
+          def get_span(event)
+            Thread.current[:datadog_mongo_span] \
+              && Thread.current[:datadog_mongo_span][event.request_id]
+          end
+
+          def set_span(event, span)
+            Thread.current[:datadog_mongo_span] ||= {}
+            Thread.current[:datadog_mongo_span][event.request_id] = span
+          end
+
+          def clear_span(event)
+            return if Thread.current[:datadog_mongo_span].nil?
+
+            Thread.current[:datadog_mongo_span].delete(event.request_id)
+          end
+
+          def analytics_enabled?
+            Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+          end
+
+          def analytics_sample_rate
+            datadog_configuration[:analytics_sample_rate]
+          end
+
+          def datadog_configuration
+            Datadog.configuration.tracing[:mongo]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+require_relative '../../propagation/sql_comment'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Mysql2
+        module Configuration
+          # Custom settings for the Mysql2 integration
+          # @public_api
+          class Settings < Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+
+            # @!visibility private
+            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 :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 :peer_service do |o|
+              o.type :string, nilable: true
+              o.env Ext::ENV_PEER_SERVICE
+            end
+
+            option :on_error do |o|
+              o.type :proc, nilable: true
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Mysql2
+        # Mysql2 integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_MYSQL2_ENABLED'
+          ENV_SERVICE_NAME = 'DD_TRACE_MYSQL2_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_MYSQL2_PEER_SERVICE'
+
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_MYSQL2_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_MYSQL2_ANALYTICS_SAMPLE_RATE'
+          DEFAULT_PEER_SERVICE_NAME = 'mysql2'
+          SPAN_QUERY = 'mysql2.query'
+          TAG_DB_NAME = 'mysql2.db.name'
+          TAG_COMPONENT = 'mysql2'
+          TAG_OPERATION_QUERY = 'query'
+          TAG_SYSTEM = 'mysql'
+          PEER_SERVICE_SOURCES = (Array[Ext::TAG_DB_NAME] + Contrib::Ext::DB::PEER_SERVICE_SOURCES).freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# 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
+    module Contrib
+      module Mysql2
+        # Mysql2::Client patch module
+        module Instrumentation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # Mysql2::Client patch instance methods
+          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, 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)
+
+                span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, query_options[:host])
+
+                # Set analytics sample rate
+                Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+                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
+
+            private
+
+            def datadog_configuration
+              Datadog.configuration.tracing[:mysql2]
+            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/mysql2/integration.rb

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../patcher'
+require_relative 'instrumentation'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Mysql2
+        # Patcher enables patching of 'mysql2' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            patch_mysql2_client
+          end
+
+          def patch_mysql2_client
+            ::Mysql2::Client.include(Instrumentation)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# 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
+
+            # @!visibility private
+            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,38 @@
+# 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'
+          # @!visibility private
+          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