ddtrace 0.54.0 → 1.1.0

data/lib/ddtrace/contrib/action_view/instrumentation/template_renderer.rb

@@ -1,168 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/action_view/ext'
-
-module Datadog
-  module Contrib
-    module ActionView
-      module Instrumentation
-        # Legacy instrumentation for template rendering for Rails < 4
-        module TemplateRenderer
-          # Legacy Rails < 3.1 template rendering
-          module Rails30
-            # rubocop:disable Metrics/MethodLength
-            def self.prepended(base)
-              # rubocop:disable Metrics/BlockLength
-              base.class_eval do
-                def render_with_datadog(*args, &block)
-                  # NOTE: This check exists purely for Rails 3.0 compatibility.
-                  #       The 'if' part can be removed when support for Rails 3.0 is removed.
-                  if active_datadog_span
-                    render_without_datadog(*args, &block)
-                  else
-                    datadog_tracer.trace(
-                      Ext::SPAN_RENDER_TEMPLATE,
-                      span_type: Datadog::Ext::HTTP::TEMPLATE
-                    ) do |span|
-                      with_datadog_span(span) { render_without_datadog(*args, &block) }
-                    end
-                  end
-                end
-
-                def render_template_with_datadog(*args)
-                  begin
-                    template = args[0]
-                    layout_name = args[1]
-
-                    # update the tracing context with computed values before the rendering
-                    template_name = template.try('identifier')
-                    template_name = Utils.normalize_template_name(template_name)
-
-                    if template_name
-                      active_datadog_span.resource = template_name
-                      active_datadog_span.set_tag(
-                        Ext::TAG_TEMPLATE_NAME,
-                        template_name
-                      )
-                    end
-
-                    if layout_name
-                      active_datadog_span.set_tag(
-                        Ext::TAG_LAYOUT,
-                        layout_name
-                      )
-                    end
-
-                    # Measure service stats
-                    Contrib::Analytics.set_measured(active_datadog_span)
-                  rescue StandardError => e
-                    Datadog.logger.debug(e.message)
-                  end
-
-                  # execute the original function anyway
-                  render_template_without_datadog(*args)
-                end
-
-                private
-
-                attr_accessor :active_datadog_span
-
-                def datadog_tracer
-                  Datadog.configuration[:action_view][:tracer]
-                end
-
-                def with_datadog_span(span)
-                  self.active_datadog_span = span
-                  yield
-                ensure
-                  self.active_datadog_span = nil
-                end
-
-                # method aliasing to patch the class
-                alias_method :render_without_datadog, :render
-                alias_method :render, :render_with_datadog
-
-                alias_method :render_template_without_datadog, :_render_template
-                alias_method :_render_template, :render_template_with_datadog
-              end
-            end
-          end
-
-          # Legacy shared code for Rails >= 3.1 template rendering
-          module Rails31Plus
-            def render(*args, &block)
-              datadog_tracer.trace(
-                Ext::SPAN_RENDER_TEMPLATE,
-                span_type: Datadog::Ext::HTTP::TEMPLATE
-              ) do |span|
-                with_datadog_span(span) { super(*args, &block) }
-              end
-            end
-
-            def render_template(*args)
-              begin
-                template, layout_name = datadog_parse_args(*args)
-
-                datadog_render_template(template, layout_name)
-              rescue StandardError => e
-                Datadog.logger.debug(e.message)
-              end
-
-              # execute the original function anyway
-              super(*args)
-            end
-
-            def datadog_render_template(template, layout_name)
-              # update the tracing context with computed values before the rendering
-              template_name = template.try('identifier')
-              template_name = Utils.normalize_template_name(template_name)
-              layout = layout_name.try(:[], 'virtual_path') # Proc can be called without parameters since Rails 6
-
-              if template_name
-                active_datadog_span.resource = template_name
-                active_datadog_span.set_tag(
-                  Ext::TAG_TEMPLATE_NAME,
-                  template_name
-                )
-              end
-
-              if layout
-                active_datadog_span.set_tag(
-                  Ext::TAG_LAYOUT,
-                  layout
-                )
-              end
-
-              # Measure service stats
-              Contrib::Analytics.set_measured(active_datadog_span)
-            end
-
-            private
-
-            attr_accessor :active_datadog_span
-
-            def datadog_tracer
-              Datadog.configuration[:action_view][:tracer]
-            end
-
-            def with_datadog_span(span)
-              self.active_datadog_span = span
-              yield
-            ensure
-              self.active_datadog_span = nil
-            end
-          end
-
-          # Rails >= 3.1, < 4 template rendering
-          # ActiveSupport events are used instead for Rails >= 4
-          module RailsLessThan4
-            include Rails31Plus
-
-            def datadog_parse_args(template, layout_name, *args)
-              [template, layout_name]
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,53 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/integration'
-require 'ddtrace/contrib/action_view/configuration/settings'
-require 'ddtrace/contrib/action_view/patcher'
-require 'ddtrace/contrib/rails/utils'
-
-module Datadog
-  module Contrib
-    module ActionView
-      # Describes the ActionView integration
-      class Integration
-        include Contrib::Integration
-
-        MINIMUM_VERSION = Gem::Version.new('3.0')
-
-        register_as :action_view, auto_patch: false
-
-        def self.version
-          # ActionView is its own gem in Rails 4.1+
-          if Gem.loaded_specs['actionview']
-            Gem.loaded_specs['actionview'].version
-          # ActionView is embedded in ActionPack in versions < 4.1
-          elsif Gem.loaded_specs['actionpack']
-            action_pack_version = Gem.loaded_specs['actionpack'].version
-            action_pack_version unless action_pack_version >= Gem::Version.new('4.1')
-          end
-        end
-
-        def self.loaded?
-          !defined?(::ActionView).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
-          ActionView::Patcher
-        end
-      end
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-# typed: true
-require 'ddtrace/ext/http'
-require 'ddtrace/contrib/patcher'
-require 'ddtrace/contrib/action_view/events'
-require 'ddtrace/contrib/action_view/ext'
-require 'ddtrace/contrib/action_view/instrumentation/partial_renderer'
-require 'ddtrace/contrib/action_view/instrumentation/template_renderer'
-require 'ddtrace/contrib/action_view/utils'
-
-module Datadog
-  module Contrib
-    module ActionView
-      # Patcher enables patching of ActionView module.
-      module Patcher
-        include Contrib::Patcher
-
-        module_function
-
-        def target_version
-          Integration.version
-        end
-
-        def patch
-          patch_renderer
-        end
-
-        def patch_renderer
-          if target_version >= Gem::Version.new('4.0.0')
-            Events.subscribe!
-          elsif defined?(::ActionView::TemplateRenderer) && defined?(::ActionView::PartialRenderer)
-            # Rails < 4 compatibility:
-            #  Rendering events are not nested in this version, creating
-            #  render_partial spans outside of the parent render_template span.
-            #  We fall back to manual patching instead.
-            ::ActionView::TemplateRenderer.prepend(Instrumentation::TemplateRenderer::RailsLessThan4)
-            ::ActionView::PartialRenderer.prepend(Instrumentation::PartialRenderer::RailsLessThan4)
-          elsif defined?(::ActionView::Rendering) && defined?(::ActionView::Partials::PartialRenderer)
-            # NOTE: Rails < 3.1 compatibility: different classes are used
-            ::ActionView::Rendering.prepend(Instrumentation::TemplateRenderer::Rails30)
-            ::ActionView::Partials::PartialRenderer.prepend(Instrumentation::PartialRenderer::RailsLessThan4)
-          else
-            Datadog.logger.debug('Expected Template/Partial classes not found; template rendering disabled')
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/action_view/utils.rb

@@ -1,33 +0,0 @@
-# typed: true
-require 'ddtrace/contrib/analytics'
-
-module Datadog
-  module Contrib
-    module ActionView
-      # common utilities for Rails
-      module Utils
-        module_function
-
-        # in Rails the template name includes the template full path
-        # and it's better to avoid storing such information. This method
-        # returns the relative path from `views/` or the template name
-        # if a `views/` folder is not in the template full path. A wrong
-        # usage ensures that this method will not crash the tracing system.
-        def normalize_template_name(name)
-          return if name.nil?
-
-          base_path = Datadog.configuration[:action_view][:template_base_path]
-          sections_view = name.split(base_path)
-
-          if sections_view.length == 1
-            name.split('/')[-1]
-          else
-            sections_view[-1]
-          end
-        rescue
-          name.to_s
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/configuration/settings'
-require 'ddtrace/contrib/active_job/ext'
-
-module Datadog
-  module Contrib
-    module ActiveJob
-      module Configuration
-        # Custom settings for the DelayedJob 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 :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
-          option :log_injection, default: false
-        end
-      end
-    end
-  end
-end

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

@@ -1,54 +0,0 @@
-# typed: true
-require 'ddtrace/contrib/active_support/notifications/event'
-require 'ddtrace/contrib/active_job/ext'
-
-module Datadog
-  module Contrib
-    module ActiveJob
-      # Defines basic behaviors for an ActiveJob event.
-      module Event
-        def self.included(base)
-          base.include(ActiveSupport::Notifications::Event)
-          base.extend(ClassMethods)
-        end
-
-        # Class methods for ActiveJob events.
-        module ClassMethods
-          def span_options
-            { service: configuration[:service_name] }
-          end
-
-          def tracer
-            -> { configuration[:tracer] }
-          end
-
-          def configuration
-            Datadog.configuration[:active_job]
-          end
-
-          def set_common_tags(span, payload)
-            adapter_name = if payload[:adapter].is_a?(Class)
-                             payload[:adapter].name
-                           else
-                             payload[:adapter].class.name
-                           end
-            span.set_tag(Ext::TAG_ADAPTER, adapter_name)
-
-            job = payload[:job]
-            span.set_tag(Ext::TAG_JOB_ID, job.job_id)
-            span.set_tag(Ext::TAG_JOB_QUEUE, job.queue_name)
-            span.set_tag(Ext::TAG_JOB_PRIORITY, job.priority) if job.respond_to?(:priority)
-            span.set_tag(Ext::TAG_JOB_EXECUTIONS, job.executions) if job.respond_to?(:executions)
-
-            job_scheduled_at = if job.respond_to?(:scheduled_at)
-                                 job.scheduled_at
-                               elsif job.respond_to?(:enqueued_at)
-                                 job.enqueued_at
-                               end
-            span.set_tag(Ext::TAG_JOB_SCHEDULED_AT, Time.at(job_scheduled_at)) if job_scheduled_at
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/active_job/events/discard.rb

@@ -1,46 +0,0 @@
-# typed: false
-require 'ddtrace/ext/integration'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/active_job/ext'
-require 'ddtrace/contrib/active_job/event'
-
-module Datadog
-  module Contrib
-    module ActiveJob
-      module Events
-        # Defines instrumentation for enqueue.active_job event
-        module Discard
-          include ActiveJob::Event
-
-          EVENT_NAME = 'discard.active_job'.freeze
-
-          module_function
-
-          def event_name
-            self::EVENT_NAME
-          end
-
-          def span_name
-            Ext::SPAN_DISCARD
-          end
-
-          def process(span, event, _id, payload)
-            span.name = span_name
-            span.service = configuration[:service_name]
-            span.resource = payload[:job].class.name
-
-            # Set analytics sample rate
-            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-            end
-
-            set_common_tags(span, payload)
-            span.set_tag(Ext::TAG_JOB_ERROR, payload[:error])
-          rescue StandardError => e
-            Datadog.logger.debug(e.message)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/active_job/events/enqueue.rb

@@ -1,45 +0,0 @@
-# typed: false
-require 'ddtrace/ext/integration'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/active_job/ext'
-require 'ddtrace/contrib/active_job/event'
-
-module Datadog
-  module Contrib
-    module ActiveJob
-      module Events
-        # Defines instrumentation for enqueue.active_job event
-        module Enqueue
-          include ActiveJob::Event
-
-          EVENT_NAME = 'enqueue.active_job'.freeze
-
-          module_function
-
-          def event_name
-            self::EVENT_NAME
-          end
-
-          def span_name
-            Ext::SPAN_ENQUEUE
-          end
-
-          def process(span, event, _id, payload)
-            span.name = span_name
-            span.service = configuration[:service_name]
-            span.resource = payload[:job].class.name
-
-            # Set analytics sample rate
-            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-            end
-
-            set_common_tags(span, payload)
-          rescue StandardError => e
-            Datadog.logger.debug(e.message)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/active_job/events/enqueue_at.rb

@@ -1,45 +0,0 @@
-# typed: false
-require 'ddtrace/ext/integration'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/active_job/ext'
-require 'ddtrace/contrib/active_job/event'
-
-module Datadog
-  module Contrib
-    module ActiveJob
-      module Events
-        # Defines instrumentation for enqueue.active_job event
-        module EnqueueAt
-          include ActiveJob::Event
-
-          EVENT_NAME = 'enqueue_at.active_job'.freeze
-
-          module_function
-
-          def event_name
-            self::EVENT_NAME
-          end
-
-          def span_name
-            Ext::SPAN_ENQUEUE
-          end
-
-          def process(span, event, _id, payload)
-            span.name = span_name
-            span.service = configuration[:service_name]
-            span.resource = payload[:job].class.name
-
-            # Set analytics sample rate
-            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-            end
-
-            set_common_tags(span, payload)
-          rescue StandardError => e
-            Datadog.logger.debug(e.message)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/active_job/events/enqueue_retry.rb

@@ -1,47 +0,0 @@
-# typed: false
-require 'ddtrace/ext/integration'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/active_job/ext'
-require 'ddtrace/contrib/active_job/event'
-
-module Datadog
-  module Contrib
-    module ActiveJob
-      module Events
-        # Defines instrumentation for enqueue.active_job event
-        module EnqueueRetry
-          include ActiveJob::Event
-
-          EVENT_NAME = 'enqueue_retry.active_job'.freeze
-
-          module_function
-
-          def event_name
-            self::EVENT_NAME
-          end
-
-          def span_name
-            Ext::SPAN_ENQUEUE_RETRY
-          end
-
-          def process(span, event, _id, payload)
-            span.name = span_name
-            span.service = configuration[:service_name]
-            span.resource = payload[:job].class.name
-
-            # Set analytics sample rate
-            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-            end
-
-            set_common_tags(span, payload)
-            span.set_tag(Ext::TAG_JOB_ERROR, payload[:error])
-            span.set_tag(Ext::TAG_JOB_RETRY_WAIT, payload[:wait])
-          rescue StandardError => e
-            Datadog.logger.debug(e.message)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/active_job/events/perform.rb

@@ -1,45 +0,0 @@
-# typed: false
-require 'ddtrace/ext/integration'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/active_job/ext'
-require 'ddtrace/contrib/active_job/event'
-
-module Datadog
-  module Contrib
-    module ActiveJob
-      module Events
-        # Defines instrumentation for perform.active_job event
-        module Perform
-          include ActiveJob::Event
-
-          EVENT_NAME = 'perform.active_job'.freeze
-
-          module_function
-
-          def event_name
-            self::EVENT_NAME
-          end
-
-          def span_name
-            Ext::SPAN_PERFORM
-          end
-
-          def process(span, event, _id, payload)
-            span.name = span_name
-            span.service = configuration[:service_name]
-            span.resource = payload[:job].class.name
-
-            # Set analytics sample rate
-            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-            end
-
-            set_common_tags(span, payload)
-          rescue StandardError => e
-            Datadog.logger.debug(e.message)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/active_job/events/retry_stopped.rb

@@ -1,46 +0,0 @@
-# typed: false
-require 'ddtrace/ext/integration'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/active_job/ext'
-require 'ddtrace/contrib/active_job/event'
-
-module Datadog
-  module Contrib
-    module ActiveJob
-      module Events
-        # Defines instrumentation for enqueue.active_job event
-        module RetryStopped
-          include ActiveJob::Event
-
-          EVENT_NAME = 'retry_stopped.active_job'.freeze
-
-          module_function
-
-          def event_name
-            self::EVENT_NAME
-          end
-
-          def span_name
-            Ext::SPAN_RETRY_STOPPED
-          end
-
-          def process(span, event, _id, payload)
-            span.name = span_name
-            span.service = configuration[:service_name]
-            span.resource = payload[:job].class.name
-
-            # Set analytics sample rate
-            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-            end
-
-            set_common_tags(span, payload)
-            span.set_tag(Ext::TAG_JOB_ERROR, payload[:error])
-          rescue StandardError => e
-            Datadog.logger.debug(e.message)
-          end
-        end
-      end
-    end
-  end
-end