ddtrace 0.13.0 → 0.47.0

data/lib/ddtrace/contrib/que/tracer.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'ddtrace/contrib/analytics'
+
+module Datadog
+  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: Datadog::Ext::AppTypes::WORKER,
+            on_error: configuration[:error_handler]
+          }
+
+          tracer.trace(Ext::SPAN_JOB, trace_options) do |request_span|
+            request_span.resource = job.class.name.to_s
+            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 tracer
+          configuration[:tracer]
+        end
+
+        def configuration
+          Datadog.configuration[Datadog::Contrib::Que::Ext::APP.to_sym]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/racecar/ext'
+
+module Datadog
+  module Contrib
+    module Racecar
+      module Configuration
+        # Custom settings for the Racecar 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
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,7 @@
+require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/active_support/notifications/event'
+require 'ddtrace/contrib/racecar/ext'
+require 'ddtrace/ext/integration'
 
 module Datadog
   module Contrib
@@ -24,7 +27,7 @@ module Datadog
           end
 
           def tracer
-            configuration[:tracer]
+            -> { configuration[:tracer] }
           end
 
           def configuration
@@ -35,12 +38,23 @@ module Datadog
             span.service = configuration[:service_name]
             span.resource = payload[:consumer_class]
 
-            span.set_tag('kafka.topic', payload[:topic])
-            span.set_tag('kafka.consumer', payload[:consumer_class])
-            span.set_tag('kafka.partition', payload[:partition])
-            span.set_tag('kafka.offset', payload[:offset]) if payload.key?(:offset)
-            span.set_tag('kafka.first_offset', payload[:first_offset]) if payload.key?(:first_offset)
-            span.set_tag('kafka.message_count', payload[:message_count]) if payload.key?(:message_count)
+            # Tag as an external peer service
+            span.set_tag(Datadog::Ext::Integration::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
 
@@ -52,6 +66,7 @@ module Datadog
           # preventing such a leak.
           def ensure_clean_context!
             return unless configuration[:tracer].call_context.current_span
+
             configuration[:tracer].provider.context = Context.new
           end
         end

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

@@ -1,5 +1,6 @@
 require 'ddtrace/contrib/racecar/events/batch'
 require 'ddtrace/contrib/racecar/events/message'
+require 'ddtrace/contrib/racecar/events/consume'
 
 module Datadog
   module Contrib
@@ -7,6 +8,7 @@ module Datadog
       # Defines collection of instrumented Racecar events
       module Events
         ALL = [
+          Events::Consume,
           Events::Batch,
           Events::Message
         ].freeze

data/lib/ddtrace/contrib/racecar/events/batch.rb

@@ -1,3 +1,4 @@
+require 'ddtrace/contrib/racecar/ext'
 require 'ddtrace/contrib/racecar/event'
 
 module Datadog
@@ -9,7 +10,6 @@ module Datadog
           include Racecar::Event
 
           EVENT_NAME = 'process_batch.racecar'.freeze
-          SPAN_NAME = 'racecar.batch'.freeze
 
           module_function
 
@@ -18,7 +18,7 @@ module Datadog
           end
 
           def span_name
-            self::SPAN_NAME
+            Ext::SPAN_BATCH
           end
         end
       end

data/lib/ddtrace/contrib/racecar/events/consume.rb

@@ -0,0 +1,27 @@
+require 'ddtrace/contrib/racecar/ext'
+require 'ddtrace/contrib/racecar/event'
+
+module Datadog
+  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
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/racecar/events/message.rb

@@ -1,3 +1,4 @@
+require 'ddtrace/contrib/racecar/ext'
 require 'ddtrace/contrib/racecar/event'
 
 module Datadog
@@ -9,7 +10,6 @@ module Datadog
           include Racecar::Event
 
           EVENT_NAME = 'process_message.racecar'.freeze
-          SPAN_NAME = 'racecar.message'.freeze
 
           module_function
 
@@ -18,7 +18,7 @@ module Datadog
           end
 
           def span_name
-            self::SPAN_NAME
+            Ext::SPAN_MESSAGE
           end
         end
       end

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

@@ -0,0 +1,25 @@
+module Datadog
+  module Contrib
+    module Racecar
+      # Racecar integration constants
+      module Ext
+        APP = 'racecar'.freeze
+        ENV_ENABLED = 'DD_TRACE_RACECAR_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_RACECAR_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_RACECAR_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RACECAR_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_RACECAR_ANALYTICS_SAMPLE_RATE'.freeze
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/racecar/configuration/settings'
+require 'ddtrace/contrib/racecar/patcher'
+
+module Datadog
+  module Contrib
+    module Racecar
+      # Description of Racecar integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('0.3.5')
+
+        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 default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -1,55 +1,24 @@
+require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/racecar/ext'
 require 'ddtrace/contrib/racecar/events'
 
 module Datadog
   module Contrib
     module Racecar
-      # Provides instrumentation for `racecar` through ActiveSupport instrumentation signals
+      # Patcher enables patching of 'racecar' module.
       module Patcher
-        include Base
+        include Contrib::Patcher
 
-        register_as :racecar
-        option :service_name, default: 'racecar'
-        option :tracer, default: Datadog.tracer do |value|
-          (value || Datadog.tracer).tap do |v|
-            # Make sure to update tracers of all subscriptions
-            Events.subscriptions.each do |subscription|
-              subscription.tracer = v
-            end
-          end
-        end
-
-        class << self
-          def patch
-            return patched? if patched? || !compatible?
-
-            # Subscribe to Racecar events
-            Events.subscribe!
-
-            # Set service info
-            configuration[:tracer].set_service_info(
-              configuration[:service_name],
-              'racecar',
-              Ext::AppTypes::WORKER
-            )
+        module_function
 
-            @patched = true
-          end
-
-          def patched?
-            return @patched if defined?(@patched)
-            @patched = false
-          end
-
-          private
-
-          def configuration
-            Datadog.configuration[:racecar]
-          end
+        def target_version
+          Integration.version
+        end
 
-          def compatible?
-            defined?(::Racecar) && defined?(::ActiveSupport::Notifications)
-          end
+        def patch
+          # Subscribe to Racecar events
+          Events.subscribe!
         end
       end
     end

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

@@ -0,0 +1,46 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/rack/ext'
+
+module Datadog
+  module Contrib
+    module Rack
+      module Configuration
+        # Custom settings for the Rack integration
+        class Settings < Contrib::Configuration::Settings
+          DEFAULT_HEADERS = {
+            response: %w[
+              Content-Type
+              X-Request-ID
+            ]
+          }.freeze
+
+          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], nil) }
+            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 :application
+          option :distributed_tracing, default: true
+          option :headers, default: DEFAULT_HEADERS
+          option :middleware_names, default: false
+          option :quantize, default: {}
+          option :request_queuing, default: false
+
+          option :service_name, default: Ext::SERVICE_NAME
+
+          option :web_service_name, default: Ext::WEBSERVER_SERVICE_NAME
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Datadog
+  module Contrib
+    module Rack
+      # Rack integration constants
+      module Ext
+        APP = 'rack'.freeze
+        ENV_ENABLED = 'DD_TRACE_RACK_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_RACK_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_RACK_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RACK_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_RACK_ANALYTICS_SAMPLE_RATE'.freeze
+        RACK_ENV_REQUEST_SPAN = 'datadog.rack_request_span'.freeze
+        SERVICE_NAME = 'rack'.freeze
+        SPAN_HTTP_SERVER_QUEUE = 'http_server.queue'.freeze
+        SPAN_REQUEST = 'rack.request'.freeze
+        WEBSERVER_APP = 'webserver'.freeze
+        WEBSERVER_SERVICE_NAME = 'web-server'.freeze
+      end
+    end
+  end
+end

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

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