ddtrace 0.42.0 → 0.54.2

data/lib/ddtrace/context_provider.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   # DefaultContextProvider is a default context provider that retrieves
   # all contexts from the current thread-local storage. It is suitable for
@@ -15,7 +16,18 @@ module Datadog
 
     # Return the local context.
     def context(key = nil)
-      key.nil? ? @context.local : @context.local(key)
+      current_context = key.nil? ? @context.local : @context.local(key)
+
+      # Rebuild/reset context after a fork
+      #
+      # We don't want forked processes to copy and retransmit spans
+      # that were generated from the parent process. Reset it such
+      # that it acts like a distributed trace.
+      current_context.after_fork! do
+        current_context = self.context = current_context.fork_clone
+      end
+
+      current_context
     end
   end
 
@@ -44,7 +56,6 @@ module Datadog
 
     # Return the thread-local context.
     def local(thread = Thread.current)
-      raise ArgumentError, '\'thread\' must be a Thread.' unless thread.is_a?(Thread)
       thread[@key] ||= Datadog::Context.new
     end
   end

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

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

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/active_support/notifications/event'
 require 'ddtrace/contrib/action_cable/ext'
@@ -8,8 +9,8 @@ module Datadog
       # Defines basic behaviors for an event.
       module Event
         def self.included(base)
-          base.send(:include, ActiveSupport::Notifications::Event)
-          base.send(:extend, ClassMethods)
+          base.include(ActiveSupport::Notifications::Event)
+          base.extend(ClassMethods)
         end
 
         # Class methods for events.
@@ -34,8 +35,8 @@ module Datadog
       # but to start a fresh tracing context.
       module RootContextEvent
         def self.included(base)
-          base.send(:include, ActiveSupport::Notifications::Event)
-          base.send(:extend, ClassMethods)
+          base.include(ActiveSupport::Notifications::Event)
+          base.extend(ClassMethods)
         end
 
         # Class methods for events.
@@ -56,6 +57,7 @@ module Datadog
           # preventing such a leak.
           def ensure_clean_context!
             return unless configuration[:tracer].call_context.current_span
+
             configuration[:tracer].provider.context = Context.new
           end
         end

data/lib/ddtrace/contrib/action_cable/events/broadcast.rb

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

data/lib/ddtrace/contrib/action_cable/events/perform_action.rb

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

data/lib/ddtrace/contrib/action_cable/events/transmit.rb

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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/action_cable/event'
 require 'ddtrace/contrib/action_cable/events/broadcast'
 require 'ddtrace/contrib/action_cable/events/perform_action'

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

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

data/lib/ddtrace/contrib/action_cable/instrumentation.rb

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Contrib
     module ActionCable
@@ -25,6 +26,52 @@ module Datadog
             end
           end
         end
+
+        # Instrumentation for when a Channel is subscribed to/unsubscribed from.
+        module ActionCableChannel
+          def self.included(base)
+            base.class_eval do
+              set_callback(
+                :subscribe,
+                :around,
+                ->(channel, block) { Tracer.trace(channel, :subscribe, &block) },
+                prepend: true
+              )
+
+              set_callback(
+                :unsubscribe,
+                :around,
+                ->(channel, block) { Tracer.trace(channel, :unsubscribe, &block) },
+                prepend: true
+              )
+            end
+          end
+
+          # Instrumentation for Channel hooks.
+          class Tracer
+            def self.trace(channel, hook)
+              configuration = Datadog.configuration[:action_cable]
+
+              Datadog.tracer.trace("action_cable.#{hook}") do |span|
+                span.service = configuration[:service_name]
+                span.resource = "#{channel.class}##{hook}"
+                span.span_type = Datadog::Ext::AppTypes::WEB
+
+                # 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)
+
+                span.set_tag(Ext::TAG_CHANNEL_CLASS, channel.class.to_s)
+
+                yield
+              end
+            end
+          end
+        end
       end
     end
   end

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

@@ -1,6 +1,8 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/action_cable/configuration/settings'
 require 'ddtrace/contrib/action_cable/patcher'
+require 'ddtrace/contrib/rails/utils'
 
 module Datadog
   module Contrib
@@ -25,6 +27,12 @@ module Datadog
           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

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/action_cable/ext'
@@ -20,6 +21,7 @@ module Datadog
         def patch
           Events.subscribe!
           ::ActionCable::Connection::Base.prepend(Instrumentation::ActionCableConnection)
+          ::ActionCable::Channel::Base.include(Instrumentation::ActionCableChannel)
         end
       end
     end

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,21 +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
-              if span.resource == span.name
-                span.resource = "#{payload.fetch(:controller)}##{payload.fetch(:action)}"
-              end
-
-              # 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)
@@ -63,7 +62,7 @@ module Datadog
                 # [christian] in some cases :status is not defined,
                 # rather than firing an error, simply acknowledge we don't know it.
                 status = payload.fetch(:status, '?').to_s
-                span.status = 1 if status.starts_with?('5')
+                span.status = 1 if status.start_with?('5')
               elsif Utils.exception_is_error?(exception)
                 span.set_error(exception)
               end
@@ -94,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)
@@ -113,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'
 
@@ -16,7 +17,7 @@ module Datadog
           end
 
           def patch
-            ::ActionController::Metal.send(:prepend, ActionController::Instrumentation::Metal)
+            ::ActionController::Metal.prepend(ActionController::Instrumentation::Metal)
           end
         end
       end

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,6 +1,8 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/action_pack/configuration/settings'
 require 'ddtrace/contrib/action_pack/patcher'
+require 'ddtrace/contrib/rails/utils'
 
 module Datadog
   module Contrib
@@ -25,6 +27,12 @@ module Datadog
           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

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
@@ -11,7 +12,7 @@ module Datadog
             # You can add custom errors via `config.action_dispatch.rescue_responses`
             status = ::ActionDispatch::ExceptionWrapper.status_code_for_exception(exception.class.name)
             # Only 5XX exceptions are actually errors (e.g. don't flag 404s)
-            status.to_s.starts_with?('5')
+            status.to_s.start_with?('5')
           else
             true
           end

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'