ddtrace 0.52.0 → 1.8.0

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

@@ -1,67 +0,0 @@
-# typed: true
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/active_support/notifications/event'
-require 'ddtrace/contrib/action_cable/ext'
-
-module Datadog
-  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
-            { service: configuration[:service_name] }
-          end
-
-          def tracer
-            -> { configuration[:tracer] }
-          end
-
-          def configuration
-            Datadog.configuration[: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 configuration[:tracer].call_context.current_span
-
-            configuration[:tracer].provider.context = Context.new
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,50 +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 '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
-            Datadog::Ext::AppTypes::WEB
-          end
-
-          def process(span, _event, _id, payload)
-            channel = payload[:broadcasting] # Channel has high cardinality
-            span.service = 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])
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,56 +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 '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
-            Datadog::Ext::AppTypes::WEB
-          end
-
-          def process(span, _event, _id, payload)
-            channel_class = payload[:channel_class]
-            action = payload[:action]
-
-            span.service = 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)
-          end
-        end
-      end
-    end
-  end
-end

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,32 +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
-      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,28 +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)
-        end
-      end
-    end
-  end
-end

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

@@ -1,157 +0,0 @@
-# typed: false
-require 'ddtrace/ext/http'
-
-require 'ddtrace/contrib/action_pack/ext'
-require 'ddtrace/contrib/action_pack/utils'
-require 'ddtrace/contrib/rack/middlewares'
-require 'ddtrace/contrib/analytics'
-
-module Datadog
-  module Contrib
-    module ActionPack
-      module ActionController
-        # Instrumentation for ActionController components
-        module Instrumentation
-          module_function
-
-          def start_processing(payload)
-            # trace the execution
-            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,
-              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
-
-          def finish_processing(payload)
-            # retrieve the tracing context and the latest active span
-            tracing_context = payload.fetch(:tracing_context)
-            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
-              try_setting_rack_request_resource(payload, span.resource)
-
-              # Set analytics sample rate
-              Utils.set_analytics_sample_rate(span)
-
-              # Measure service stats
-              Contrib::Analytics.set_measured(span)
-
-              # Associate with runtime metrics
-              Datadog.runtime_metrics.associate_with_span(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[: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
-
-          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)
-              # 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

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

@@ -1,26 +0,0 @@
-# typed: true
-require 'ddtrace/contrib/patcher'
-require 'ddtrace/contrib/action_pack/action_controller/instrumentation'
-
-module Datadog
-  module Contrib
-    module ActionPack
-      module ActionController
-        # Patcher for ActionController components
-        module Patcher
-          include Contrib::Patcher
-
-          module_function
-
-          def target_version
-            Integration.version
-          end
-
-          def patch
-            ::ActionController::Metal.prepend(ActionController::Instrumentation::Metal)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/configuration/settings'
-require 'ddtrace/contrib/action_pack/ext'
-
-module Datadog
-  module Contrib
-    module ActionPack
-      module Configuration
-        # Custom settings for the ActionPack 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], nil) }
-            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 :controller_service
-          option :exception_controller
-          option :service_name, default: Ext::SERVICE_NAME
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module ActionPack
-      # ActionPack integration constants
-      module Ext
-        APP = 'action_pack'.freeze
-        ENV_ENABLED = 'DD_TRACE_ACTION_PACK_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_PACK_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_ACTION_PACK_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_PACK_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ACTION_PACK_ANALYTICS_SAMPLE_RATE'.freeze
-        SERVICE_NAME = 'action_pack'.freeze
-        SPAN_ACTION_CONTROLLER = 'rails.action_controller'.freeze
-        TAG_ROUTE_ACTION = 'rails.route.action'.freeze
-        TAG_ROUTE_CONTROLLER = 'rails.route.controller'.freeze
-      end
-    end
-  end
-end

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

@@ -1,46 +0,0 @@
-# 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
-    module ActionPack
-      # Describes the ActionPack integration
-      class Integration
-        include Contrib::Integration
-
-        MINIMUM_VERSION = Gem::Version.new('3.0')
-
-        register_as :action_pack, auto_patch: false
-
-        def self.version
-          Gem.loaded_specs['actionpack'] && Gem.loaded_specs['actionpack'].version
-        end
-
-        def self.loaded?
-          !defined?(::ActionPack).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
-          ActionPack::Patcher
-        end
-      end
-    end
-  end
-end