ddtrace 0.35.2 → 1.1.0

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

@@ -0,0 +1,35 @@
+# typed: true
+
+require 'datadog/tracing/contrib/active_support/notifications/event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionView
+        # Defines basic behavior for an ActionView event.
+        module Event
+          def self.included(base)
+            base.include(ActiveSupport::Notifications::Event)
+            base.extend(ClassMethods)
+          end
+
+          # Class methods for ActionView events.
+          module ClassMethods
+            def configuration
+              Datadog.configuration.tracing[:action_view]
+            end
+
+            def record_exception(span, payload)
+              if payload[:exception_object]
+                span.set_error(payload[:exception_object])
+              elsif payload[:exception]
+                # Fallback for ActiveSupport < 5.0
+                span.set_error(payload[:exception])
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_view/events/render_partial.rb

@@ -0,0 +1,54 @@
+# typed: false
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/action_view/ext'
+require 'datadog/tracing/contrib/action_view/event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionView
+        module Events
+          # Defines instrumentation for render_partial.action_view event
+          module RenderPartial
+            include ActionView::Event
+
+            EVENT_NAME = 'render_partial.action_view'.freeze
+
+            module_function
+
+            def event_name
+              self::EVENT_NAME
+            end
+
+            def span_name
+              Ext::SPAN_RENDER_PARTIAL
+            end
+
+            def process(span, _event, _id, payload)
+              span.service = configuration[:service_name] if configuration[:service_name]
+              span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_TEMPLATE
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_RENDER_PARTIAL)
+
+              if (template_name = Utils.normalize_template_name(payload[:identifier]))
+                span.resource = template_name
+                span.set_tag(Ext::TAG_TEMPLATE_NAME, template_name)
+              end
+
+              # Measure service stats
+              Contrib::Analytics.set_measured(span)
+
+              record_exception(span, payload)
+            rescue StandardError => e
+              Datadog.logger.debug(e.message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_view/events/render_template.rb

@@ -0,0 +1,57 @@
+# typed: false
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/action_view/ext'
+require 'datadog/tracing/contrib/action_view/event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionView
+        module Events
+          # Defines instrumentation for render_template.action_view event
+          module RenderTemplate
+            include ActionView::Event
+
+            EVENT_NAME = 'render_template.action_view'.freeze
+
+            module_function
+
+            def event_name
+              self::EVENT_NAME
+            end
+
+            def span_name
+              Ext::SPAN_RENDER_TEMPLATE
+            end
+
+            def process(span, _event, _id, payload)
+              span.service = configuration[:service_name] if configuration[:service_name]
+              span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_TEMPLATE
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_RENDER_TEMPLATE)
+
+              if (template_name = Utils.normalize_template_name(payload[:identifier]))
+                span.resource = template_name
+                span.set_tag(Ext::TAG_TEMPLATE_NAME, template_name)
+              end
+
+              layout = payload[:layout]
+              span.set_tag(Ext::TAG_LAYOUT, layout) if layout
+
+              # Measure service stats
+              Contrib::Analytics.set_measured(span)
+
+              record_exception(span, payload)
+            rescue StandardError => e
+              Datadog.logger.debug(e.message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# typed: false
+
+require 'datadog/tracing/contrib/action_view/events/render_partial'
+require 'datadog/tracing/contrib/action_view/events/render_template'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionView
+        # Defines collection of instrumented ActionView events
+        module Events
+          ALL = [
+            Events::RenderPartial,
+            Events::RenderTemplate
+          ].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_view/ext.rb

@@ -0,0 +1,24 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionView
+        # ActionView integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_ACTION_VIEW_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_VIEW_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_VIEW_ANALYTICS_SAMPLE_RATE'.freeze
+          SPAN_RENDER_PARTIAL = 'rails.render_partial'.freeze
+          SPAN_RENDER_TEMPLATE = 'rails.render_template'.freeze
+          TAG_COMPONENT = 'action_view'.freeze
+          TAG_LAYOUT = 'rails.layout'.freeze
+          TAG_OPERATION_RENDER_PARTIAL = 'render_partial'.freeze
+          TAG_OPERATION_RENDER_TEMPLATE = 'render_template'.freeze
+          TAG_TEMPLATE_NAME = 'rails.template_name'.freeze
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_view/instrumentation/partial_renderer.rb

@@ -0,0 +1,78 @@
+# typed: false
+
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/action_view/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionView
+        module Instrumentation
+          # Legacy instrumentation for partial rendering for Rails < 4
+          module PartialRenderer
+            def render(*args, &block)
+              Tracing.trace(
+                Ext::SPAN_RENDER_PARTIAL,
+                span_type: Tracing::Metadata::Ext::HTTP::TYPE_TEMPLATE
+              ) do |span|
+                span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_RENDER_PARTIAL)
+
+                with_datadog_span(span) { super(*args) }
+              end
+            end
+
+            def render_partial(*args)
+              begin
+                template = datadog_template(*args)
+
+                datadog_render_partial(template)
+              rescue StandardError => e
+                Datadog.logger.debug(e.message)
+              end
+
+              # execute the original function anyway
+              super(*args)
+            end
+
+            def datadog_render_partial(template)
+              template_name = Utils.normalize_template_name(template.try('identifier'))
+
+              if template_name
+                active_datadog_span.resource = template_name
+                active_datadog_span.set_tag(
+                  Ext::TAG_TEMPLATE_NAME,
+                  template_name
+                )
+
+                # Measure service stats
+                Contrib::Analytics.set_measured(active_datadog_span)
+              end
+            end
+
+            private
+
+            attr_accessor :active_datadog_span
+
+            def with_datadog_span(span)
+              self.active_datadog_span = span
+              yield
+            ensure
+              self.active_datadog_span = nil
+            end
+
+            # Rails < 4 partial rendering
+            # ActiveSupport events are used instead for Rails >= 4
+            module RailsLessThan4
+              include PartialRenderer
+
+              def datadog_template(*args)
+                @template
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_view/instrumentation/template_renderer.rb

@@ -0,0 +1,91 @@
+# typed: false
+
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/action_view/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionView
+        module Instrumentation
+          # Legacy instrumentation for template rendering for Rails < 4
+          module TemplateRenderer
+            # Legacy shared code for Rails >= 3.1 template rendering
+            module Rails31Plus
+              def render(*args, &block)
+                Tracing.trace(
+                  Ext::SPAN_RENDER_TEMPLATE,
+                  span_type: Tracing::Metadata::Ext::HTTP::TYPE_TEMPLATE
+                ) do |span|
+                  span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                  span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_RENDER_TEMPLATE)
+
+                  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 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
+end

data/lib/datadog/tracing/contrib/action_view/integration.rb

@@ -0,0 +1,57 @@
+# typed: false
+
+require 'datadog/tracing/contrib/action_view/configuration/settings'
+require 'datadog/tracing/contrib/action_view/patcher'
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/rails/utils'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionView
+        # Describes the ActionView integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('3.2')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          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?
+            !Contrib::Rails::Utils.railtie_supported?
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            ActionView::Patcher
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_view/patcher.rb

@@ -0,0 +1,47 @@
+# typed: true
+
+require 'datadog/core'
+require 'datadog/tracing/contrib/patcher'
+require 'datadog/tracing/contrib/action_view/events'
+require 'datadog/tracing/contrib/action_view/ext'
+require 'datadog/tracing/contrib/action_view/instrumentation/partial_renderer'
+require 'datadog/tracing/contrib/action_view/instrumentation/template_renderer'
+require 'datadog/tracing/contrib/action_view/utils'
+
+module Datadog
+  module Tracing
+    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.0 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)
+            else
+              Datadog.logger.debug('Expected Template/Partial classes not found; template rendering disabled')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_view/utils.rb

@@ -0,0 +1,36 @@
+# typed: true
+
+require 'datadog/tracing/contrib/analytics'
+
+module Datadog
+  module Tracing
+    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.tracing[: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
+end

data/lib/datadog/tracing/contrib/active_job/configuration/settings.rb

@@ -0,0 +1,37 @@
+# typed: false
+
+require 'datadog/tracing/span_operation'
+require 'datadog/tracing/contrib/active_job/ext'
+require 'datadog/tracing/contrib/configuration/settings'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveJob
+        module Configuration
+          # Custom settings for the DelayedJob integration
+          # @public_api
+          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, false) }
+              o.lazy
+            end
+
+            option :analytics_sample_rate do |o|
+              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+              o.lazy
+            end
+
+            option :service_name
+            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# typed: true
+
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/active_support/notifications/event'
+require 'datadog/tracing/contrib/active_job/ext'
+
+module Datadog
+  module Tracing
+    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
+              options = {}
+              options[:service] = configuration[:service_name] if configuration[:service_name]
+              options
+            end
+
+            def configuration
+              Datadog.configuration.tracing[: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)
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+
+              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
+end

data/lib/datadog/tracing/contrib/active_job/events/discard.rb

@@ -0,0 +1,50 @@
+# typed: false
+
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/active_job/ext'
+require 'datadog/tracing/contrib/active_job/event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveJob
+        module Events
+          # Defines instrumentation for discard.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] if configuration[:service_name]
+              span.resource = payload[:job].class.name
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_DISCARD)
+
+              # 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
+end