ddtrace 0.40.0 → 0.54.1

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

@@ -1,6 +1,8 @@
+# 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
@@ -25,6 +27,12 @@ module Datadog
           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

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/action_pack/action_controller/patcher'
 

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/analytics'
 
 module Datadog
@@ -11,7 +12,7 @@ module Datadog
             # You can add custom errors via `config.action_dispatch.rescue_responses`
             status = ::ActionDispatch::ExceptionWrapper.status_code_for_exception(exception.class.name)
             # Only 5XX exceptions are actually errors (e.g. don't flag 404s)
-            status.to_s.starts_with?('5')
+            status.to_s.start_with?('5')
           else
             true
           end

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/action_view/ext'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/active_support/notifications/event'
 
 module Datadog
@@ -6,16 +7,12 @@ module Datadog
       # Defines basic behavior for an ActionView event.
       module Event
         def self.included(base)
-          base.send(:include, ActiveSupport::Notifications::Event)
-          base.send(:extend, ClassMethods)
+          base.include(ActiveSupport::Notifications::Event)
+          base.extend(ClassMethods)
         end
 
         # Class methods for ActionView events.
         module ClassMethods
-          def span_options
-            { service: configuration[:service_name] }
-          end
-
           def tracer
             -> { configuration[:tracer] }
           end
@@ -25,7 +22,7 @@ module Datadog
           end
 
           def record_exception(span, payload)
-            if payload [:exception_object]
+            if payload[:exception_object]
               span.set_error(payload[:exception_object])
             elsif payload[:exception]
               # Fallback for ActiveSupport < 5.0

data/lib/ddtrace/contrib/action_view/events/render_partial.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/net'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/action_view/ext'
@@ -24,6 +25,7 @@ module Datadog
           end
 
           def process(span, _event, _id, payload)
+            span.service = configuration[:service_name]
             span.span_type = Datadog::Ext::HTTP::TEMPLATE
 
             if (template_name = Utils.normalize_template_name(payload[:identifier]))

data/lib/ddtrace/contrib/action_view/events/render_template.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/net'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/action_view/ext'
@@ -24,6 +25,7 @@ module Datadog
           end
 
           def process(span, _event, _id, payload)
+            span.service = configuration[:service_name]
             span.span_type = Datadog::Ext::HTTP::TEMPLATE
 
             if (template_name = Utils.normalize_template_name(payload[:identifier]))

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/action_view/events/render_partial'
 require 'ddtrace/contrib/action_view/events/render_template'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module ActionView

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/action_view/ext'
 
 module Datadog

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/action_view/ext'
 
 module Datadog

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

@@ -1,6 +1,8 @@
+# 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
@@ -32,6 +34,12 @@ module Datadog
           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

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/http'
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/action_view/events'
@@ -31,12 +32,12 @@ module Datadog
             #  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.send(:prepend, Instrumentation::TemplateRenderer::RailsLessThan4)
-            ::ActionView::PartialRenderer.send(:prepend, Instrumentation::PartialRenderer::RailsLessThan4)
+            ::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.send(:prepend, Instrumentation::TemplateRenderer::Rails30)
-            ::ActionView::Partials::PartialRenderer.send(:prepend, Instrumentation::PartialRenderer::RailsLessThan4)
+            ::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

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/analytics'
 
 module Datadog
@@ -24,7 +25,7 @@ module Datadog
             sections_view[-1]
           end
         rescue
-          return name.to_s
+          name.to_s
         end
       end
     end

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,39 @@
+# typed: false
+require 'ddtrace/contrib/active_job/events/discard'
+require 'ddtrace/contrib/active_job/events/enqueue'
+require 'ddtrace/contrib/active_job/events/enqueue_at'
+require 'ddtrace/contrib/active_job/events/enqueue_retry'
+require 'ddtrace/contrib/active_job/events/perform'
+require 'ddtrace/contrib/active_job/events/retry_stopped'
+
+module Datadog
+  module Contrib
+    module ActiveJob
+      # Defines collection of instrumented ActiveJob events
+      module Events
+        ALL = [
+          Events::Discard,
+          Events::Enqueue,
+          Events::EnqueueAt,
+          Events::EnqueueRetry,
+          Events::Perform,
+          Events::RetryStopped,
+        ].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/active_job/ext.rb

@@ -0,0 +1,32 @@
+# typed: true
+module Datadog
+  module Contrib
+    module ActiveJob
+      module Ext
+        APP = 'active_job'.freeze
+        SERVICE_NAME = 'active_job'.freeze
+
+        ENV_ENABLED = 'DD_TRACE_ACTIVE_JOB_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_ACTIVE_JOB_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ACTIVE_JOB_ANALYTICS_SAMPLE_RATE'.freeze
+
+        SPAN_DISCARD = 'active_job.discard'.freeze
+        SPAN_ENQUEUE = 'active_job.enqueue'.freeze
+        SPAN_ENQUEUE_RETRY = 'active_job.enqueue_retry'.freeze
+        SPAN_PERFORM = 'active_job.perform'.freeze
+        SPAN_RETRY_STOPPED = 'active_job.retry_stopped'.freeze
+
+        TAG_ADAPTER = 'active_job.adapter'.freeze
+        TAG_JOB_ERROR = 'active_job.job.error'.freeze
+        TAG_JOB_EXECUTIONS = 'active_job.job.executions'.freeze
+        TAG_JOB_ID = 'active_job.job.id'.freeze
+        TAG_JOB_PRIORITY = 'active_job.job.priority'.freeze
+        TAG_JOB_QUEUE = 'active_job.job.queue'.freeze
+        TAG_JOB_RETRY_WAIT = 'active_job.job.retry_wait'.freeze
+        TAG_JOB_SCHEDULED_AT = 'active_job.job.scheduled_at'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# typed: false
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/active_job/configuration/settings'
+require 'ddtrace/contrib/active_job/patcher'
+require 'ddtrace/contrib/rails/utils'
+
+module Datadog
+  module Contrib
+    module ActiveJob
+      # Describes the ActiveJob integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('4.2')
+
+        register_as :active_job, auto_patch: false
+
+        def self.version
+          Gem.loaded_specs['activejob'] && Gem.loaded_specs['activejob'].version
+        end
+
+        def self.loaded?
+          !defined?(::ActiveJob).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
+          ActiveJob::Patcher
+        end
+      end
+    end
+  end
+end