datadog 2.0.0.beta1

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 do |name, _value|
+              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,40 @@
+# 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 = 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/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'] && 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

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative '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,37 @@
+# frozen_string_literal: true
+
+require_relative '../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_relative 'plugin'
+            add_instrumentation(::Delayed::Worker)
+            patch_server_internals
+          end
+
+          def add_instrumentation(klass)
+            klass.plugins << Plugin
+          end
+
+          def patch_server_internals
+            require_relative 'server_internal_tracer/worker'
+            ::Delayed::Worker.prepend(ServerInternalTracer::Worker)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'delayed/plugin'
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative '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[:on_error]
+            ) 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.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)
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CONSUMER)
+
+              span.set_tag(Contrib::Ext::Messaging::TAG_SYSTEM, Ext::TAG_COMPONENT)
+
+              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.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)
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_PRODUCER)
+
+              span.set_tag(Contrib::Ext::Messaging::TAG_SYSTEM, Ext::TAG_COMPONENT)
+
+              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/delayed_job/server_internal_tracer/worker.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module DelayedJob
+        module ServerInternalTracer
+          # Trace when DelayedJob looks for a new job to work on
+          module Worker
+            def reserve_job
+              configuration = Datadog.configuration.tracing[:delayed_job]
+
+              Datadog::Tracing.trace(Ext::SPAN_RESERVE_JOB, service: configuration[:service_name]) do |span|
+                span.type = Datadog::Tracing::Metadata::Ext::AppTypes::TYPE_WORKER
+
+                span.set_tag(Contrib::Ext::Messaging::TAG_SYSTEM, Ext::TAG_COMPONENT)
+
+                span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_RESERVE_JOB)
+
+                # Set analytics sample rate
+                if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+                  Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+                end
+
+                super
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative '../../configuration/settings'
+require_relative '../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.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 do |o|
+              o.type :hash
+              o.default({})
+            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
+          end
+        end
+      end
+    end
+  end
+end