ddtrace 0.54.2 → 1.2.0

data/lib/datadog/tracing/contrib/configuration/resolver.rb

@@ -0,0 +1,85 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Configuration
+        # Resolves an integration-specific matcher to an associated
+        # object.
+        #
+        # Integrations that perform any configuration matching
+        # based on patterns might want to override this class
+        # to provide richer matching. For example, match configuration
+        # based on: HTTP request parameters, request headers,
+        # async queue name.
+        #
+        # When overriding this class, for simple use cases, only
+        # overriding `#parse_matcher` might suffice. See
+        # `#parse_matcher`'s documentation for more information.
+        class Resolver
+          attr_reader :configurations
+
+          def initialize
+            @configurations = {}
+          end
+
+          # Adds a new `matcher`, associating with it a `value`.
+          #
+          # This `value` is returned when `#resolve` is called
+          # with a matching value for this matcher. When multiple
+          # matchers would match, `#resolve` returns the latest
+          # added one.
+          #
+          # The `matcher` can be transformed internally by the
+          # `#parse_matcher` method before being stored.
+          #
+          # The `value` can also be retrieved by calling `#get`
+          # with the same `matcher` added by this method.
+          #
+          # @param [Object] matcher integration-specific matcher
+          # @param [Object] value arbitrary value to be associated with `matcher`
+          def add(matcher, value)
+            @configurations[parse_matcher(matcher)] = value
+          end
+
+          # Retrieves the stored value for a `matcher`
+          # previously stored by `#add`.
+          #
+          # @param [Object] matcher integration-specific matcher
+          # @return [Object] previously stored `value` from `#add`, or `nil` if not found
+          def get(matcher)
+            @configurations[parse_matcher(matcher)]
+          end
+
+          # Matches an arbitrary value against the configured
+          # matchers previously set with `#add`.
+          #
+          # If multiple matchers would match, returns the latest one.
+          #
+          # @param [Object] value integration-specific value
+          # @return [Object] matching `value` configured at `#add`, or `nil` if none match
+          def resolve(value)
+            @configurations[value]
+          end
+
+          protected
+
+          # Converts `matcher` into an appropriate key
+          # for the internal Hash storage.
+          #
+          # It's recommended to override this method,
+          # instead of the public methods, if the
+          # integration can simply convert both
+          # `matcher` (provided to `#add`) and `value`
+          # (provided to `#resolve`) to the same value.
+          #
+          # @param [Object] matcher integration-specific matcher
+          # @return [Object] processed matcher
+          def parse_matcher(matcher)
+            matcher
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/configuration/resolvers/pattern_resolver.rb

@@ -0,0 +1,43 @@
+# typed: true
+
+require 'datadog/tracing/contrib/configuration/resolver'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Configuration
+        # Resolves a value to a configuration key
+        module Resolvers
+          # Matches Strings and Regexps against `object.to_s` objects
+          # and Procs against plain objects.
+          class PatternResolver < Contrib::Configuration::Resolver
+            def resolve(value)
+              return if configurations.empty?
+
+              # Try to find a matching pattern
+              _, config = configurations.reverse_each.find do |matcher, _|
+                matcher === if matcher.is_a?(Proc)
+                              value
+                            else
+                              value.to_s
+                            end
+              end
+
+              config
+            end
+
+            protected
+
+            def parse_matcher(matcher)
+              if matcher.is_a?(Regexp) || matcher.is_a?(Proc)
+                matcher
+              else
+                matcher.to_s
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: false
+
+require 'datadog/core/configuration/base'
+require 'datadog/core/utils/only_once'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Configuration
+        # Common settings for all integrations
+        # @public_api
+        class Settings
+          include Core::Configuration::Base
+
+          DEPRECATION_WARN_ONLY_ONCE = Core::Utils::OnlyOnce.new
+
+          option :analytics_enabled, default: false
+          option :analytics_sample_rate, default: 1.0
+          option :enabled, default: true
+          # TODO: Deprecate per-integration service name when first-class peer service support is added
+          # TODO: We don't want to recommend per-integration service naming, but there are no equivalent alternatives today.
+          option :service_name
+
+          def configure(options = {})
+            self.class.options.dependency_order.each do |name|
+              self[name] = options[name] if options.key?(name)
+            end
+
+            yield(self) if block_given?
+          end
+
+          def [](name)
+            respond_to?(name) ? send(name) : get_option(name)
+          end
+
+          def []=(name, value)
+            respond_to?("#{name}=") ? send("#{name}=", value) : set_option(name, value)
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,24 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Dalli
+        # Dalli integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_DALLI_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_DALLI_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DALLI_ANALYTICS_SAMPLE_RATE'.freeze
+          QUANTIZE_MAX_CMD_LENGTH = 100
+          DEFAULT_PEER_SERVICE_NAME = 'memcached'.freeze
+          SPAN_COMMAND = 'memcached.command'.freeze
+          SPAN_TYPE_COMMAND = 'memcached'.freeze
+          TAG_COMMAND = 'memcached.command'.freeze
+          TAG_COMPONENT = 'dalli'.freeze
+          TAG_OPERATION_COMMAND = 'command'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# typed: false
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/dalli/ext'
+require 'datadog/tracing/contrib/dalli/quantize'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Dalli
+        # Instruments every interaction with the memcached server
+        module Instrumentation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # InstanceMethods - implementing instrumentation
+          module InstanceMethods
+            def request(op, *args)
+              Tracing.trace(Ext::SPAN_COMMAND) do |span|
+                span.resource = op.to_s.upcase
+                span.service = datadog_configuration[:service_name]
+                span.span_type = Ext::SPAN_TYPE_COMMAND
+
+                span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_COMMAND)
+
+                # 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, hostname)
+
+                # 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(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, hostname)
+                span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, port)
+                cmd = Quantize.format_command(op, args)
+                span.set_tag(Ext::TAG_COMMAND, cmd)
+
+                super
+              end
+            end
+
+            private
+
+            def datadog_configuration
+              Datadog.configuration.tracing[:dalli, "#{hostname}:#{port}"]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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/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,26 @@
+# 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,38 @@
+# 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,26 @@
+# 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,43 @@
+# 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/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,101 @@
+# 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.tracing[: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,36 @@
+# 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