ddtrace 0.53.0 → 1.0.0.beta1

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

@@ -0,0 +1,51 @@
+# typed: false
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/dalli/configuration/settings'
+require 'datadog/tracing/contrib/dalli/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Dalli
+        # Description of Dalli integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('2.0.0')
+          DALLI_PROTOCOL_BINARY_VERSION = Gem::Version.new('3.0.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :dalli, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs['dalli'] && Gem.loaded_specs['dalli'].version
+          end
+
+          def self.loaded?
+            !defined?(::Dalli).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          def self.dalli_class
+            if version >= DALLI_PROTOCOL_BINARY_VERSION
+              ::Dalli::Protocol::Binary
+            else
+              ::Dalli::Server
+            end
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# typed: true
+require 'datadog/tracing/contrib/dalli/ext'
+require 'datadog/tracing/contrib/dalli/instrumentation'
+require 'datadog/tracing/contrib/dalli/integration'
+require 'datadog/tracing/contrib/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Dalli
+        # Patcher enables patching of 'dalli' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            Integration.dalli_class.include(Instrumentation)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# typed: true
+require 'datadog/tracing/contrib/dalli/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Dalli
+        # Quantize contains dalli-specic quantization tools.
+        module Quantize
+          module_function
+
+          def format_command(operation, args)
+            placeholder = "#{operation} BLOB (OMITTED)"
+            command = [operation, *args].join(' ').strip
+            command = Core::Utils.utf8_encode(command, binary: true, placeholder: placeholder)
+            Core::Utils.truncate(command, Ext::QUANTIZE_MAX_CMD_LENGTH)
+          rescue => e
+            Datadog.logger.debug("Error sanitizing Dalli operation: #{e}")
+            placeholder
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# typed: false
+require 'datadog/tracing/span_operation'
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/delayed_job/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module DelayedJob
+        module Configuration
+          # Custom settings for the DelayedJob 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
+            option :client_service_name
+            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# typed: true
+module Datadog
+  module Tracing
+    module Contrib
+      module DelayedJob
+        # DelayedJob integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_DELAYED_JOB_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_DELAYED_JOB_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'.freeze
+          SPAN_JOB = 'delayed_job'.freeze
+          SPAN_ENQUEUE = 'delayed_job.enqueue'.freeze
+          TAG_ATTEMPTS = 'delayed_job.attempts'.freeze
+          TAG_ID = 'delayed_job.id'.freeze
+          TAG_PRIORITY = 'delayed_job.priority'.freeze
+          TAG_QUEUE = 'delayed_job.queue'.freeze
+          TAG_COMPONENT = 'delayed_job'.freeze
+          TAG_OPERATION_ENQUEUE = 'enqueue'.freeze
+          TAG_OPERATION_JOB = 'job'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# typed: false
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/delayed_job/configuration/settings'
+require 'datadog/tracing/contrib/delayed_job/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module DelayedJob
+        # Description of DelayedJob integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('4.1')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :delayed_job
+
+          def self.version
+            Gem.loaded_specs['delayed_job'] && Gem.loaded_specs['delayed_job'].version
+          end
+
+          def self.loaded?
+            !defined?(::Delayed).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/delayed_job/patcher.rb

@@ -0,0 +1,31 @@
+# typed: false
+require 'datadog/tracing/contrib/delayed_job/integration'
+require 'datadog/tracing/contrib/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module DelayedJob
+        # Patcher enables patching of 'delayed_job' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            require 'datadog/tracing/contrib/delayed_job/plugin'
+            add_instrumentation(::Delayed::Worker)
+          end
+
+          def add_instrumentation(klass)
+            klass.plugins << Plugin
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/delayed_job/plugin.rb

@@ -0,0 +1,100 @@
+# typed: ignore
+require 'delayed/plugin'
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/delayed_job/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module DelayedJob
+        # DelayedJob plugin that instruments invoke_job hook
+        class Plugin < Delayed::Plugin
+          def self.instrument_invoke(job, &block)
+            return yield(job) unless Tracing.enabled?
+
+            Tracing.trace(
+              Ext::SPAN_JOB,
+              service: configuration[:service_name],
+              resource: job_name(job),
+              on_error: configuration[:error_handler]
+            ) do |span|
+              set_sample_rate(span)
+
+              # Measure service stats
+              Contrib::Analytics.set_measured(span)
+
+              span.set_tag(Ext::TAG_ID, job.id)
+              span.set_tag(Ext::TAG_QUEUE, job.queue) if job.queue
+              span.set_tag(Ext::TAG_PRIORITY, job.priority)
+              span.set_tag(Ext::TAG_ATTEMPTS, job.attempts)
+              span.span_type = Tracing::Metadata::Ext::AppTypes::TYPE_WORKER
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_JOB)
+
+              yield job
+            end
+          end
+
+          def self.instrument_enqueue(job, &block)
+            return yield(job) unless Tracing.enabled?
+
+            Tracing.trace(
+              Ext::SPAN_ENQUEUE,
+              service: configuration[:client_service_name],
+              resource: job_name(job)
+            ) do |span|
+              set_sample_rate(span)
+
+              # Measure service stats
+              Contrib::Analytics.set_measured(span)
+
+              span.set_tag(Ext::TAG_QUEUE, job.queue) if job.queue
+              span.set_tag(Ext::TAG_PRIORITY, job.priority)
+              span.span_type = Tracing::Metadata::Ext::AppTypes::TYPE_WORKER
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ENQUEUE)
+
+              yield job
+            end
+          end
+
+          def self.flush(worker, &block)
+            yield worker
+
+            Tracing.shutdown! if Tracing.enabled?
+          end
+
+          def self.configuration
+            Datadog.configuration[:delayed_job]
+          end
+
+          def self.job_name(job)
+            # When DelayedJob is used through ActiveJob, we need to parse the payload differentely
+            # to get the actual job name
+            return job.payload_object.job_data['job_class'] if job.payload_object.respond_to?(:job_data)
+
+            job.name
+          end
+
+          def self.set_sample_rate(span)
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+          end
+
+          callbacks do |lifecycle|
+            lifecycle.around(:invoke_job) { |job, &block| instrument_invoke(job, &block) }
+            lifecycle.around(:enqueue) { |job, &block| instrument_enqueue(job, &block) }
+            lifecycle.around(:execute) { |worker, &block| flush(worker, &block) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# typed: false
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/elasticsearch/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Elasticsearch
+        module Configuration
+          # Custom settings for the Elasticsearch 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 :quantize, default: {}
+            option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# typed: true
+module Datadog
+  module Tracing
+    module Contrib
+      module Elasticsearch
+        # Elasticsearch integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_ELASTICSEARCH_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ELASTICSEARCH_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ELASTICSEARCH_ANALYTICS_SAMPLE_RATE'.freeze
+          DEFAULT_PEER_SERVICE_NAME = 'elasticsearch'.freeze
+          SPAN_QUERY = 'elasticsearch.query'.freeze
+          SPAN_TYPE_QUERY = 'elasticsearch'.freeze
+          TAG_BODY = 'elasticsearch.body'.freeze
+          TAG_METHOD = 'elasticsearch.method'.freeze
+          TAG_PARAMS = 'elasticsearch.params'.freeze
+          TAG_URL = 'elasticsearch.url'.freeze
+          TAG_COMPONENT = 'elasticsearch'.freeze
+          TAG_OPERATION_QUERY = 'query'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: false
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/elasticsearch/configuration/settings'
+require 'datadog/tracing/contrib/elasticsearch/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Elasticsearch
+        # Description of Elasticsearch 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 :elasticsearch, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs['elasticsearch-transport'] \
+              && Gem.loaded_specs['elasticsearch-transport'].version
+          end
+
+          def self.loaded?
+            !defined?(::Elasticsearch::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/elasticsearch/patcher.rb

@@ -0,0 +1,114 @@
+# typed: false
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/elasticsearch/ext'
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Elasticsearch
+        # Patcher enables patching of 'elasticsearch' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            require 'uri'
+            require 'json'
+            require 'datadog/tracing/contrib/elasticsearch/quantize'
+
+            patch_elasticsearch_transport_client
+          end
+
+          # rubocop:disable Metrics/MethodLength
+          # rubocop:disable Metrics/AbcSize
+          def patch_elasticsearch_transport_client
+            # rubocop:disable Metrics/BlockLength
+            ::Elasticsearch::Transport::Client.class_eval do
+              alias_method :perform_request_without_datadog, :perform_request
+              remove_method :perform_request
+
+              def perform_request(*args)
+                service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
+
+                method = args[0]
+                path = args[1]
+                params = args[2]
+                body = args[3]
+                full_url = URI.parse(path)
+
+                url = full_url.path
+                response = nil
+
+                Tracing.trace(Datadog::Tracing::Contrib::Elasticsearch::Ext::SPAN_QUERY, service: service) do |span|
+                  begin
+                    connection = transport.connections.first
+                    host = connection.host[:host] if connection
+                    port = connection.host[:port] if connection
+
+                    span.span_type = Datadog::Tracing::Contrib::Elasticsearch::Ext::SPAN_TYPE_QUERY
+
+                    span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                    span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_QUERY)
+
+                    # load JSON for the following fields unless they're already strings
+                    params = JSON.generate(params) if params && !params.is_a?(String)
+                    body = JSON.generate(body) if body && !body.is_a?(String)
+
+                    # Tag as an external peer service
+                    span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+                    span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host) if host
+
+                    # Set analytics sample rate
+                    if Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+                      Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])
+                    end
+
+                    span.set_tag(Datadog::Tracing::Contrib::Elasticsearch::Ext::TAG_METHOD, method)
+                    span.set_tag(Datadog::Tracing::Contrib::Elasticsearch::Ext::TAG_URL, url)
+                    span.set_tag(Datadog::Tracing::Contrib::Elasticsearch::Ext::TAG_PARAMS, params) if params
+                    if body
+                      quantize_options = datadog_configuration[:quantize]
+                      quantized_body = Datadog::Tracing::Contrib::Elasticsearch::Quantize.format_body(
+                        body,
+                        quantize_options
+                      )
+                      span.set_tag(Datadog::Tracing::Contrib::Elasticsearch::Ext::TAG_BODY, quantized_body)
+                    end
+                    span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, host) if host
+                    span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, port) if port
+
+                    quantized_url = Datadog::Tracing::Contrib::Elasticsearch::Quantize.format_url(url)
+                    span.resource = "#{method} #{quantized_url}"
+                  rescue StandardError => e
+                    Datadog.logger.error(e.message)
+                  ensure
+                    # the call is still executed
+                    response = perform_request_without_datadog(*args)
+                    span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, response.status)
+                  end
+                end
+                response
+              end
+
+              def datadog_configuration
+                Datadog.configuration[:elasticsearch]
+              end
+            end
+            # rubocop:enable Metrics/BlockLength
+          end
+          # rubocop:enable Metrics/MethodLength
+          # rubocop:enable Metrics/AbcSize
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+require 'datadog/tracing/contrib/utils/quantization/hash'
+
+# typed: true
+module Datadog
+  module Tracing
+    module Contrib
+      module Elasticsearch
+        # Quantize contains ES-specific resource quantization tools.
+        module Quantize
+          include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+
+          PLACEHOLDER = '?'.freeze
+          ID_PLACEHOLDER = '\1?'.freeze
+          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)
+            sanitize_fragment_with_id(url)
+              .gsub(/(?:\d+)/, PLACEHOLDER)
+          end
+
+          def format_body(body, options = {})
+            format_body!(body, options)
+          rescue StandardError
+            options[:placeholder] || 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 = 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
+
+          # Sanitizes URL fragment by changing it to ? whenever a number is detected
+          # This is meant as simple heuristic that attempts to detect if particular fragment
+          # represents document Id. This is meant to reduce the cardinality in most frequent cases.
+          def sanitize_fragment_with_id(url)
+            url.gsub(%r{^(/?[^/]*/[^/]*/)(?:[^?/\d]*\d+[^?/]*)}, ID_PLACEHOLDER)
+          end
+        end
+      end
+    end
+  end
+end