ddtrace 0.52.0 → 0.54.2

data/lib/ddtrace/contrib/action_mailer/events/process.rb

@@ -0,0 +1,41 @@
+# typed: false
+require 'ddtrace/contrib/action_mailer/ext'
+require 'ddtrace/contrib/action_mailer/event'
+
+module Datadog
+  module Contrib
+    module ActionMailer
+      module Events
+        # Defines instrumentation for process.action_mailer event
+        module Process
+          include ActionMailer::Event
+
+          EVENT_NAME = 'process.action_mailer'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_PROCESS
+          end
+
+          def span_type
+            # process.action_mailer processes email and renders partial templates
+            Datadog::Ext::HTTP::TEMPLATE
+          end
+
+          def process(span, event, _id, payload)
+            super
+
+            span.span_type = span_type
+            span.set_tag(Ext::TAG_ACTION, payload[:action])
+            span.set_tag(Ext::TAG_MAILER, payload[:mailer])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_mailer/events.rb

@@ -0,0 +1,31 @@
+# typed: false
+require 'ddtrace/contrib/action_mailer/events/process'
+require 'ddtrace/contrib/action_mailer/events/deliver'
+
+module Datadog
+  module Contrib
+    module ActionMailer
+      # Defines collection of instrumented ActionMailer events
+      module Events
+        ALL = [
+          Events::Process,
+          Events::Deliver
+        ].freeze
+
+        module_function
+
+        def all
+          self::ALL
+        end
+
+        def subscriptions
+          all.collect(&:subscriptions).collect(&:to_a).flatten
+        end
+
+        def subscribe!
+          all.each(&:subscribe!)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_mailer/ext.rb

@@ -0,0 +1,32 @@
+# typed: true
+module Datadog
+  module Contrib
+    module ActionMailer
+      # ActionMailer integration constants
+      module Ext
+        APP = 'action_mailer'.freeze
+        ENV_ENABLED = 'DD_TRACE_ACTION_MAILER_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_MAILER_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_MAILER_ANALYTICS_SAMPLE_RATE'.freeze
+
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_ACTION_MAILER_ANALYTICS_ENABLED'.freeze
+
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ACTION_MAILER_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'action_mailer'.freeze
+        SPAN_PROCESS = 'action_mailer.process'.freeze
+        SPAN_DELIVER = 'action_mailer.deliver'.freeze
+        TAG_ACTION = 'action_mailer.action'.freeze
+        TAG_MAILER = 'action_mailer.mailer'.freeze
+        TAG_MSG_ID = 'action_mailer.message_id'.freeze
+
+        TAG_SUBJECT = 'action_mailer.subject'.freeze
+        TAG_TO = 'action_mailer.to'.freeze
+        TAG_FROM = 'action_mailer.from'.freeze
+        TAG_BCC = 'action_mailer.bcc'.freeze
+        TAG_CC = 'action_mailer.cc'.freeze
+        TAG_DATE = 'action_mailer.date'.freeze
+        TAG_PERFORM_DELIVERIES = 'action_mailer.perform_deliveries'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_mailer/integration.rb

@@ -0,0 +1,45 @@
+# typed: false
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/action_mailer/configuration/settings'
+require 'ddtrace/contrib/action_mailer/patcher'
+
+module Datadog
+  module Contrib
+    module ActionMailer
+      # Description of ActionMailer integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('5.0.0')
+
+        register_as :action_mailer, auto_patch: false
+
+        def self.version
+          Gem.loaded_specs['actionmailer'] && Gem.loaded_specs['actionmailer'].version
+        end
+
+        def self.loaded?
+          !defined?(::ActionMailer).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION && !defined?(::ActiveSupport::Notifications).nil?
+        end
+
+        # enabled by rails integration so should only auto instrument
+        # if detected that it is being used without rails
+        def auto_instrument?
+          !Datadog::Contrib::Rails::Utils.railtie_supported?
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          ActionMailer::Patcher
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_mailer/patcher.rb

@@ -0,0 +1,27 @@
+# typed: true
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/action_mailer/ext'
+require 'ddtrace/contrib/action_mailer/events'
+
+module Datadog
+  module Contrib
+    module ActionMailer
+      # Patcher enables patching of 'action_mailer' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def target_version
+          Integration.version
+        end
+
+        def patch
+          # Subscribe to ActionMailer events
+          Events.subscribe!
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_job/configuration/settings.rb

@@ -0,0 +1,33 @@
+# typed: false
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/active_job/ext'
+
+module Datadog
+  module Contrib
+    module ActiveJob
+      module Configuration
+        # Custom settings for the DelayedJob integration
+        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, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
+            o.lazy
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
+            o.lazy
+          end
+
+          option :service_name, default: Ext::SERVICE_NAME
+          option :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
+          option :log_injection, default: false
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_job/event.rb

@@ -0,0 +1,54 @@
+# typed: true
+require 'ddtrace/contrib/active_support/notifications/event'
+require 'ddtrace/contrib/active_job/ext'
+
+module Datadog
+  module Contrib
+    module ActiveJob
+      # Defines basic behaviors for an ActiveJob event.
+      module Event
+        def self.included(base)
+          base.include(ActiveSupport::Notifications::Event)
+          base.extend(ClassMethods)
+        end
+
+        # Class methods for ActiveJob events.
+        module ClassMethods
+          def span_options
+            { service: configuration[:service_name] }
+          end
+
+          def tracer
+            -> { configuration[:tracer] }
+          end
+
+          def configuration
+            Datadog.configuration[:active_job]
+          end
+
+          def set_common_tags(span, payload)
+            adapter_name = if payload[:adapter].is_a?(Class)
+                             payload[:adapter].name
+                           else
+                             payload[:adapter].class.name
+                           end
+            span.set_tag(Ext::TAG_ADAPTER, adapter_name)
+
+            job = payload[:job]
+            span.set_tag(Ext::TAG_JOB_ID, job.job_id)
+            span.set_tag(Ext::TAG_JOB_QUEUE, job.queue_name)
+            span.set_tag(Ext::TAG_JOB_PRIORITY, job.priority) if job.respond_to?(:priority)
+            span.set_tag(Ext::TAG_JOB_EXECUTIONS, job.executions) if job.respond_to?(:executions)
+
+            job_scheduled_at = if job.respond_to?(:scheduled_at)
+                                 job.scheduled_at
+                               elsif job.respond_to?(:enqueued_at)
+                                 job.enqueued_at
+                               end
+            span.set_tag(Ext::TAG_JOB_SCHEDULED_AT, Time.at(job_scheduled_at)) if job_scheduled_at
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_job/events/discard.rb

@@ -0,0 +1,46 @@
+# typed: false
+require 'ddtrace/ext/integration'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/active_job/ext'
+require 'ddtrace/contrib/active_job/event'
+
+module Datadog
+  module Contrib
+    module ActiveJob
+      module Events
+        # Defines instrumentation for enqueue.active_job event
+        module Discard
+          include ActiveJob::Event
+
+          EVENT_NAME = 'discard.active_job'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_DISCARD
+          end
+
+          def process(span, event, _id, payload)
+            span.name = span_name
+            span.service = configuration[:service_name]
+            span.resource = payload[:job].class.name
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+
+            set_common_tags(span, payload)
+            span.set_tag(Ext::TAG_JOB_ERROR, payload[:error])
+          rescue StandardError => e
+            Datadog.logger.debug(e.message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_job/events/enqueue.rb

@@ -0,0 +1,45 @@
+# typed: false
+require 'ddtrace/ext/integration'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/active_job/ext'
+require 'ddtrace/contrib/active_job/event'
+
+module Datadog
+  module Contrib
+    module ActiveJob
+      module Events
+        # Defines instrumentation for enqueue.active_job event
+        module Enqueue
+          include ActiveJob::Event
+
+          EVENT_NAME = 'enqueue.active_job'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_ENQUEUE
+          end
+
+          def process(span, event, _id, payload)
+            span.name = span_name
+            span.service = configuration[:service_name]
+            span.resource = payload[:job].class.name
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+
+            set_common_tags(span, payload)
+          rescue StandardError => e
+            Datadog.logger.debug(e.message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_job/events/enqueue_at.rb

@@ -0,0 +1,45 @@
+# typed: false
+require 'ddtrace/ext/integration'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/active_job/ext'
+require 'ddtrace/contrib/active_job/event'
+
+module Datadog
+  module Contrib
+    module ActiveJob
+      module Events
+        # Defines instrumentation for enqueue.active_job event
+        module EnqueueAt
+          include ActiveJob::Event
+
+          EVENT_NAME = 'enqueue_at.active_job'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_ENQUEUE
+          end
+
+          def process(span, event, _id, payload)
+            span.name = span_name
+            span.service = configuration[:service_name]
+            span.resource = payload[:job].class.name
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+
+            set_common_tags(span, payload)
+          rescue StandardError => e
+            Datadog.logger.debug(e.message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_job/events/enqueue_retry.rb

@@ -0,0 +1,47 @@
+# typed: false
+require 'ddtrace/ext/integration'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/active_job/ext'
+require 'ddtrace/contrib/active_job/event'
+
+module Datadog
+  module Contrib
+    module ActiveJob
+      module Events
+        # Defines instrumentation for enqueue.active_job event
+        module EnqueueRetry
+          include ActiveJob::Event
+
+          EVENT_NAME = 'enqueue_retry.active_job'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_ENQUEUE_RETRY
+          end
+
+          def process(span, event, _id, payload)
+            span.name = span_name
+            span.service = configuration[:service_name]
+            span.resource = payload[:job].class.name
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+
+            set_common_tags(span, payload)
+            span.set_tag(Ext::TAG_JOB_ERROR, payload[:error])
+            span.set_tag(Ext::TAG_JOB_RETRY_WAIT, payload[:wait])
+          rescue StandardError => e
+            Datadog.logger.debug(e.message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_job/events/perform.rb

@@ -0,0 +1,45 @@
+# typed: false
+require 'ddtrace/ext/integration'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/active_job/ext'
+require 'ddtrace/contrib/active_job/event'
+
+module Datadog
+  module Contrib
+    module ActiveJob
+      module Events
+        # Defines instrumentation for perform.active_job event
+        module Perform
+          include ActiveJob::Event
+
+          EVENT_NAME = 'perform.active_job'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_PERFORM
+          end
+
+          def process(span, event, _id, payload)
+            span.name = span_name
+            span.service = configuration[:service_name]
+            span.resource = payload[:job].class.name
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+
+            set_common_tags(span, payload)
+          rescue StandardError => e
+            Datadog.logger.debug(e.message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_job/events/retry_stopped.rb

@@ -0,0 +1,46 @@
+# typed: false
+require 'ddtrace/ext/integration'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/active_job/ext'
+require 'ddtrace/contrib/active_job/event'
+
+module Datadog
+  module Contrib
+    module ActiveJob
+      module Events
+        # Defines instrumentation for enqueue.active_job event
+        module RetryStopped
+          include ActiveJob::Event
+
+          EVENT_NAME = 'retry_stopped.active_job'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_RETRY_STOPPED
+          end
+
+          def process(span, event, _id, payload)
+            span.name = span_name
+            span.service = configuration[:service_name]
+            span.resource = payload[:job].class.name
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+
+            set_common_tags(span, payload)
+            span.set_tag(Ext::TAG_JOB_ERROR, payload[:error])
+          rescue StandardError => e
+            Datadog.logger.debug(e.message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_job/events.rb

@@ -0,0 +1,39 @@
+# typed: false
+require 'ddtrace/contrib/active_job/events/discard'
+require 'ddtrace/contrib/active_job/events/enqueue'
+require 'ddtrace/contrib/active_job/events/enqueue_at'
+require 'ddtrace/contrib/active_job/events/enqueue_retry'
+require 'ddtrace/contrib/active_job/events/perform'
+require 'ddtrace/contrib/active_job/events/retry_stopped'
+
+module Datadog
+  module Contrib
+    module ActiveJob
+      # Defines collection of instrumented ActiveJob events
+      module Events
+        ALL = [
+          Events::Discard,
+          Events::Enqueue,
+          Events::EnqueueAt,
+          Events::EnqueueRetry,
+          Events::Perform,
+          Events::RetryStopped,
+        ].freeze
+
+        module_function
+
+        def all
+          self::ALL
+        end
+
+        def subscriptions
+          all.collect(&:subscriptions).collect(&:to_a).flatten
+        end
+
+        def subscribe!
+          all.each(&:subscribe!)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_job/ext.rb

@@ -0,0 +1,32 @@
+# typed: true
+module Datadog
+  module Contrib
+    module ActiveJob
+      module Ext
+        APP = 'active_job'.freeze
+        SERVICE_NAME = 'active_job'.freeze
+
+        ENV_ENABLED = 'DD_TRACE_ACTIVE_JOB_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_ACTIVE_JOB_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ACTIVE_JOB_ANALYTICS_SAMPLE_RATE'.freeze
+
+        SPAN_DISCARD = 'active_job.discard'.freeze
+        SPAN_ENQUEUE = 'active_job.enqueue'.freeze
+        SPAN_ENQUEUE_RETRY = 'active_job.enqueue_retry'.freeze
+        SPAN_PERFORM = 'active_job.perform'.freeze
+        SPAN_RETRY_STOPPED = 'active_job.retry_stopped'.freeze
+
+        TAG_ADAPTER = 'active_job.adapter'.freeze
+        TAG_JOB_ERROR = 'active_job.job.error'.freeze
+        TAG_JOB_EXECUTIONS = 'active_job.job.executions'.freeze
+        TAG_JOB_ID = 'active_job.job.id'.freeze
+        TAG_JOB_PRIORITY = 'active_job.job.priority'.freeze
+        TAG_JOB_QUEUE = 'active_job.job.queue'.freeze
+        TAG_JOB_RETRY_WAIT = 'active_job.job.retry_wait'.freeze
+        TAG_JOB_SCHEDULED_AT = 'active_job.job.scheduled_at'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_job/integration.rb

@@ -0,0 +1,46 @@
+# typed: false
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/active_job/configuration/settings'
+require 'ddtrace/contrib/active_job/patcher'
+require 'ddtrace/contrib/rails/utils'
+
+module Datadog
+  module Contrib
+    module ActiveJob
+      # Describes the ActiveJob integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('4.2')
+
+        register_as :active_job, auto_patch: false
+
+        def self.version
+          Gem.loaded_specs['activejob'] && Gem.loaded_specs['activejob'].version
+        end
+
+        def self.loaded?
+          !defined?(::ActiveJob).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
+        end
+
+        # enabled by rails integration so should only auto instrument
+        # if detected that it is being used without rails
+        def auto_instrument?
+          !Datadog::Contrib::Rails::Utils.railtie_supported?
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          ActiveJob::Patcher
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/active_job/log_injection.rb

@@ -0,0 +1,21 @@
+# typed: false
+module Datadog
+  module Contrib
+    module ActiveJob
+      # Active Job log injection wrapped around job execution
+      module LogInjection
+        def self.included(base)
+          base.class_eval do
+            around_perform do |_, block|
+              if logger.respond_to?(:tagged)
+                logger.tagged(Datadog.tracer.active_correlation.to_s, &block)
+              else
+                block.call
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end