ddtrace 0.54.2 → 1.2.0

data/lib/datadog/tracing/contrib/qless/qless_job.rb

@@ -0,0 +1,75 @@
+# typed: false
+
+require 'qless'
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/analytics'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Qless
+        # Uses Qless job hooks to create traces
+        module QlessJob
+          def around_perform(job)
+            return super unless datadog_configuration && Tracing.enabled?
+
+            Tracing.trace(Ext::SPAN_JOB, **span_options) do |span|
+              span.resource = job.klass_name
+              span.span_type = Tracing::Metadata::Ext::AppTypes::TYPE_WORKER
+              span.set_tag(Ext::TAG_JOB_ID, job.jid)
+              span.set_tag(Ext::TAG_JOB_QUEUE, job.queue_name)
+
+              tag_job_tags = datadog_configuration[:tag_job_tags]
+              span.set_tag(Ext::TAG_JOB_TAGS, job.tags) if tag_job_tags
+
+              tag_job_data = datadog_configuration[:tag_job_data]
+              if tag_job_data && !job.data.empty?
+                job_data = job.data.with_indifferent_access
+                formatted_data = job_data.except(:tags).map do |key, value|
+                  "#{key}:#{value}".underscore
+                end
+
+                span.set_tag(Ext::TAG_JOB_DATA, formatted_data)
+              end
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_JOB)
+
+              # Set analytics sample rate
+              if Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+                Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])
+              end
+
+              # Measure service stats
+              Contrib::Analytics.set_measured(span)
+
+              super
+            end
+          end
+
+          def after_fork
+            configuration = Datadog.configuration.tracing[:qless]
+            return if configuration.nil?
+
+            # Add a pin, marking the job as forked.
+            # Used to trigger shutdown in forks for performance reasons.
+            # Cleanup happens in the TracerCleaner class
+            Datadog.configure_onto(::Qless, forked: true)
+          end
+
+          private
+
+          def span_options
+            { service: datadog_configuration[:service_name] }
+          end
+
+          def datadog_configuration
+            Datadog.configuration.tracing[:qless]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/qless/tracer_cleaner.rb

@@ -0,0 +1,32 @@
+# typed: true
+
+require 'datadog/tracing'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Qless
+        # Shutdown Tracer in forks for performance reasons
+        module TracerCleaner
+          def around_perform(job)
+            return super unless datadog_configuration && Tracing.enabled?
+
+            super.tap do
+              Tracing.shutdown! if forked?
+            end
+          end
+
+          private
+
+          def forked?
+            Datadog.configuration_for(::Qless, :forked) == true
+          end
+
+          def datadog_configuration
+            Datadog.configuration.tracing[:qless]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# typed: false
+
+require 'datadog/tracing/span_operation'
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/que/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Que
+        module Configuration
+          # Default settings for the Que integration
+          class Settings < Contrib::Configuration::Settings
+            option :service_name
+            option :distributed_tracing, default: true
+
+            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 :tag_args do |o|
+              o.default { env_to_bool(Ext::ENV_TAG_ARGS_ENABLED, false) }
+              o.lazy
+            end
+
+            option :tag_data do |o|
+              o.default { env_to_bool(Ext::ENV_TAG_DATA_ENABLED, false) }
+              o.lazy
+            end
+            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# typed: strict
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Que
+        # Que integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_QUE_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_QUE_ANALYTICS_SAMPLE_RATE'
+          ENV_ENABLED = 'DD_TRACE_QUE_ENABLED'
+          ENV_TAG_ARGS_ENABLED = 'DD_TRACE_QUE_TAG_ARGS_ENABLED'
+          ENV_TAG_DATA_ENABLED = 'DD_TRACE_QUE_TAG_DATA_ENABLED'
+          SERVICE_NAME = 'que'
+          SPAN_JOB = 'que.job'
+          TAG_JOB_ARGS = 'que.job.args'
+          TAG_JOB_DATA = 'que.job.data'
+          TAG_JOB_ERROR_COUNT = 'que.job.error_count'
+          TAG_JOB_EXPIRED_AT = 'que.job.expired_at'
+          TAG_JOB_FINISHED_AT = 'que.job.finished_at'
+          TAG_JOB_ID = 'que.job.id'
+          TAG_JOB_PRIORITY = 'que.job.priority'
+          TAG_JOB_QUEUE = 'que.job.queue'
+          TAG_JOB_RUN_AT = 'que.job.run_at'
+          TAG_COMPONENT = 'que'
+          TAG_OPERATION_JOB = 'job'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# typed: false
+
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/que/ext'
+require 'datadog/tracing/contrib/que/configuration/settings'
+require 'datadog/tracing/contrib/que/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Que
+        # Description of Que integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('1.0.0.beta2')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :que, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs['que'] && Gem.loaded_specs['que'].version
+          end
+
+          def self.loaded?
+            !defined?(::Que).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/que/patcher.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# typed: false
+
+require 'datadog/tracing/contrib/que/tracer'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Que
+        # Patcher enables patching of 'que' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            ::Que.job_middleware.push(Que::Tracer.new)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/que/tracer.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# typed: true
+
+require 'datadog/tracing/contrib/analytics'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Que
+        # Tracer is a Que's server-side middleware which traces executed jobs
+        class Tracer
+          def call(job)
+            trace_options = {
+              service: configuration[:service_name],
+              span_type: Tracing::Metadata::Ext::AppTypes::TYPE_WORKER,
+              on_error: configuration[:error_handler]
+            }
+
+            Tracing.trace(Ext::SPAN_JOB, **trace_options) do |request_span|
+              request_span.resource = job.class.name.to_s
+
+              request_span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              request_span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_JOB)
+
+              request_span.set_tag(Ext::TAG_JOB_QUEUE, job.que_attrs[:queue])
+              request_span.set_tag(Ext::TAG_JOB_ID, job.que_attrs[:id])
+              request_span.set_tag(Ext::TAG_JOB_PRIORITY, job.que_attrs[:priority])
+              request_span.set_tag(Ext::TAG_JOB_ERROR_COUNT, job.que_attrs[:error_count])
+              request_span.set_tag(Ext::TAG_JOB_RUN_AT, job.que_attrs[:run_at])
+              request_span.set_tag(Ext::TAG_JOB_EXPIRED_AT, job.que_attrs[:expired_at])
+              request_span.set_tag(Ext::TAG_JOB_FINISHED_AT, job.que_attrs[:finished_at])
+              request_span.set_tag(Ext::TAG_JOB_ARGS, job.que_attrs[:args]) if configuration[:tag_args]
+              request_span.set_tag(Ext::TAG_JOB_DATA, job.que_attrs[:data]) if configuration[:tag_data]
+
+              set_sample_rate(request_span)
+              Contrib::Analytics.set_measured(request_span)
+
+              yield
+            end
+          end
+
+          private
+
+          def set_sample_rate(request_span)
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(
+                request_span,
+                configuration[:analytics_sample_rate]
+              )
+            end
+          end
+
+          def configuration
+            Datadog.configuration.tracing[:que]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# typed: false
+
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/racecar/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Racecar
+        module Configuration
+          # Custom settings for the Racecar 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, default: Ext::DEFAULT_PEER_SERVICE_NAME
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# typed: true
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/active_support/notifications/event'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/racecar/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Racecar
+        # Defines basic behaviors for an ActiveRecord event.
+        module Event
+          def self.included(base)
+            base.include(ActiveSupport::Notifications::Event)
+            base.extend(ClassMethods)
+          end
+
+          # Class methods for Racecar events.
+          # Note, they share the same process method and before_trace method.
+          module ClassMethods
+            def subscription(*args)
+              super.tap do |subscription|
+                subscription.before_trace { ensure_clean_context! }
+              end
+            end
+
+            def span_options
+              { service: configuration[:service_name] }
+            end
+
+            def configuration
+              Datadog.configuration.tracing[:racecar]
+            end
+
+            def process(span, event, _id, payload)
+              span.service = configuration[:service_name]
+              span.resource = payload[:consumer_class]
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+
+              # Tag as an external peer service
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+
+              # 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)
+
+              span.set_tag(Ext::TAG_TOPIC, payload[:topic])
+              span.set_tag(Ext::TAG_CONSUMER, payload[:consumer_class])
+              span.set_tag(Ext::TAG_PARTITION, payload[:partition])
+              span.set_tag(Ext::TAG_OFFSET, payload[:offset]) if payload.key?(:offset)
+              span.set_tag(Ext::TAG_FIRST_OFFSET, payload[:first_offset]) if payload.key?(:first_offset)
+              span.set_tag(Ext::TAG_MESSAGE_COUNT, payload[:message_count]) if payload.key?(:message_count)
+              span.set_error(payload[:exception_object]) if payload[:exception_object]
+            end
+
+            private
+
+            # Context objects are thread-bound.
+            # If Racecar re-uses threads, context from a previous trace
+            # could leak into the new trace. This "cleans" current context,
+            # preventing such a leak.
+            def ensure_clean_context!
+              return unless Tracing.active_span
+
+              Tracing.send(:tracer).provider.context = Context.new
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/racecar/events/batch.rb

@@ -0,0 +1,35 @@
+# typed: false
+
+require 'datadog/tracing/contrib/racecar/ext'
+require 'datadog/tracing/contrib/racecar/event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Racecar
+        module Events
+          # Defines instrumentation for process_batch.racecar event
+          module Batch
+            include Racecar::Event
+
+            EVENT_NAME = 'process_batch.racecar'.freeze
+
+            module_function
+
+            def event_name
+              self::EVENT_NAME
+            end
+
+            def span_name
+              Ext::SPAN_BATCH
+            end
+
+            def span_options
+              super.merge(tags: { Tracing::Metadata::Ext::TAG_OPERATION => Ext::TAG_OPERATION_BATCH })
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/racecar/events/consume.rb

@@ -0,0 +1,35 @@
+# typed: false
+
+require 'datadog/tracing/contrib/racecar/ext'
+require 'datadog/tracing/contrib/racecar/event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Racecar
+        module Events
+          # Defines instrumentation for main_loop.racecar event
+          module Consume
+            include Racecar::Event
+
+            EVENT_NAME = 'main_loop.racecar'.freeze
+
+            module_function
+
+            def event_name
+              self::EVENT_NAME
+            end
+
+            def span_name
+              Ext::SPAN_CONSUME
+            end
+
+            def span_options
+              super.merge(tags: { Tracing::Metadata::Ext::TAG_OPERATION => Ext::TAG_OPERATION_CONSUME })
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/racecar/events/message.rb

@@ -0,0 +1,35 @@
+# typed: false
+
+require 'datadog/tracing/contrib/racecar/ext'
+require 'datadog/tracing/contrib/racecar/event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Racecar
+        module Events
+          # Defines instrumentation for process_message.racecar event
+          module Message
+            include Racecar::Event
+
+            EVENT_NAME = 'process_message.racecar'.freeze
+
+            module_function
+
+            def event_name
+              self::EVENT_NAME
+            end
+
+            def span_name
+              Ext::SPAN_MESSAGE
+            end
+
+            def span_options
+              super.merge(tags: { Tracing::Metadata::Ext::TAG_OPERATION => Ext::TAG_OPERATION_MESSAGE })
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# typed: false
+
+require 'datadog/tracing/contrib/racecar/events/batch'
+require 'datadog/tracing/contrib/racecar/events/message'
+require 'datadog/tracing/contrib/racecar/events/consume'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Racecar
+        # Defines collection of instrumented Racecar events
+        module Events
+          ALL = [
+            Events::Consume,
+            Events::Batch,
+            Events::Message
+          ].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/racecar/ext.rb

@@ -0,0 +1,31 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Racecar
+        # Racecar integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_RACECAR_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_RACECAR_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RACECAR_ANALYTICS_SAMPLE_RATE'.freeze
+          DEFAULT_PEER_SERVICE_NAME = 'racecar'.freeze
+          SPAN_CONSUME = 'racecar.consume'.freeze
+          SPAN_BATCH = 'racecar.batch'.freeze
+          SPAN_MESSAGE = 'racecar.message'.freeze
+          TAG_CONSUMER = 'kafka.consumer'.freeze
+          TAG_FIRST_OFFSET = 'kafka.first_offset'.freeze
+          TAG_MESSAGE_COUNT = 'kafka.message_count'.freeze
+          TAG_OFFSET = 'kafka.offset'.freeze
+          TAG_PARTITION = 'kafka.partition'.freeze
+          TAG_TOPIC = 'kafka.topic'.freeze
+          TAG_COMPONENT = 'racecar'.freeze
+          TAG_OPERATION_CONSUME = 'consume'.freeze
+          TAG_OPERATION_BATCH = 'batch'.freeze
+          TAG_OPERATION_MESSAGE = 'message'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# typed: false
+
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/racecar/configuration/settings'
+require 'datadog/tracing/contrib/racecar/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Racecar
+        # Description of Racecar integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('0.3.5')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :racecar, auto_patch: false
+
+          def self.version
+            Gem.loaded_specs['racecar'] && Gem.loaded_specs['racecar'].version
+          end
+
+          def self.loaded?
+            !defined?(::Racecar).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