ddtrace 0.51.1 → 0.54.2

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

@@ -0,0 +1,32 @@
+# typed: false
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/action_mailer/ext'
+
+module Datadog
+  module Contrib
+    module ActionMailer
+      module Configuration
+        # Custom settings for the ActionMailer 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 :email_data, default: false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# typed: false
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/active_support/notifications/event'
+require 'ddtrace/contrib/action_mailer/ext'
+
+module Datadog
+  module Contrib
+    module ActionMailer
+      # Defines basic behaviors for an ActionMailer event.
+      module Event
+        def self.included(base)
+          base.send(:include, ActiveSupport::Notifications::Event)
+          base.send(:extend, ClassMethods)
+        end
+
+        # Class methods for ActionMailer events.
+        module ClassMethods
+          def span_options
+            { service: configuration[:service_name] }
+          end
+
+          def tracer
+            -> { configuration[:tracer] }
+          end
+
+          def configuration
+            Datadog.configuration[:action_mailer]
+          end
+
+          def process(span, event, _id, payload)
+            span.service = configuration[:service_name]
+            span.resource = payload[:mailer]
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+
+            # Measure service stats
+            Contrib::Analytics.set_measured(span)
+
+            report_if_exception(span, payload)
+          rescue StandardError => e
+            Datadog.logger.debug(e.message)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# 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 Deliver
+          include ActionMailer::Event
+
+          EVENT_NAME = 'deliver.action_mailer'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_DELIVER
+          end
+
+          def span_type
+            # deliver.action_mailer sends emails
+            Datadog::Ext::AppTypes::WORKER
+          end
+
+          def process(span, event, _id, payload)
+            super
+
+            span.span_type = span_type
+            span.set_tag(Ext::TAG_MAILER, payload[:mailer])
+            span.set_tag(Ext::TAG_MSG_ID, payload[:message_id])
+
+            # Since email date can contain PII we disable by default
+            # Some of these fields can be either strings or arrays, so we try to normalize
+            # https://github.com/rails/rails/blob/18707ab17fa492eb25ad2e8f9818a320dc20b823/actionmailer/lib/action_mailer/base.rb#L742-L754
+            if configuration[:email_data] == true
+              span.set_tag(Ext::TAG_SUBJECT, payload[:subject].to_s) if payload[:subject]
+              span.set_tag(Ext::TAG_TO, payload[:to].join(',')) if payload[:to]
+              span.set_tag(Ext::TAG_FROM, payload[:from].join(',')) if payload[:from]
+              span.set_tag(Ext::TAG_BCC, payload[:bcc].join(',')) if payload[:bcc]
+              span.set_tag(Ext::TAG_CC, payload[:cc].join(',')) if payload[:cc]
+              span.set_tag(Ext::TAG_DATE, payload[:date].to_s) if payload[:date]
+              span.set_tag(Ext::TAG_PERFORM_DELIVERIES, payload[:perform_deliveries]) if payload[:perform_deliveries]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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/action_pack/action_controller/instrumentation.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/http'
 
 require 'ddtrace/contrib/action_pack/ext'
@@ -18,11 +19,18 @@ module Datadog
             tracer = Datadog.configuration[:action_pack][:tracer]
             service = Datadog.configuration[:action_pack][:controller_service]
             type = Datadog::Ext::HTTP::TYPE_INBOUND
-            span = tracer.trace(Ext::SPAN_ACTION_CONTROLLER, service: service, span_type: type)
+            span = tracer.trace(
+              Ext::SPAN_ACTION_CONTROLLER,
+              service: service,
+              span_type: type,
+              resource: "#{payload.fetch(:controller)}##{payload.fetch(:action)}",
+            )
 
             # attach the current span to the tracing context
             tracing_context = payload.fetch(:tracing_context)
             tracing_context[:dd_request_span] = span
+
+            try_setting_rack_request_resource(payload, span.resource)
           rescue StandardError => e
             Datadog.logger.error(e.message)
           end
@@ -30,19 +38,12 @@ module Datadog
           def finish_processing(payload)
             # retrieve the tracing context and the latest active span
             tracing_context = payload.fetch(:tracing_context)
-            env = payload.fetch(:env)
             span = tracing_context[:dd_request_span]
             return unless span && !span.finished?
 
             begin
-              # Set the resource name, if it's still the default name
-              span.resource = "#{payload.fetch(:controller)}##{payload.fetch(:action)}" if span.resource == span.name
-
-              # Set the resource name of the Rack request span unless this is an exception controller.
-              unless exception_controller?(payload)
-                rack_request_span = env[Datadog::Contrib::Rack::TraceMiddleware::RACK_REQUEST_SPAN]
-                rack_request_span.resource = span.resource if rack_request_span
-              end
+              # We repeat this in both start and at finish because the resource may have changed during the request
+              try_setting_rack_request_resource(payload, span.resource)
 
               # Set analytics sample rate
               Utils.set_analytics_sample_rate(span)
@@ -92,6 +93,14 @@ module Datadog
             end
           end
 
+          def try_setting_rack_request_resource(payload, resource)
+            # Set the resource name of the Rack request span unless this is an exception controller.
+            unless payload.fetch(:exception_controller?)
+              rack_request_span = payload.fetch(:env)[Datadog::Contrib::Rack::TraceMiddleware::RACK_REQUEST_SPAN]
+              rack_request_span.resource = resource if rack_request_span
+            end
+          end
+
           # Instrumentation for ActionController::Metal
           module Metal
             def process_action(*args)
@@ -111,6 +120,8 @@ module Datadog
               }
 
               begin
+                payload[:exception_controller?] = Instrumentation.exception_controller?(payload)
+
                 # process and catch request exceptions
                 Instrumentation.start_processing(payload)
                 result = super(*args)

data/lib/ddtrace/contrib/action_pack/action_controller/patcher.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/action_pack/action_controller/instrumentation'
 

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/action_pack/ext'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module ActionPack

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/action_pack/configuration/settings'
 require 'ddtrace/contrib/action_pack/patcher'

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/action_pack/action_controller/patcher'
 

data/lib/ddtrace/contrib/action_pack/utils.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/analytics'
 
 module Datadog

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/action_view/ext'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/active_support/notifications/event'
 
 module Datadog

data/lib/ddtrace/contrib/action_view/events/render_partial.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/net'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/action_view/ext'

data/lib/ddtrace/contrib/action_view/events/render_template.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/net'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/action_view/ext'

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/action_view/events/render_partial'
 require 'ddtrace/contrib/action_view/events/render_template'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module ActionView

data/lib/ddtrace/contrib/action_view/instrumentation/partial_renderer.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/action_view/ext'
 
 module Datadog

data/lib/ddtrace/contrib/action_view/instrumentation/template_renderer.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/action_view/ext'
 
 module Datadog

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/action_view/configuration/settings'
 require 'ddtrace/contrib/action_view/patcher'

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/http'
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/action_view/events'

data/lib/ddtrace/contrib/action_view/utils.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/analytics'
 
 module Datadog

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