datadog 2.0.0.beta1

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'events/render_partial'
+require_relative '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,25 @@
+# frozen_string_literal: 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'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_VIEW_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_VIEW_ANALYTICS_SAMPLE_RATE'
+          SPAN_RENDER_PARTIAL = 'rails.render_partial'
+          SPAN_RENDER_TEMPLATE = 'rails.render_template'
+          TAG_COMPONENT = 'action_view'
+          TAG_LAYOUT = 'rails.layout'
+          TAG_OPERATION_RENDER_PARTIAL = 'render_partial'
+          TAG_OPERATION_RENDER_TEMPLATE = 'render_template'
+          TAG_TEMPLATE_NAME = 'rails.template_name'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'configuration/settings'
+require_relative 'patcher'
+require_relative '../integration'
+require_relative '../rails/integration'
+require_relative '../rails/utils'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionView
+        # Describes the ActionView integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Contrib::Rails::Ext::MINIMUM_VERSION
+
+          # @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,34 @@
+# frozen_string_literal: true
+
+require_relative '../../../core'
+require_relative '../patcher'
+require_relative 'events'
+require_relative 'ext'
+require_relative '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
+            Events.subscribe!
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative '../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,39 @@
+# frozen_string_literal: true
+
+require_relative '../ext'
+require_relative '../../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.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+
+            # @!visibility private
+            option :analytics_enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ANALYTICS_ENABLED
+              o.default false
+            end
+
+            option :analytics_sample_rate do |o|
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
+            end
+
+            option :service_name
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../../metadata/ext'
+require_relative '../active_support/notifications/event'
+require_relative '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 @@
+# frozen_string_literal: true
+
+require_relative '../../../metadata/ext'
+require_relative '../../analytics'
+require_relative '../ext'
+require_relative '../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'
+
+            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

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative '../../../metadata/ext'
+require_relative '../../analytics'
+require_relative '../ext'
+require_relative '../event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveJob
+        module Events
+          # Defines instrumentation for enqueue.active_job event
+          module Enqueue
+            include ActiveJob::Event
+
+            EVENT_NAME = 'enqueue.active_job'
+
+            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] if configuration[:service_name]
+              span.resource = payload[:job].class.name
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ENQUEUE)
+
+              # 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
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative '../../../metadata/ext'
+require_relative '../../analytics'
+require_relative '../ext'
+require_relative '../event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveJob
+        module Events
+          # Defines instrumentation for enqueue_at.active_job event
+          module EnqueueAt
+            include ActiveJob::Event
+
+            EVENT_NAME = 'enqueue_at.active_job'
+
+            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] if configuration[:service_name]
+              span.resource = payload[:job].class.name
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ENQUEUE_AT)
+
+              # 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
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../../../metadata/ext'
+require_relative '../../analytics'
+require_relative '../ext'
+require_relative '../event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveJob
+        module Events
+          # Defines instrumentation for enqueue_retry.active_job event
+          module EnqueueRetry
+            include ActiveJob::Event
+
+            EVENT_NAME = 'enqueue_retry.active_job'
+
+            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] if configuration[:service_name]
+              span.resource = payload[:job].class.name
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ENQUEUE_RETRY)
+
+              # 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
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative '../../../metadata/ext'
+require_relative '../../analytics'
+require_relative '../ext'
+require_relative '../event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveJob
+        module Events
+          # Defines instrumentation for perform.active_job event
+          module Perform
+            include ActiveJob::Event
+
+            EVENT_NAME = 'perform.active_job'
+
+            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] if configuration[:service_name]
+              span.resource = payload[:job].class.name
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_PERFORM)
+
+              # 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
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative '../../../metadata/ext'
+require_relative '../../analytics'
+require_relative '../ext'
+require_relative '../event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveJob
+        module Events
+          # Defines instrumentation for retry_stopped.active_job event
+          module RetryStopped
+            include ActiveJob::Event
+
+            EVENT_NAME = 'retry_stopped.active_job'
+
+            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] if configuration[:service_name]
+              span.resource = payload[:job].class.name
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_RETRY_STOPPED)
+
+              # 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

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'events/discard'
+require_relative 'events/enqueue'
+require_relative 'events/enqueue_at'
+require_relative 'events/enqueue_retry'
+require_relative 'events/perform'
+require_relative 'events/retry_stopped'
+
+module Datadog
+  module Tracing
+    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
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveJob
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_ACTIVE_JOB_ENABLED'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_SAMPLE_RATE'
+
+          SPAN_DISCARD = 'active_job.discard'
+          SPAN_ENQUEUE = 'active_job.enqueue'
+          SPAN_ENQUEUE_RETRY = 'active_job.enqueue_retry'
+          SPAN_PERFORM = 'active_job.perform'
+          SPAN_RETRY_STOPPED = 'active_job.retry_stopped'
+
+          TAG_COMPONENT = 'active_job'
+          TAG_OPERATION_DISCARD = 'discard'
+          TAG_OPERATION_ENQUEUE = 'enqueue'
+          TAG_OPERATION_ENQUEUE_AT = 'enqueue_at'
+          TAG_OPERATION_ENQUEUE_RETRY = 'enqueue_retry'
+          TAG_OPERATION_PERFORM = 'perform'
+          TAG_OPERATION_RETRY_STOPPED = 'retry_stopped'
+
+          TAG_ADAPTER = 'active_job.adapter'
+          TAG_JOB_ERROR = 'active_job.job.error'
+          TAG_JOB_EXECUTIONS = 'active_job.job.executions'
+          TAG_JOB_ID = 'active_job.job.id'
+          TAG_JOB_PRIORITY = 'active_job.job.priority'
+          TAG_JOB_QUEUE = 'active_job.job.queue'
+          TAG_JOB_RETRY_WAIT = 'active_job.job.retry_wait'
+          TAG_JOB_SCHEDULED_AT = 'active_job.job.scheduled_at'
+        end
+      end
+    end
+  end
+end