ddtrace 0.50.0 → 1.0.0

data/lib/datadog/tracing/contrib/action_cable/instrumentation.rb

@@ -0,0 +1,91 @@
+# typed: false
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/action_cable/ext'
+require 'datadog/tracing/contrib/analytics'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionCable
+        module Instrumentation
+          # When a new WebSocket is open, we receive a Rack request resource name "GET -1".
+          # This module overrides the current Rack resource name to provide a meaningful name.
+          module ActionCableConnection
+            def on_open
+              Tracing.trace(Ext::SPAN_ON_OPEN) do |span, trace|
+                begin
+                  span.resource = "#{self.class}#on_open"
+                  span.span_type = Tracing::Metadata::Ext::AppTypes::TYPE_WEB
+
+                  span.set_tag(Ext::TAG_ACTION, 'on_open')
+                  span.set_tag(Ext::TAG_CONNECTION, self.class.to_s)
+
+                  span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                  span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ON_OPEN)
+
+                  # Set the resource name of the trace
+                  trace.resource = span.resource
+                rescue StandardError => e
+                  Datadog.logger.error("Error preparing span for ActionCable::Connection: #{e}")
+                end
+
+                super
+              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.tracing[:action_cable]
+
+                Tracing.trace("action_cable.#{hook}") do |span|
+                  span.service = configuration[:service_name] if configuration[:service_name]
+                  span.resource = "#{channel.class}##{hook}"
+                  span.span_type = Tracing::Metadata::Ext::AppTypes::TYPE_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)
+
+                  span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                  span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, hook)
+
+                  yield
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# typed: false
+
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/action_cable/configuration/settings'
+require 'datadog/tracing/contrib/action_cable/patcher'
+require 'datadog/tracing/contrib/rails/utils'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionCable
+        # Description of ActionCable integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('5.0.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :action_cable, auto_patch: false
+
+          def self.version
+            Gem.loaded_specs['actioncable'] && Gem.loaded_specs['actioncable'].version
+          end
+
+          def self.loaded?
+            !defined?(::ActionCable).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?
+            !Contrib::Rails::Utils.railtie_supported?
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_cable/patcher.rb

@@ -0,0 +1,31 @@
+# typed: true
+
+require 'datadog/tracing/contrib/patcher'
+require 'datadog/tracing/contrib/action_cable/ext'
+require 'datadog/tracing/contrib/action_cable/events'
+require 'datadog/tracing/contrib/action_cable/instrumentation'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionCable
+        # Patcher enables patching of 'action_cable' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            Events.subscribe!
+            ::ActionCable::Connection::Base.prepend(Instrumentation::ActionCableConnection)
+            ::ActionCable::Channel::Base.include(Instrumentation::ActionCableChannel)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# typed: false
+
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/action_mailer/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionMailer
+        module Configuration
+          # Custom settings for the ActionMailer integration
+          # @public_api
+          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, false) }
+              o.lazy
+            end
+
+            option :analytics_sample_rate do |o|
+              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+              o.lazy
+            end
+
+            option :service_name
+            option :email_data, default: false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_mailer/event.rb

@@ -0,0 +1,52 @@
+# typed: false
+
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/active_support/notifications/event'
+require 'datadog/tracing/contrib/action_mailer/ext'
+
+module Datadog
+  module Tracing
+    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
+              options = {}
+              options[:service] = configuration[:service_name] if configuration[:service_name]
+              options
+            end
+
+            def configuration
+              Datadog.configuration.tracing[:action_mailer]
+            end
+
+            def process(span, event, _id, payload)
+              span.service = configuration[:service_name] if configuration[:service_name]
+              span.resource = payload[:mailer]
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+
+              # 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
+end

data/lib/datadog/tracing/contrib/action_mailer/events/deliver.rb

@@ -0,0 +1,60 @@
+# typed: false
+
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/action_mailer/ext'
+require 'datadog/tracing/contrib/action_mailer/event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionMailer
+        module Events
+          # Defines instrumentation for deliver.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
+              Tracing::Metadata::Ext::AppTypes::TYPE_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])
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_DELIVER)
+
+              # 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
+end

data/lib/datadog/tracing/contrib/action_mailer/events/process.rb

@@ -0,0 +1,47 @@
+# typed: false
+
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/action_mailer/ext'
+require 'datadog/tracing/contrib/action_mailer/event'
+
+module Datadog
+  module Tracing
+    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
+              Tracing::Metadata::Ext::HTTP::TYPE_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])
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_PROCESS)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_mailer/events.rb

@@ -0,0 +1,34 @@
+# typed: false
+
+require 'datadog/tracing/contrib/action_mailer/events/process'
+require 'datadog/tracing/contrib/action_mailer/events/deliver'
+
+module Datadog
+  module Tracing
+    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
+end

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

@@ -0,0 +1,33 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionMailer
+        # ActionMailer integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          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
+          SPAN_PROCESS = 'action_mailer.process'.freeze
+          SPAN_DELIVER = 'action_mailer.deliver'.freeze
+          TAG_COMPONENT = 'action_mailer'.freeze
+          TAG_ACTION = 'action_mailer.action'.freeze
+          TAG_MAILER = 'action_mailer.mailer'.freeze
+          TAG_MSG_ID = 'action_mailer.message_id'.freeze
+          TAG_OPERATION_DELIVER = 'deliver'.freeze
+          TAG_OPERATION_PROCESS = 'process'.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
+end

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

@@ -0,0 +1,50 @@
+# typed: false
+
+require 'datadog/tracing/contrib/action_mailer/configuration/settings'
+require 'datadog/tracing/contrib/action_mailer/patcher'
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/rails/utils'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionMailer
+        # Description of ActionMailer integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('5.0.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          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?
+            !Contrib::Rails::Utils.railtie_supported?
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            ActionMailer::Patcher
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_mailer/patcher.rb

@@ -0,0 +1,29 @@
+# typed: true
+
+require 'datadog/tracing/contrib/patcher'
+require 'datadog/tracing/contrib/action_mailer/ext'
+require 'datadog/tracing/contrib/action_mailer/events'
+
+module Datadog
+  module Tracing
+    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
+end

data/lib/datadog/tracing/contrib/action_pack/action_controller/instrumentation.rb

@@ -0,0 +1,156 @@
+# typed: false
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+
+require 'datadog/tracing/contrib/action_pack/ext'
+require 'datadog/tracing/contrib/action_pack/utils'
+require 'datadog/tracing/contrib/rack/middlewares'
+require 'datadog/tracing/contrib/analytics'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionPack
+        module ActionController
+          # Instrumentation for ActionController components
+          module Instrumentation
+            module_function
+
+            def start_processing(payload)
+              # trace the execution
+              service = Datadog.configuration.tracing[:action_pack][:service_name]
+              type = Tracing::Metadata::Ext::HTTP::TYPE_INBOUND
+              span = Tracing.trace(
+                Ext::SPAN_ACTION_CONTROLLER,
+                service: service,
+                span_type: type,
+                resource: "#{payload.fetch(:controller)}##{payload.fetch(:action)}",
+              )
+              trace = Tracing.active_trace
+
+              # attach the current span to the tracing context
+              tracing_context = payload.fetch(:tracing_context)
+              tracing_context[:dd_request_trace] = trace
+              tracing_context[:dd_request_span] = span
+
+              # We want the route to show up as the trace's resource
+              trace.resource = span.resource
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_CONTROLLER)
+            rescue StandardError => e
+              Datadog.logger.error(e.message)
+            end
+
+            def finish_processing(payload)
+              # retrieve the tracing context and the latest active span
+              tracing_context = payload.fetch(:tracing_context)
+              trace = tracing_context[:dd_request_trace]
+              span = tracing_context[:dd_request_span]
+              return unless span && !span.finished?
+
+              begin
+                # We repeat this in both start and at finish because the resource may have changed during the request
+                trace.resource = span.resource
+
+                # Set analytics sample rate
+                Utils.set_analytics_sample_rate(span)
+
+                # Measure service stats
+                Contrib::Analytics.set_measured(span)
+
+                span.set_tag(Ext::TAG_ROUTE_ACTION, payload.fetch(:action))
+                span.set_tag(Ext::TAG_ROUTE_CONTROLLER, payload.fetch(:controller))
+
+                exception = payload[:exception_object]
+                if exception.nil?
+                  # [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.start_with?('5')
+                elsif Utils.exception_is_error?(exception)
+                  span.set_error(exception)
+                end
+              ensure
+                span.finish
+              end
+            rescue StandardError => e
+              Datadog.logger.error(e.message)
+            end
+
+            def exception_controller?(payload)
+              exception_controller_class = Datadog.configuration.tracing[:action_pack][:exception_controller]
+              controller = payload.fetch(:controller)
+              headers = payload.fetch(:headers)
+
+              # If no exception controller class has been set,
+              # guess whether this is an exception controller from the headers.
+              if exception_controller_class.nil?
+                !headers[:request_exception].nil?
+              # If an exception controller class has been specified,
+              # check if the controller is a kind of the exception controller class.
+              elsif exception_controller_class.is_a?(Class) || exception_controller_class.is_a?(Module)
+                controller <= exception_controller_class
+              # Otherwise if the exception controller class is some other value (like false)
+              # assume that this controller doesn't handle exceptions.
+              else
+                false
+              end
+            end
+
+            # Instrumentation for ActionController::Metal
+            module Metal
+              def process_action(*args)
+                # mutable payload with a tracing context that is used in two different
+                # signals; it propagates the request span so that it can be finished
+                # no matter what
+                payload = {
+                  controller: self.class,
+                  action: action_name,
+                  env: request.env,
+                  headers: {
+                    # The exception this controller was given in the request,
+                    # which is typical if the controller is configured to handle exceptions.
+                    request_exception: request.headers['action_dispatch.exception']
+                  },
+                  tracing_context: {}
+                }
+
+                begin
+                  payload[:exception_controller?] = Instrumentation.exception_controller?(payload)
+
+                  # process and catch request exceptions
+                  Instrumentation.start_processing(payload)
+                  result = super(*args)
+                  status = datadog_response_status
+                  payload[:status] = status unless status.nil?
+                  result
+                # rubocop:disable Lint/RescueException
+                rescue Exception => e
+                  payload[:exception] = [e.class.name, e.message]
+                  payload[:exception_object] = e
+                  raise e
+                end
+              # rubocop:enable Lint/RescueException
+              ensure
+                Instrumentation.finish_processing(payload)
+              end
+
+              def datadog_response_status
+                case response
+                when ::ActionDispatch::Response
+                  response.status
+                when Array
+                  # Likely a Rack response array: first element is the status.
+                  status = response.first
+                  status.class <= Integer ? status : nil
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end