ddtrace 0.54.0 → 1.0.0

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

@@ -0,0 +1,51 @@
+# 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 enqueue_retry.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] 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 @@
+# 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 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] 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 @@
+# 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 retry_stopped.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] 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 @@
+# typed: false
+
+require 'datadog/tracing/contrib/active_job/events/discard'
+require 'datadog/tracing/contrib/active_job/events/enqueue'
+require 'datadog/tracing/contrib/active_job/events/enqueue_at'
+require 'datadog/tracing/contrib/active_job/events/enqueue_retry'
+require 'datadog/tracing/contrib/active_job/events/perform'
+require 'datadog/tracing/contrib/active_job/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,39 @@
+# typed: 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'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_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_COMPONENT = 'active_job'.freeze
+          TAG_OPERATION_DISCARD = 'discard'.freeze
+          TAG_OPERATION_ENQUEUE = 'enqueue'.freeze
+          TAG_OPERATION_ENQUEUE_AT = 'enqueue_at'.freeze
+          TAG_OPERATION_ENQUEUE_RETRY = 'enqueue_retry'.freeze
+          TAG_OPERATION_PERFORM = 'perform'.freeze
+          TAG_OPERATION_RETRY_STOPPED = '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
+end

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

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

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

@@ -0,0 +1,26 @@
+# typed: false
+
+require 'datadog/tracing'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveJob
+        # Active Job log injection wrapped around job execution
+        module LogInjection
+          def self.included(base)
+            base.class_eval do
+              around_perform do |_, block|
+                if logger.respond_to?(:tagged)
+                  logger.tagged(Tracing.log_correlation, &block)
+                else
+                  block.call
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# typed: false
+
+require 'datadog/tracing/contrib/patcher'
+require 'datadog/tracing/contrib/active_job/ext'
+require 'datadog/tracing/contrib/active_job/events'
+require 'datadog/tracing/contrib/active_job/log_injection'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveJob
+        # Patcher enables patching of 'active_job' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            Events.subscribe!
+            inject_log_correlation if Datadog.configuration.tracing.log_injection
+          end
+
+          def inject_log_correlation
+            ::ActiveSupport.on_load(:active_job) do
+              include LogInjection
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# typed: false
+
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/active_model_serializers/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveModelSerializers
+        module Configuration
+          # Custom settings for the ActiveModelSerializers 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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# typed: true
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/active_support/notifications/event'
+require 'datadog/tracing/contrib/active_model_serializers/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveModelSerializers
+        # Defines basic behaviors for an ActiveModelSerializers event.
+        module Event
+          def self.included(base)
+            base.include(ActiveSupport::Notifications::Event)
+            base.extend(ClassMethods)
+          end
+
+          # Class methods for ActiveModelSerializers events.
+          # Note, they share the same process method and before_trace method.
+          module ClassMethods
+            def span_options
+              {}
+            end
+
+            def configuration
+              Datadog.configuration.tracing[:active_model_serializers]
+            end
+
+            def set_common_tags(span, payload)
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+
+              # 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)
+
+              # Set the resource name and serializer name
+              res = resource(payload[:serializer])
+              span.resource = res
+              span.set_tag(Ext::TAG_SERIALIZER, res)
+
+              span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_TEMPLATE
+
+              # Will be nil in 0.9
+              span.set_tag(Ext::TAG_ADAPTER, payload[:adapter].class) unless payload[:adapter].nil?
+            end
+
+            private
+
+            def resource(serializer)
+              # Depending on the version of ActiveModelSerializers
+              # serializer will be a string or an object.
+              if serializer.respond_to?(:name)
+                serializer.name
+              else
+                serializer
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/active_model_serializers/events/render.rb

@@ -0,0 +1,45 @@
+# typed: false
+
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/active_model_serializers/ext'
+require 'datadog/tracing/contrib/active_model_serializers/event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveModelSerializers
+        module Events
+          # Defines instrumentation for render.active_model_serializers event
+          module Render
+            include ActiveModelSerializers::Event
+
+            EVENT_NAME = 'render.active_model_serializers'.freeze
+
+            module_function
+
+            def supported?
+              Gem.loaded_specs['active_model_serializers'] \
+                && Gem.loaded_specs['active_model_serializers'].version >= Gem::Version.new('0.10')
+            end
+
+            def event_name
+              self::EVENT_NAME
+            end
+
+            def span_name
+              Ext::SPAN_RENDER
+            end
+
+            def process(span, _event, _id, payload)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_RENDER)
+
+              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_model_serializers/events/serialize.rb

@@ -0,0 +1,47 @@
+# typed: false
+
+require 'datadog/tracing/contrib/active_model_serializers/ext'
+require 'datadog/tracing/contrib/active_model_serializers/event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveModelSerializers
+        module Events
+          # Defines instrumentation for !serialize.active_model_serializers event
+          module Serialize
+            include ActiveModelSerializers::Event
+
+            EVENT_NAME = '!serialize.active_model_serializers'.freeze
+
+            module_function
+
+            def supported?
+              Gem.loaded_specs['active_model_serializers'] \
+                && ( \
+                  Gem.loaded_specs['active_model_serializers'].version >= Gem::Version.new('0.9') \
+                  && Gem.loaded_specs['active_model_serializers'].version < Gem::Version.new('0.10') \
+                )
+            end
+
+            def event_name
+              self::EVENT_NAME
+            end
+
+            def span_name
+              Ext::SPAN_SERIALIZE
+            end
+
+            def process(span, _event, _id, payload)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_SERIALIZE)
+
+              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_model_serializers/events.rb

@@ -0,0 +1,34 @@
+# typed: false
+
+require 'datadog/tracing/contrib/active_model_serializers/events/render'
+require 'datadog/tracing/contrib/active_model_serializers/events/serialize'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveModelSerializers
+        # Defines collection of instrumented ActiveModelSerializers events
+        module Events
+          ALL = [
+            Events::Render,
+            Events::Serialize
+          ].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_model_serializers/ext.rb

@@ -0,0 +1,24 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveModelSerializers
+        # ActiveModelSerializers integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_SAMPLE_RATE'.freeze
+          SPAN_RENDER = 'active_model_serializers.render'.freeze
+          SPAN_SERIALIZE = 'active_model_serializers.serialize'.freeze
+          TAG_ADAPTER = 'active_model_serializers.adapter'.freeze
+          TAG_COMPONENT = 'active_model_serializers'.freeze
+          TAG_OPERATION_RENDER = 'render'.freeze
+          TAG_OPERATION_SERIALIZE = 'serialize'.freeze
+          TAG_SERIALIZER = 'active_model_serializers.serializer'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# typed: false
+
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/active_model_serializers/configuration/settings'
+require 'datadog/tracing/contrib/active_model_serializers/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveModelSerializers
+        # Description of ActiveModelSerializers integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('0.9.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :active_model_serializers
+
+          def self.version
+            Gem.loaded_specs['active_model_serializers'] \
+              && Gem.loaded_specs['active_model_serializers'].version
+          end
+
+          def self.loaded?
+            !defined?(::ActiveModel::Serializer).nil? \
+              && !defined?(::ActiveSupport::Notifications).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# typed: true
+
+require 'datadog/tracing'
+require 'datadog/tracing/contrib/patcher'
+require 'datadog/tracing/contrib/active_model_serializers/ext'
+require 'datadog/tracing/contrib/active_model_serializers/events'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveModelSerializers
+        # Patcher enables patching of 'active_model_serializers' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            Events.subscribe!
+          end
+
+          def get_option(option)
+            Datadog.configuration.tracing[:active_model_serializers].get_option(option)
+          end
+        end
+      end
+    end
+  end
+end