ddtrace 0.54.0 → 1.0.0

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

@@ -1,51 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/action_cable/event'
-
-module Datadog
-  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
-            Datadog::Ext::AppTypes::WEB
-          end
-
-          def process(span, _event, _id, payload)
-            channel_class = payload[:channel_class]
-
-            span.service = 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])
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,34 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/action_cable/event'
-require 'ddtrace/contrib/action_cable/events/broadcast'
-require 'ddtrace/contrib/action_cable/events/perform_action'
-require 'ddtrace/contrib/action_cable/events/transmit'
-
-module Datadog
-  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

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

@@ -1,27 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module ActionCable
-      # ActionCable integration constants
-      module Ext
-        APP = 'action_cable'.freeze
-        ENV_ENABLED = 'DD_TRACE_ACTION_CABLE_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_CABLE_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_ACTION_CABLE_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_CABLE_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ACTION_CABLE_ANALYTICS_SAMPLE_RATE'.freeze
-        SERVICE_NAME = 'action_cable'.freeze
-        SPAN_ACTION = 'action_cable.action'.freeze
-        SPAN_BROADCAST = 'action_cable.broadcast'.freeze
-        SPAN_ON_OPEN = 'action_cable.on_open'.freeze
-        SPAN_TRANSMIT = 'action_cable.transmit'.freeze
-        TAG_ACTION = 'action_cable.action'.freeze
-        TAG_BROADCAST_CODER = 'action_cable.broadcast.coder'.freeze
-        TAG_CHANNEL = 'action_cable.channel'.freeze
-        TAG_CHANNEL_CLASS = 'action_cable.channel_class'.freeze
-        TAG_CONNECTION = 'action_cable.connection'.freeze
-        TAG_TRANSMIT_VIA = 'action_cable.transmit.via'.freeze
-      end
-    end
-  end
-end

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

@@ -1,78 +0,0 @@
-# typed: false
-module Datadog
-  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
-            Datadog.tracer.trace(Ext::SPAN_ON_OPEN) do |span|
-              begin
-                span.resource = "#{self.class}#on_open"
-                span.span_type = Datadog::Ext::AppTypes::WEB
-
-                span.set_tag(Ext::TAG_ACTION, 'on_open')
-                span.set_tag(Ext::TAG_CONNECTION, self.class.to_s)
-
-                # Set the resource name of the Rack request span
-                rack_request_span = env[Datadog::Contrib::Rack::TraceMiddleware::RACK_REQUEST_SPAN]
-                rack_request_span.resource = span.resource if rack_request_span
-              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[: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
-end

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

@@ -1,46 +0,0 @@
-# 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
-    module ActionCable
-      # Description of ActionCable integration
-      class Integration
-        include Contrib::Integration
-
-        MINIMUM_VERSION = Gem::Version.new('5.0.0')
-
-        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?
-          !Datadog::Contrib::Rails::Utils.railtie_supported?
-        end
-
-        def default_configuration
-          Configuration::Settings.new
-        end
-
-        def patcher
-          Patcher
-        end
-      end
-    end
-  end
-end

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

@@ -1,29 +0,0 @@
-# typed: true
-require 'ddtrace/contrib/patcher'
-require 'ddtrace/ext/app_types'
-require 'ddtrace/contrib/action_cable/ext'
-require 'ddtrace/contrib/action_cable/events'
-require 'ddtrace/contrib/action_cable/instrumentation'
-
-module Datadog
-  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

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

@@ -1,32 +0,0 @@
-# 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

@@ -1,50 +0,0 @@
-# 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

@@ -1,54 +0,0 @@
-# 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

@@ -1,41 +0,0 @@
-# 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

@@ -1,31 +0,0 @@
-# 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

@@ -1,32 +0,0 @@
-# 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

@@ -1,45 +0,0 @@
-# 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

@@ -1,27 +0,0 @@
-# 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