ddtrace 0.40.0 → 0.45.0

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

@@ -0,0 +1,23 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/cucumber/instrumentation'
+
+module Datadog
+  module Contrib
+    module Cucumber
+      # Patcher enables patching of 'cucumber' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def target_version
+          Integration.version
+        end
+
+        def patch
+          ::Cucumber::Runtime.send(:include, Instrumentation)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/dalli/instrumentation.rb

@@ -1,3 +1,4 @@
+require 'ddtrace/ext/integration'
 require 'ddtrace/ext/net'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/dalli/ext'
@@ -20,6 +21,9 @@ module Datadog
               span.service = datadog_configuration[:service_name]
               span.span_type = Datadog::Contrib::Dalli::Ext::SPAN_TYPE_COMMAND
 
+              # 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?(datadog_configuration[:analytics_enabled])
                 Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])

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

@@ -23,6 +23,8 @@ module Datadog
           end
 
           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/delayed_job/ext.rb

@@ -10,7 +10,9 @@ module Datadog
         ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'.freeze
         ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'delayed_job'.freeze
+        CLIENT_SERVICE_NAME = 'delayed_job-client'.freeze
         SPAN_JOB = 'delayed_job'.freeze
+        SPAN_ENQUEUE = 'delayed_job.enqueue'.freeze
         TAG_ATTEMPTS = 'delayed_job.attempts'.freeze
         TAG_ID = 'delayed_job.id'.freeze
         TAG_PRIORITY = 'delayed_job.priority'.freeze

data/lib/ddtrace/contrib/delayed_job/plugin.rb

@@ -7,22 +7,13 @@ module Datadog
     module DelayedJob
       # DelayedJob plugin that instruments invoke_job hook
       class Plugin < Delayed::Plugin
-        def self.instrument(job, &block)
+        def self.instrument_invoke(job, &block)
           return block.call(job) unless tracer && tracer.enabled
 
-          # When DelayedJob is used through ActiveJob, we need to parse the payload differentely
-          # to get the actual job name
-          job_name = if job.payload_object.respond_to?(:job_data)
-                       job.payload_object.job_data['job_class']
-                     else
-                       job.name
-                     end
-
-          tracer.trace(Ext::SPAN_JOB, service: configuration[:service_name], resource: job_name) do |span|
-            # Set analytics sample rate
-            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-            end
+          tracer.trace(Ext::SPAN_JOB, service: configuration[:service_name], resource: job_name(job),
+                                      on_error: configuration[:error_handler]) do |span|
+
+            set_sample_rate(span)
 
             # Measure service stats
             Contrib::Analytics.set_measured(span)
@@ -37,6 +28,23 @@ module Datadog
           end
         end
 
+        def self.instrument_enqueue(job, &block)
+          return block.call(job) unless tracer && tracer.enabled
+
+          tracer.trace(Ext::SPAN_ENQUEUE, service: configuration[:client_service_name], resource: job_name(job)) do |span|
+            set_sample_rate(span)
+
+            # Measure service stats
+            Contrib::Analytics.set_measured(span)
+
+            span.set_tag(Ext::TAG_QUEUE, job.queue) if job.queue
+            span.set_tag(Ext::TAG_PRIORITY, job.priority)
+            span.span_type = Datadog::Ext::AppTypes::WORKER
+
+            yield job
+          end
+        end
+
         def self.flush(worker, &block)
           yield worker
 
@@ -51,8 +59,24 @@ module Datadog
           configuration[:tracer]
         end
 
+        def self.job_name(job)
+          # When DelayedJob is used through ActiveJob, we need to parse the payload differentely
+          # to get the actual job name
+          return job.payload_object.job_data['job_class'] if job.payload_object.respond_to?(:job_data)
+
+          job.name
+        end
+
+        def self.set_sample_rate(span)
+          # Set analytics sample rate
+          if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+            Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+          end
+        end
+
         callbacks do |lifecycle|
-          lifecycle.around(:invoke_job, &method(:instrument))
+          lifecycle.around(:invoke_job, &method(:instrument_invoke))
+          lifecycle.around(:enqueue, &method(:instrument_enqueue))
           lifecycle.around(:execute, &method(:flush))
         end
       end

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

@@ -1,5 +1,6 @@
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
+require 'ddtrace/ext/integration'
 require 'ddtrace/ext/net'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/elasticsearch/ext'
@@ -77,6 +78,9 @@ module Datadog
                   params = JSON.generate(params) if params && !params.is_a?(String)
                   body = JSON.generate(body) if body && !body.is_a?(String)
 
+                  # 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?(datadog_configuration[:analytics_enabled])
                     Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])

data/lib/ddtrace/contrib/ethon/easy_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/ethon/ext'
 require 'ddtrace/contrib/http_annotation_helper'
@@ -12,8 +13,8 @@ module Datadog
         def self.included(base)
           base.send(:prepend, InstanceMethods)
         end
-
         # InstanceMethods - implementing instrumentation
+        # rubocop:disable Metrics/ModuleLength
         module InstanceMethods
           include Datadog::Contrib::HttpAnnotationHelper
 
@@ -98,20 +99,22 @@ module Datadog
 
           def datadog_tag_request
             span = @datadog_span
-            method = 'N/A'
+            method = Ext::NOT_APPLICABLE_METHOD
             if instance_variable_defined?(:@datadog_method) && !@datadog_method.nil?
               method = @datadog_method.to_s
             end
             span.resource = method
-
+            # 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?
 
-            return unless uri
-            span.set_tag(Datadog::Ext::HTTP::URL, uri.path)
+            this_uri = uri
+            return unless this_uri
+            span.set_tag(Datadog::Ext::HTTP::URL, this_uri.path)
             span.set_tag(Datadog::Ext::HTTP::METHOD, method)
-            span.set_tag(Datadog::Ext::NET::TARGET_HOST, uri.host)
-            span.set_tag(Datadog::Ext::NET::TARGET_PORT, uri.port)
+            span.set_tag(Datadog::Ext::NET::TARGET_HOST, this_uri.host)
+            span.set_tag(Datadog::Ext::NET::TARGET_PORT, this_uri.port)
           end
 
           def set_span_error_message(message)

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

@@ -12,6 +12,7 @@ module Datadog
         SERVICE_NAME = 'ethon'.freeze
         SPAN_REQUEST = 'ethon.request'.freeze
         SPAN_MULTI_REQUEST = 'ethon.multi.request'.freeze
+        NOT_APPLICABLE_METHOD = 'N/A'.freeze
       end
     end
   end

data/lib/ddtrace/contrib/ethon/multi_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/ethon/ext'
 
@@ -52,6 +53,9 @@ module Datadog
               service: datadog_configuration[:service_name]
             )
 
+            # Tag as an external peer service
+            @datadog_multi_span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, @datadog_multi_span.service)
+
             # Set analytics sample rate
             Contrib::Analytics.set_sample_rate(@datadog_multi_span, analytics_sample_rate) if analytics_enabled?
 

data/lib/ddtrace/contrib/excon/middleware.rb

@@ -1,5 +1,6 @@
 require 'excon'
 require 'ddtrace/ext/http'
+require 'ddtrace/ext/integration'
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/distributed'
 require 'ddtrace/propagation/http_propagator'
@@ -62,6 +63,12 @@ module Datadog
               @options
             end
 
+            # default_options in this case contains our specific middleware options
+            # so we want it to take precedence in build_request_options
+            def build_request_options!(datum)
+              datadog_configuration(datum[:host]).options_hash.merge(@default_options)
+            end
+
             def initialize(stack)
               super(stack, self.class.options)
             end
@@ -108,6 +115,9 @@ module Datadog
           span.service = service_name(datum[:host], @options)
           span.span_type = Datadog::Ext::HTTP::TYPE_OUTBOUND
 
+          # Tag as an external peer service
+          span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
           # Set analytics sample rate
           if analytics_enabled?
             Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
@@ -145,7 +155,7 @@ module Datadog
         end
 
         def build_request_options!(datum)
-          datadog_configuration(datum[:host]).options_hash.merge(@default_options)
+          @default_options.merge(datadog_configuration(datum[:host]).options_hash)
         end
 
         def datadog_configuration(host = :default)

data/lib/ddtrace/contrib/extensions.rb

@@ -27,8 +27,26 @@ module Datadog
 
           # Activate integrations
           if target.respond_to?(:integrations_pending_activation)
+            reduce_verbosity = target.respond_to?(:reduce_verbosity?) ? target.reduce_verbosity? : false
             target.integrations_pending_activation.each do |integration|
-              integration.patch if integration.respond_to?(:patch)
+              next unless integration.respond_to?(:patch)
+              # integration.patch returns either true or a hash of details on why patching failed
+              patch_results = integration.patch
+
+              next if patch_results == true
+
+              # if patching failed, only log output if verbosity is unset
+              # or if patching failure is due to compatibility or integration specific reasons
+              next unless !reduce_verbosity ||
+                          ((patch_results[:available] && patch_results[:loaded]) &&
+                           (!patch_results[:compatible] || !patch_results[:patchable]))
+
+              desc = "Available?: #{patch_results[:available]}"
+              desc += ", Loaded? #{patch_results[:loaded]}"
+              desc += ", Compatible? #{patch_results[:compatible]}"
+              desc += ", Patchable? #{patch_results[:patchable]}"
+
+              Datadog.logger.warn("Unable to patch #{patch_results['name']} (#{desc})")
             end
 
             target.integrations_pending_activation.clear
@@ -86,6 +104,14 @@ module Datadog
             registry[name] ||
               raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
           end
+
+          def reduce_verbosity?
+            defined?(@reduce_verbosity) ? @reduce_verbosity : false
+          end
+
+          def reduce_log_verbosity
+            @reduce_verbosity ||= true
+          end
         end
       end
     end

data/lib/ddtrace/contrib/faraday/middleware.rb

@@ -1,5 +1,6 @@
 require 'faraday'
 require 'ddtrace/ext/http'
+require 'ddtrace/ext/integration'
 require 'ddtrace/ext/net'
 require 'ddtrace/propagation/http_propagator'
 require 'ddtrace/contrib/analytics'
@@ -41,6 +42,9 @@ module Datadog
           span.service = options[:split_by_domain] ? env[:url].host : options[:service_name]
           span.span_type = Datadog::Ext::HTTP::TYPE_OUTBOUND
 
+          # 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?(options[:analytics_enabled])
             Contrib::Analytics.set_sample_rate(span, options[:analytics_sample_rate])

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

@@ -30,7 +30,7 @@ module Datadog
             .new(
               get_option(:service_name),
               app: Ext::APP,
-              app_type: Datadog::Ext::AppTypes::WEB,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
               tracer: -> { get_option(:tracer) }
             ).onto(::Faraday)
         end

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

@@ -1,6 +1,7 @@
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/ext/http'
 require 'ddtrace/contrib/grape/ext'
+require 'ddtrace/contrib/status_code_matcher'
 
 module Datadog
   module Contrib
@@ -24,6 +25,12 @@ module Datadog
           end
 
           option :service_name, default: Ext::SERVICE_NAME
+
+          option :error_statuses, default: nil do |o|
+            o.setter do |new_value, _old_value|
+              Datadog::Contrib::StatusCodeMatcher.new(new_value) unless new_value.nil?
+            end
+          end
         end
       end
     end

data/lib/ddtrace/contrib/grape/endpoint.rb

@@ -61,17 +61,12 @@ module Datadog
             begin
               # collect endpoint details
               api = payload[:endpoint].options[:for]
-              # If the API inherits from Grape::API in version >= 1.2.0
-              # then the API will be an instance and the name must be derived from the base.
-              # See https://github.com/ruby-grape/grape/issues/1825
-              api_view = if defined?(::Grape::API::Instance) && api <= ::Grape::API::Instance
-                           api.base.to_s
-                         else
-                           api.to_s
-                         end
-
-              path = payload[:endpoint].options[:path].join('/')
-              resource = "#{api_view}##{path}"
+
+              api_view = api_view(api)
+
+              request_method = payload[:endpoint].options[:method].first
+              path = endpoint_expand_path(payload[:endpoint])
+              resource = "#{api_view} #{request_method} #{path}"
               span.resource = resource
 
               # set the request span resource if it's a `rack.request` span
@@ -89,13 +84,20 @@ module Datadog
               Contrib::Analytics.set_measured(span)
 
               # catch thrown exceptions
-              span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?
+
+              if exception_is_error?(payload[:exception_object])
+                span.set_error(payload[:exception_object])
+              end
 
               # override the current span with this notification values
               span.set_tag(Ext::TAG_ROUTE_ENDPOINT, api_view) unless api_view.nil?
               span.set_tag(Ext::TAG_ROUTE_PATH, path)
+              span.set_tag(Ext::TAG_ROUTE_METHOD, request_method)
+
+              span.set_tag(Datadog::Ext::HTTP::METHOD, request_method)
+              span.set_tag(Datadog::Ext::HTTP::URL, path)
             ensure
-              span.start_time = start
+              span.start(start)
               span.finish(finish)
             end
           rescue StandardError => e
@@ -132,9 +134,11 @@ module Datadog
               # Measure service stats
               Contrib::Analytics.set_measured(span)
 
-              span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?
+              if exception_is_error?(payload[:exception_object])
+                span.set_error(payload[:exception_object])
+              end
             ensure
-              span.start_time = start
+              span.start(start)
               span.finish(finish)
             end
           rescue StandardError => e
@@ -153,7 +157,8 @@ module Datadog
             span = tracer.trace(
               Ext::SPAN_ENDPOINT_RUN_FILTERS,
               service: service_name,
-              span_type: Datadog::Ext::HTTP::TYPE_INBOUND
+              span_type: Datadog::Ext::HTTP::TYPE_INBOUND,
+              start_time: start
             )
 
             begin
@@ -166,10 +171,13 @@ module Datadog
               Contrib::Analytics.set_measured(span)
 
               # catch thrown exceptions
-              span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?
+              if exception_is_error?(payload[:exception_object])
+                span.set_error(payload[:exception_object])
+              end
+
               span.set_tag(Ext::TAG_FILTER_TYPE, type.to_s)
             ensure
-              span.start_time = start
+              span.start(start)
               span.finish(finish)
             end
           rescue StandardError => e
@@ -178,6 +186,25 @@ module Datadog
 
           private
 
+          def api_view(api)
+            # If the API inherits from Grape::API in version >= 1.2.0
+            # then the API will be an instance and the name must be derived from the base.
+            # See https://github.com/ruby-grape/grape/issues/1825
+            if defined?(::Grape::API::Instance) && api <= ::Grape::API::Instance
+              api.base.to_s
+            else
+              api.to_s
+            end
+          end
+
+          def endpoint_expand_path(endpoint)
+            route_path = endpoint.options[:path]
+            namespace = endpoint.routes.first && endpoint.routes.first.namespace || ''
+
+            parts = (namespace.split('/') + route_path).reject { |p| p.blank? || p.eql?('/') }
+            parts.join('/').prepend('/')
+          end
+
           def tracer
             datadog_configuration[:tracer]
           end
@@ -194,6 +221,14 @@ module Datadog
             datadog_configuration[:analytics_sample_rate]
           end
 
+          def exception_is_error?(exception)
+            matcher = datadog_configuration[:error_statuses]
+            return false unless exception
+            return true unless matcher
+            return true unless exception.respond_to?('status')
+            matcher.include?(exception.status)
+          end
+
           def enabled?
             datadog_configuration[:enabled] == true
           end