ddtrace 0.40.0 → 0.50.0

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

@@ -11,7 +11,7 @@ module Datadog
 
         MINIMUM_VERSION = Gem::Version.new('1.0')
         # Maximum is first version it's NOT compatible with (not inclusive)
-        MAXIMUM_VERSION = Gem::Version.new('2.0')
+        MAXIMUM_VERSION = Gem::Version.new('3.0')
 
         register_as :resque, auto_patch: true
 
@@ -25,7 +25,7 @@ module Datadog
 
         def self.compatible?
           super \
-            && version >= Gem::Version.new('1.0') \
+            && version >= MINIMUM_VERSION \
             && version < MAXIMUM_VERSION
         end
 

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

@@ -17,11 +17,11 @@ module Datadog
 
         def patch
           require_relative 'resque_job'
-          get_option(:workers).each { |worker| worker.extend(ResqueJob) }
-        end
 
-        def get_option(option)
-          Datadog.configuration[:resque].get_option(option)
+          ::Resque::Job.prepend(Resque::Job)
+
+          workers = Datadog.configuration[:resque][:workers] || []
+          workers.each { |worker| worker.extend(ResqueJob) }
         end
       end
     end

data/lib/ddtrace/contrib/resque/resque_job.rb

@@ -7,9 +7,30 @@ require 'resque'
 module Datadog
   module Contrib
     module Resque
+      # Automatically configures jobs with {ResqueJob} plugin.
+      module Job
+        def perform
+          if Datadog.configuration[:resque][:workers].nil?
+            job = payload_class
+            job.extend(Datadog::Contrib::Resque::ResqueJob) unless job.is_a? Datadog::Contrib::Resque::ResqueJob
+          end
+        ensure
+          super
+        end
+      end
+
       # Uses Resque job hooks to create traces
       module ResqueJob
-        def around_perform(*args)
+        # `around_perform` hooks are executed in alphabetical order.
+        # we use the lowest printable character that allows for an inline
+        # method definition ('0'), alongside our naming prefix for identification.
+        #
+        # We could, in theory, use any character (e.g "\x00"), but this will lead
+        # to unreadable stack traces that contain this method call.
+        #
+        # We could also just use `around_perform` but this might override the user's
+        # own method.
+        def around_perform0_ddtrace(*args)
           return yield unless datadog_configuration && tracer
 
           tracer.trace(Ext::SPAN_JOB, span_options) do |span|
@@ -44,11 +65,12 @@ module Datadog
         def forked?
           pin = Datadog::Pin.get_from(::Resque)
           return false unless pin
+
           pin.config[:forked] == true
         end
 
         def span_options
-          { service: datadog_configuration[:service_name] }
+          { service: datadog_configuration[:service_name], on_error: datadog_configuration[:error_handler] }
         end
 
         def tracer
@@ -76,5 +98,6 @@ Resque.after_fork do
 
   # Clean the state so no CoW happens
   next if configuration[:tracer].nil?
+
   configuration[:tracer].provider.context = nil
 end

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

@@ -15,7 +15,7 @@ module Datadog
           require 'ddtrace/ext/app_types'
           require 'ddtrace/contrib/rest_client/request_patch'
 
-          ::RestClient::Request.send(:include, RequestPatch)
+          ::RestClient::Request.include(RequestPatch)
         end
       end
     end

data/lib/ddtrace/contrib/rest_client/request_patch.rb

@@ -1,5 +1,6 @@
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/distributed'
+require 'ddtrace/ext/integration'
 require 'ddtrace/propagation/http_propagator'
 require 'ddtrace/contrib/rest_client/ext'
 
@@ -9,7 +10,7 @@ module Datadog
       # RestClient RequestPatch
       module RequestPatch
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # InstanceMethods - implementing instrumentation
@@ -31,6 +32,9 @@ module Datadog
           def datadog_tag_request(uri, span)
             span.resource = method.to_s.upcase
 
+            # Tag as an external peer service
+            span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
             # Set analytics sample rate
             Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
@@ -50,9 +54,7 @@ module Datadog
             yield(span).tap do |response|
               # Verify return value is a response
               # If so, add additional tags.
-              if response.is_a?(::RestClient::Response)
-                span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.code)
-              end
+              span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.code) if response.is_a?(::RestClient::Response)
             end
           rescue ::RestClient::ExceptionWithResponse => e
             span.set_error(e) if Datadog::Ext::HTTP::ERROR_RANGE.cover?(e.http_code)

data/lib/ddtrace/contrib/sequel/database.rb

@@ -10,7 +10,7 @@ module Datadog
       # Adds instrumentation to Sequel::Database
       module Database
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # Instance methods for instrumenting Sequel::Database
@@ -24,7 +24,7 @@ module Datadog
               span.service = datadog_pin.service
               span.resource = opts[:query]
               span.span_type = Datadog::Ext::SQL::TYPE
-              Utils.set_analytics_sample_rate(span)
+              Utils.set_common_tags(span)
               span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
               response = super(sql, options)
             end
@@ -52,6 +52,8 @@ module Datadog
                       elsif instance_variable_defined?(:@pool) && @pool
                         @pool.db.opts
                       end
+            sql = sql.is_a?(::Sequel::SQL::Expression) ? literal(sql) : sql.to_s
+
             Utils.parse_opts(sql, opts, db_opts)
           end
         end

data/lib/ddtrace/contrib/sequel/dataset.rb

@@ -10,7 +10,7 @@ module Datadog
       # Adds instrumentation to Sequel::Dataset
       module Dataset
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # Instance methods for instrumenting Sequel::Dataset
@@ -38,15 +38,16 @@ module Datadog
           private
 
           def trace_execute(super_method, sql, options, &block)
-            opts = Utils.parse_opts(sql, options, db.opts)
+            opts = Utils.parse_opts(sql, options, db.opts, self)
             response = nil
 
             datadog_pin.tracer.trace(Ext::SPAN_QUERY) do |span|
               span.service = datadog_pin.service
               span.resource = opts[:query]
               span.span_type = Datadog::Ext::SQL::TYPE
-              Utils.set_analytics_sample_rate(span)
+              Utils.set_common_tags(span)
               span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
+              span.set_tag(Ext::TAG_PREPARED_NAME, opts[:prepared_name]) if opts[:prepared_name]
               response = super_method.call(sql, options, &block)
             end
             response

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

@@ -12,6 +12,7 @@ module Datadog
         SERVICE_NAME = 'sequel'.freeze
         SPAN_QUERY = 'sequel.query'.freeze
         TAG_DB_VENDOR = 'sequel.db.vendor'.freeze
+        TAG_PREPARED_NAME = 'sequel.prepared.name'.freeze
       end
     end
   end

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

@@ -21,11 +21,11 @@ module Datadog
         end
 
         def patch_sequel_database
-          ::Sequel::Database.send(:include, Database)
+          ::Sequel::Database.include(Database)
         end
 
         def patch_sequel_dataset
-          ::Sequel::Dataset.send(:include, Dataset)
+          ::Sequel::Dataset.include(Dataset)
         end
       end
     end

data/lib/ddtrace/contrib/sequel/utils.rb

@@ -1,3 +1,5 @@
+require 'ddtrace/ext/integration'
+
 module Datadog
   module Contrib
     module Sequel
@@ -26,21 +28,29 @@ module Datadog
             Datadog::Utils::Database.normalize_vendor(database.database_type.to_s)
           end
 
-          def parse_opts(sql, opts, db_opts)
-            if ::Sequel::VERSION >= '4.37.0' && !sql.is_a?(String)
-              # In 4.37.0, sql was converted to a prepared statement object
-              sql = sql.prepared_sql unless sql.is_a?(Symbol)
+          def parse_opts(sql, opts, db_opts, dataset = nil)
+            # Prepared statements don't provide their sql query in the +sql+ parameter.
+            if !sql.is_a?(String) && (dataset && dataset.respond_to?(:prepared_sql) &&
+              (resolved_sql = dataset.prepared_sql))
+              # The dataset contains the resolved SQL query and prepared statement name.
+              prepared_name = dataset.prepared_statement_name
+              sql = resolved_sql
             end
 
             {
               name: opts[:type],
               query: sql,
+              prepared_name: prepared_name,
               database: db_opts[:database],
               host: db_opts[:host]
             }
           end
 
-          def set_analytics_sample_rate(span)
+          def set_common_tags(span)
+            # Tag as an external peer service
+            span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
+            # Set analytics sample rate
             Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
           end
 

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

@@ -22,6 +22,8 @@ module Datadog
           end
 
           option :service_name, default: Ext::SERVICE_NAME
+          option :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
+          option :tag_body, default: false
         end
       end
     end

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

@@ -8,10 +8,16 @@ module Datadog
         def initialize(options = {})
           @tracer = options[:tracer] || configuration[:tracer]
           @shoryuken_service = options[:service_name] || configuration[:service_name]
+          @error_handler = options[:error_handler] || configuration[:error_handler]
         end
 
         def call(worker_instance, queue, sqs_msg, body)
-          @tracer.trace(Ext::SPAN_JOB, service: @shoryuken_service, span_type: Datadog::Ext::AppTypes::WORKER) do |span|
+          @tracer.trace(
+            Ext::SPAN_JOB,
+            service: @shoryuken_service,
+            span_type: Datadog::Ext::AppTypes::WORKER,
+            on_error: @error_handler
+          ) do |span|
             # Set analytics sample rate
             if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
               Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
@@ -24,7 +30,7 @@ module Datadog
             span.set_tag(Ext::TAG_JOB_ID, sqs_msg.message_id)
             span.set_tag(Ext::TAG_JOB_QUEUE, queue)
             span.set_tag(Ext::TAG_JOB_ATTRIBUTES, sqs_msg.attributes) if sqs_msg.respond_to?(:attributes)
-            span.set_tag(Ext::TAG_JOB_BODY, body)
+            span.set_tag(Ext::TAG_JOB_BODY, body) if configuration[:tag_body]
 
             yield
           end

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

@@ -29,6 +29,7 @@ module Datadog
 
           option :service_name, default: Ext::SERVICE_NAME
           option :client_service_name, default: Ext::CLIENT_SERVICE_NAME
+          option :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
         end
       end
     end

data/lib/ddtrace/contrib/sidekiq/server_tracer.rb

@@ -11,6 +11,7 @@ module Datadog
         def initialize(options = {})
           super
           @sidekiq_service = options[:service_name] || configuration[:service_name]
+          @error_handler = options[:error_handler] || configuration[:error_handler]
         end
 
         def call(worker, job, queue)
@@ -19,7 +20,8 @@ module Datadog
           service = worker_config(resource, :service_name) || @sidekiq_service
           tag_args = worker_config(resource, :tag_args) || configuration[:tag_args]
 
-          @tracer.trace(Ext::SPAN_JOB, service: service, span_type: Datadog::Ext::AppTypes::WORKER) do |span|
+          @tracer.trace(Ext::SPAN_JOB, service: service, span_type: Datadog::Ext::AppTypes::WORKER,
+                                       on_error: @error_handler) do |span|
             span.resource = resource
             # Set analytics sample rate
             if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
@@ -35,9 +37,7 @@ module Datadog
             span.set_tag(Ext::TAG_JOB_QUEUE, job['queue'])
             span.set_tag(Ext::TAG_JOB_WRAPPER, job['class']) if job['wrapped']
             span.set_tag(Ext::TAG_JOB_DELAY, 1000.0 * (Time.now.utc.to_f - job['enqueued_at'].to_f))
-            if tag_args && !job['args'].nil? && !job['args'].empty?
-              span.set_tag(Ext::TAG_JOB_ARGS, job['args'])
-            end
+            span.set_tag(Ext::TAG_JOB_ARGS, job['args']) if tag_args && !job['args'].nil? && !job['args'].empty?
 
             yield
           end
@@ -57,9 +57,7 @@ module Datadog
             nil
           end
 
-          if worker_klass.respond_to?(:datadog_tracer_config)
-            worker_klass.datadog_tracer_config[key]
-          end
+          worker_klass.datadog_tracer_config[key] if worker_klass.respond_to?(:datadog_tracer_config)
         end
       end
     end

data/lib/ddtrace/contrib/sidekiq/tracing.rb

@@ -31,7 +31,6 @@ module Datadog
           job['class'].to_s
         end
 
-        #
         def delay_extension_class(job)
           clazz, method = YAML.parse(job['args'].first).children.first.children
 

data/lib/ddtrace/contrib/sinatra/env.rb

@@ -23,9 +23,7 @@ module Datadog
           {}.tap do |result|
             headers.each do |header|
               rack_header = header_to_rack_header(header)
-              if env.key?(rack_header)
-                result[Datadog::Ext::HTTP::RequestHeaders.to_tag(header)] = env[rack_header]
-              end
+              result[Datadog::Ext::HTTP::RequestHeaders.to_tag(header)] = env[rack_header] if env.key?(rack_header)
             end
           end
         end

data/lib/ddtrace/contrib/sinatra/headers.rb

@@ -18,9 +18,7 @@ module Datadog
                 # Try a case-insensitive lookup
                 uppercased_header = header.to_s.upcase
                 matching_header = headers.keys.find { |h| h.upcase == uppercased_header }
-                if matching_header
-                  result[Datadog::Ext::HTTP::ResponseHeaders.to_tag(header)] = headers[matching_header]
-                end
+                result[Datadog::Ext::HTTP::ResponseHeaders.to_tag(header)] = headers[matching_header] if matching_header
               end
             end
           end

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

@@ -20,7 +20,7 @@ module Datadog
 
         def register_tracer
           ::Sinatra.send(:register, Datadog::Contrib::Sinatra::Tracer)
-          ::Sinatra::Base.send(:prepend, Sinatra::Tracer::Base)
+          ::Sinatra::Base.prepend(Sinatra::Tracer::Base)
         end
       end
     end

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

@@ -110,9 +110,7 @@ module Datadog
 
               span.set_tag(Ext::TAG_APP_NAME, settings.name || settings.superclass.name)
               span.set_tag(Ext::TAG_ROUTE_PATH, @datadog_route)
-              if request.script_name && !request.script_name.empty?
-                span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name)
-              end
+              span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name) if request.script_name && !request.script_name.empty?
 
               rack_request_span = env[Datadog::Contrib::Rack::TraceMiddleware::RACK_REQUEST_SPAN]
               rack_request_span.resource = span.resource if rack_request_span

data/lib/ddtrace/contrib/sinatra/tracer_middleware.rb

@@ -8,13 +8,15 @@ module Datadog
     module Sinatra
       # Middleware used for automatically tagging configured headers and handle request span
       class TracerMiddleware
-        def initialize(app, app_instance: nil)
+        def initialize(app, opt = {})
           @app = app
-          @app_instance = app_instance
+          @app_instance = opt[:app_instance]
         end
 
         # rubocop:disable Metrics/AbcSize
         # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/PerceivedComplexity
         def call(env)
           # Set the trace context (e.g. distributed tracing)
           if configuration[:distributed_tracing] && tracer.provider.context.trace_id.nil?
@@ -40,9 +42,7 @@ module Datadog
               request = ::Sinatra::Request.new(env)
               span.set_tag(Datadog::Ext::HTTP::URL, request.path)
               span.set_tag(Datadog::Ext::HTTP::METHOD, request.request_method)
-              if request.script_name && !request.script_name.empty?
-                span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name)
-              end
+              span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name) if request.script_name && !request.script_name.empty?
 
               span.set_tag(Ext::TAG_APP_NAME, @app_instance.settings.name)
 

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

@@ -24,6 +24,7 @@ module Datadog
           end
 
           option :service_name, default: Ext::SERVICE_NAME
+          option :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
           option :tag_body, default: false
         end
       end

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

@@ -5,17 +5,17 @@ module Datadog
     module Sneakers
       # Sneakers integration constants
       module Ext
-        APP = 'sneakers'.freeze
-        ENV_ENABLED = 'DD_TRACE_SNEAKERS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_SNEAKERS_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_SNEAKERS_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SNEAKERS_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_SNEAKERS_ANALYTICS_SAMPLE_RATE'.freeze
-        SERVICE_NAME = 'sneakers'.freeze
-        SPAN_JOB = 'sneakers.job'.freeze
-        TAG_JOB_ROUTING_KEY = 'sneakers.routing_key'.freeze
-        TAG_JOB_QUEUE = 'sneakers.queue'.freeze
-        TAG_JOB_BODY = 'sneakers.body'.freeze
+        APP = 'sneakers'
+        ENV_ENABLED = 'DD_TRACE_SNEAKERS_ENABLED'
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_SNEAKERS_ANALYTICS_ENABLED'
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_SNEAKERS_ANALYTICS_ENABLED'
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SNEAKERS_ANALYTICS_SAMPLE_RATE'
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_SNEAKERS_ANALYTICS_SAMPLE_RATE'
+        SERVICE_NAME = 'sneakers'
+        SPAN_JOB = 'sneakers.job'
+        TAG_JOB_ROUTING_KEY = 'sneakers.routing_key'
+        TAG_JOB_QUEUE = 'sneakers.queue'
+        TAG_JOB_BODY = 'sneakers.body'
       end
     end
   end