ddtrace 0.34.1 → 1.23.1

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative '../../context'
+require_relative '../analytics'
+require_relative '../active_support/notifications/event'
+require_relative 'ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionCable
+        # Defines basic behaviors for an event.
+        module Event
+          def self.included(base)
+            base.include(ActiveSupport::Notifications::Event)
+            base.extend(ClassMethods)
+          end
+
+          # Class methods for events.
+          module ClassMethods
+            def span_options
+              if configuration[:service_name]
+                { service: configuration[:service_name] }
+              else
+                {}
+              end
+            end
+
+            def configuration
+              Datadog.configuration.tracing[:action_cable]
+            end
+          end
+        end
+
+        # Defines behavior for the first event of a thread execution.
+        #
+        # This event is not expected to be nested with other event,
+        # but to start a fresh tracing context.
+        module RootContextEvent
+          def self.included(base)
+            base.include(ActiveSupport::Notifications::Event)
+            base.extend(ClassMethods)
+          end
+
+          # Class methods for events.
+          module ClassMethods
+            include Contrib::ActionCable::Event::ClassMethods
+
+            def subscription(*args)
+              super.tap do |subscription|
+                subscription.before_trace { ensure_clean_context! }
+              end
+            end
+
+            private
+
+            # Context objects are thread-bound.
+            # If an integration re-uses threads, context from a previous trace
+            # could leak into the new trace. This "cleans" current context,
+            # preventing such a leak.
+            def ensure_clean_context!
+              return unless Tracing.active_span
+
+              Tracing.send(:tracer).provider.context = Tracing::Context.new
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_cable/events/broadcast.rb

@@ -0,0 +1,56 @@
+require_relative '../../../metadata/ext'
+require_relative '../event'
+require_relative '../ext'
+require_relative '../../analytics'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionCable
+        module Events
+          # Defines instrumentation for 'broadcast.action_cable' event.
+          #
+          # A single 'broadcast' event will trigger as many 'transmit' events
+          # as there are clients subscribed to a channel.
+          module Broadcast
+            include ActionCable::Event
+
+            EVENT_NAME = 'broadcast.action_cable'.freeze
+
+            module_function
+
+            def event_name
+              self::EVENT_NAME
+            end
+
+            def span_name
+              Ext::SPAN_BROADCAST
+            end
+
+            def span_type
+              # Starts a broadcast of messages over WebSockets
+              Tracing::Metadata::Ext::AppTypes::TYPE_WEB
+            end
+
+            def process(span, _event, _id, payload)
+              channel = payload[:broadcasting] # Channel has high cardinality
+              span.service = configuration[:service_name] if configuration[:service_name]
+              span.span_type = span_type
+
+              # Set analytics sample rate
+              if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+                Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+              end
+
+              span.set_tag(Ext::TAG_CHANNEL, channel)
+              span.set_tag(Ext::TAG_BROADCAST_CODER, payload[:coder])
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_BROADCAST)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_cable/events/perform_action.rb

@@ -0,0 +1,61 @@
+require_relative '../../../metadata/ext'
+require_relative '../../analytics'
+require_relative '../event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionCable
+        module Events
+          # Defines instrumentation for 'perform_action.action_cable' event.
+          #
+          # An action, triggered by a WebSockets client, invokes a method
+          # in the server's channel instance.
+          module PerformAction
+            include ActionCable::RootContextEvent
+
+            EVENT_NAME = 'perform_action.action_cable'.freeze
+
+            module_function
+
+            def event_name
+              self::EVENT_NAME
+            end
+
+            def span_name
+              Ext::SPAN_ACTION
+            end
+
+            def span_type
+              # A request to perform_action comes from a WebSocket connection
+              Tracing::Metadata::Ext::AppTypes::TYPE_WEB
+            end
+
+            def process(span, _event, _id, payload)
+              channel_class = payload[:channel_class]
+              action = payload[:action]
+
+              span.service = configuration[:service_name] if configuration[:service_name]
+              span.resource = "#{channel_class}##{action}"
+              span.span_type = span_type
+
+              # 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)
+              span.set_tag(Ext::TAG_ACTION, action)
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ACTION)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_cable/events/transmit.rb

@@ -0,0 +1,57 @@
+require_relative '../../../metadata/ext'
+require_relative '../event'
+require_relative '../ext'
+require_relative '../../analytics'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionCable
+        module Events
+          # Defines instrumentation for 'transmit.action_cable' event.
+          #
+          # A 'transmit' event sends a message to a single client subscribed to a channel.
+          module Transmit
+            include ActionCable::Event
+
+            EVENT_NAME = 'transmit.action_cable'.freeze
+
+            module_function
+
+            def event_name
+              self::EVENT_NAME
+            end
+
+            def span_name
+              Ext::SPAN_TRANSMIT
+            end
+
+            def span_type
+              # ActionCable transmits data over WebSockets
+              Tracing::Metadata::Ext::AppTypes::TYPE_WEB
+            end
+
+            def process(span, _event, _id, payload)
+              channel_class = payload[:channel_class]
+
+              span.service = configuration[:service_name] if configuration[:service_name]
+              span.resource = channel_class
+              span.span_type = span_type
+
+              # Set analytics sample rate
+              if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+                Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+              end
+
+              span.set_tag(Ext::TAG_CHANNEL_CLASS, channel_class)
+              span.set_tag(Ext::TAG_TRANSMIT_VIA, payload[:via])
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_TRANSMIT)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'event'
+require_relative 'events/broadcast'
+require_relative 'events/perform_action'
+require_relative 'events/transmit'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionCable
+        # Defines collection of instrumented ActionCable events
+        module Events
+          ALL = [
+            Events::Broadcast,
+            Events::PerformAction,
+            Events::Transmit
+          ].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_cable/ext.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionCable
+        # ActionCable integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_ACTION_CABLE_ENABLED'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_CABLE_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_CABLE_ANALYTICS_SAMPLE_RATE'
+          SPAN_ACTION = 'action_cable.action'
+          SPAN_BROADCAST = 'action_cable.broadcast'
+          SPAN_ON_OPEN = 'action_cable.on_open'
+          SPAN_TRANSMIT = 'action_cable.transmit'
+          TAG_ACTION = 'action_cable.action'
+          TAG_BROADCAST_CODER = 'action_cable.broadcast.coder'
+          TAG_CHANNEL = 'action_cable.channel'
+          TAG_CHANNEL_CLASS = 'action_cable.channel_class'
+          TAG_COMPONENT = 'action_cable'
+          TAG_CONNECTION = 'action_cable.connection'
+          TAG_OPERATION_ACTION = 'action'
+          TAG_OPERATION_BROADCAST = 'broadcast'
+          TAG_OPERATION_ON_OPEN = 'on_open'
+          TAG_OPERATION_TRANSMIT = 'transmit'
+          TAG_TRANSMIT_VIA = 'action_cable.transmit.via'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+require_relative '../../metadata/ext'
+require_relative 'ext'
+require_relative '../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,48 @@
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+require_relative '../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 @@
+# frozen_string_literal: true
+
+require_relative '../patcher'
+require_relative 'ext'
+require_relative 'events'
+require_relative '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,40 @@
+# frozen_string_literal: true
+
+require_relative '../../configuration/settings'
+require_relative '../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.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
+            option :email_data, default: false
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../analytics'
+require_relative '../active_support/notifications/event'
+require_relative '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,58 @@
+require_relative '../../../metadata/ext'
+require_relative '../ext'
+require_relative '../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 data 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,45 @@
+require_relative '../../../metadata/ext'
+require_relative '../ext'
+require_relative '../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