cw-datadog 2.23.0.2

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

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative 'configuration/resolver'
+require_relative 'configuration/settings'
+
+module Datadog
+  module Tracing
+    module Contrib
+      # Defines configurable behavior for integrations.
+      #
+      # This module is responsible for coordination between
+      # the configuration resolver and default configuration
+      # fallback.
+      module Configurable
+        def self.included(base)
+          base.include(InstanceMethods)
+        end
+
+        # Configurable instance behavior for integrations
+        module InstanceMethods
+          # Get matching configuration by matcher.
+          # If no match, returns the default configuration instance.
+          def configuration(matcher = :default)
+            return default_configuration if matcher == :default
+
+            resolver.get(matcher) || default_configuration
+          end
+
+          # Resolves the matching configuration for integration-specific value.
+          # If no match, returns the default configuration instance.
+          def resolve(value)
+            return default_configuration if value == :default
+
+            resolver.resolve(value) || default_configuration
+          end
+
+          # Returns all registered matchers and their respective configurations.
+          def configurations
+            resolver.configurations.merge(default: default_configuration)
+          end
+
+          # Create or update configuration associated with `matcher` with
+          # the provided `options` and `&block`.
+          def configure(matcher = :default, options = {}, &block)
+            config = if matcher == :default
+              default_configuration
+            else
+              # Get or add the configuration
+              resolver.get(matcher) || resolver.add(matcher, new_configuration)
+            end
+
+            # Apply the settings
+            config&.configure(options, &block)
+            config
+          end
+
+          # Resets all configuration options
+          def reset_configuration!
+            @resolver = nil
+            @default_configuration = nil
+          end
+
+          # Returns the integration-specific configuration object.
+          #
+          # If one does not exist, invoke {.new_configuration} a memoize
+          # its value.
+          #
+          # @return [Datadog::Tracing::Contrib::Configuration::Settings] the memoized integration-specific settings object
+          def default_configuration
+            @default_configuration ||= new_configuration
+          end
+
+          protected
+
+          # Returns a new configuration object for this integration.
+          #
+          # This method normally needs to be overridden for each integration
+          # as their settings, defaults and environment variables are
+          # specific for each integration.
+          #
+          # @return [Datadog::Tracing::Contrib::Configuration::Settings] a new, integration-specific settings object
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          # Overridable configuration resolver.
+          #
+          # This resolver is responsible for performing the matching
+          # of `#configure(matcher)` `matcher`s with `value`s provided
+          # in subsequent calls to `#resolve(value)`.
+          #
+          # By default, the `value` in `#resolve(value)` must be equal
+          # to the `matcher` object provided in `#configure(matcher)`
+          # to retrieve the associated configuration.
+          def resolver
+            @resolver ||= Configuration::Resolver.new
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,128 @@
+# frozen_string_literal: 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
+
+        # The {CachingResolver} is a mixin that provides caching functionality to the {Resolver} class.
+        # This is useful when {Resolver#resolve} values that are expensive to compute.
+        # This is a size-limited, FIFO cache.
+        #
+        # @example
+        #   class MyResolver < Datadog::Tracing::Contrib::Configuration::Resolver
+        #     prepend Datadog::Tracing::Contrib::Configuration::CachingResolver
+        #     # ...
+        #   end
+        module CachingResolver
+          # @param [Integer] cache_limit maximum number of entries to cache
+          def initialize(*args, cache_limit: 200)
+            super(*args)
+
+            @cache_limit = cache_limit
+            @cache = {}
+          end
+
+          # (see Resolver#resolve)
+          def resolve(value)
+            if @cache.key?(value)
+              @cache[value]
+            else
+              if @cache.size >= @cache_limit
+                @cache.shift # Remove the oldest entry if cache is full
+              end
+
+              @cache[value] = super
+            end
+          end
+
+          # (see Resolver#add)
+          def add(matcher, value)
+            reset_cache # Bust the cache when a new matcher is added
+            super
+          end
+
+          # Clears the internal cache.
+          def reset_cache
+            @cache.clear
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative '../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 @@
+# frozen_string_literal: true
+
+require_relative '../../../core/configuration/base'
+require_relative '../../../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
+
+          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 do |o|
+            o.type :string, nilable: true
+          end
+
+          def configure(options = {})
+            self.class.options.each_key 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,58 @@
+# frozen_string_literal: true
+
+require_relative '../../configuration/settings'
+require_relative '../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.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.type :string, nilable: true
+              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
+
+            option :command_enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_COMMAND_ENABLED
+              o.default false
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: 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
+          # DEV: Even though this is the dalli integration, all spans are named `memcached.*`.
+          # DEV: This happens because such spans have special treatment in backend, with memcached-specific handling.
+          # DEV: If add support for the `memcached` gem (not popular as of 2023), we'll have issues with span naming
+          # DEV: conflicts.
+          ENV_ENABLED = 'DD_TRACE_DALLI_ENABLED'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_DALLI_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DALLI_ANALYTICS_SAMPLE_RATE'
+          # DEV: This is named `*_MEMCACHED_*` because the spans it refer to are `memcached.*` and this variable
+          # DEV: is a global flag that affects all memcached spans generated by any Datadog product.
+          ENV_COMMAND_ENABLED = 'DD_TRACE_MEMCACHED_COMMAND_ENABLED'
+          ENV_SERVICE_NAME = 'DD_TRACE_DALLI_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_DALLI_PEER_SERVICE'
+
+          QUANTIZE_MAX_CMD_LENGTH = 100
+          DEFAULT_PEER_SERVICE_NAME = 'memcached'
+          SPAN_COMMAND = 'memcached.command'
+          SPAN_TYPE_COMMAND = 'memcached'
+          TAG_COMMAND = 'memcached.command'
+          TAG_COMPONENT = 'dalli'
+          TAG_OPERATION_COMMAND = 'command'
+          TAG_SYSTEM = 'memcached'
+          PEER_SERVICE_SOURCES = [
+            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/dalli/instrumentation.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative '../ext'
+require_relative '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.type = Ext::SPAN_TYPE_COMMAND
+
+                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(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, 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)
+
+                span.set_tag(Contrib::Ext::DB::TAG_SYSTEM, Ext::TAG_SYSTEM)
+
+                if datadog_configuration[:command_enabled]
+                  cmd = Quantize.format_command(op, args)
+                  span.set_tag(Ext::TAG_COMMAND, cmd)
+                end
+
+                Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
+                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 @@
+# frozen_string_literal: true
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative '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']&.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 @@
+# frozen_string_literal: true
+
+require_relative 'ext'
+require_relative 'instrumentation'
+require_relative '../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 @@
+# frozen_string_literal: true
+
+require_relative '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,49 @@
+# frozen_string_literal: true
+
+require_relative '../../configuration/settings'
+require_relative '../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.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.type :string, nilable: true
+            end
+
+            option :client_service_name do |o|
+              o.type :string, nilable: true
+            end
+
+            option :on_error do |o|
+              o.type :proc, nilable: true
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: 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'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_DELAYED_JOB_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'
+          SPAN_JOB = 'delayed_job'
+          SPAN_ENQUEUE = 'delayed_job.enqueue'
+          SPAN_RESERVE_JOB = 'delayed_job.reserve_job'
+          TAG_ATTEMPTS = 'delayed_job.attempts'
+          TAG_ID = 'delayed_job.id'
+          TAG_PRIORITY = 'delayed_job.priority'
+          TAG_QUEUE = 'delayed_job.queue'
+          TAG_COMPONENT = 'delayed_job'
+          TAG_OPERATION_ENQUEUE = 'enqueue'
+          TAG_OPERATION_JOB = 'job'
+          TAG_OPERATION_RESERVE_JOB = 'reserve_job'
+        end
+      end
+    end
+  end
+end