ddtrace 0.42.0 → 0.47.0

data/lib/ddtrace/contrib/rspec/example.rb

@@ -0,0 +1,75 @@
+module Datadog
+  module Contrib
+    module RSpec
+      # Instrument RSpec::Core::Example
+      module Example
+        def self.included(base)
+          base.send(:prepend, InstanceMethods)
+        end
+
+        # Instance methods for configuration
+        module InstanceMethods
+          def run(example_group_instance, reporter)
+            return super unless configuration[:enabled]
+
+            test_name = full_description.strip
+            if metadata[:description].empty?
+              # for unnamed it blocks this appends something like "example at ./spec/some_spec.rb:10"
+              test_name += " #{description}"
+            end
+
+            trace_options = {
+              app: Ext::APP,
+              resource: test_name,
+              service: configuration[:service_name],
+              span_type: Datadog::Ext::AppTypes::TEST,
+              tags: tags.merge(Datadog.configuration.tags)
+            }
+
+            tracer.trace(configuration[:operation_name], trace_options) do |span|
+              span.set_tag(Datadog::Ext::Test::TAG_FRAMEWORK, Ext::FRAMEWORK)
+              span.set_tag(Datadog::Ext::Test::TAG_NAME, test_name)
+              span.set_tag(Datadog::Ext::Test::TAG_SUITE, file_path)
+              span.set_tag(Datadog::Ext::Test::TAG_TYPE, Ext::TEST_TYPE)
+              span.set_tag(Datadog::Ext::Test::TAG_SPAN_KIND, Datadog::Ext::AppTypes::TEST)
+
+              # Measure service stats
+              Contrib::Analytics.set_measured(span)
+
+              result = super
+
+              case execution_result.status
+              when :passed
+                span.set_tag(Datadog::Ext::Test::TAG_STATUS, Datadog::Ext::Test::Status::PASS)
+              when :failed
+                span.status = 1
+                span.set_tag(Datadog::Ext::Test::TAG_STATUS, Datadog::Ext::Test::Status::FAIL)
+                span.set_error(execution_result.exception)
+              else
+                if execution_result.example_skipped?
+                  span.set_tag(Datadog::Ext::Test::TAG_STATUS, Datadog::Ext::Test::Status::SKIP)
+                end
+              end
+
+              result
+            end
+          end
+
+          private
+
+          def configuration
+            Datadog.configuration[:rspec]
+          end
+
+          def tracer
+            configuration[:tracer]
+          end
+
+          def tags
+            @tags ||= Datadog::Ext::CI.tags(ENV)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Datadog
+  module Contrib
+    module RSpec
+      # RSpec integration constants
+      module Ext
+        APP = 'rspec'.freeze
+        ENV_ENABLED = 'DD_TRACE_RSPEC_ENABLED'.freeze
+        ENV_OPERATION_NAME = 'DD_TRACE_RSPEC_OPERATION_NAME'.freeze
+        FRAMEWORK = 'rspec'.freeze
+        OPERATION_NAME = 'rspec.example'.freeze
+        SERVICE_NAME = 'rspec'.freeze
+        TEST_TYPE = 'test'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/rspec/configuration/settings'
+require 'ddtrace/contrib/rspec/patcher'
+require 'ddtrace/contrib/integration'
+
+module Datadog
+  module Contrib
+    module RSpec
+      # Description of RSpec integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('3.0.0')
+
+        register_as :rspec, auto_patch: true
+
+        def self.version
+          Gem.loaded_specs['rspec'] \
+            && Gem.loaded_specs['rspec'].version
+        end
+
+        def self.loaded?
+          !defined?(::RSpec).nil? && !defined?(::RSpec::Core).nil? && \
+            !defined?(::RSpec::Core::Example).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
+        end
+
+        # test environments should not auto instrument test libraries
+        def auto_instrument?
+          false
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/rspec/example'
+
+module Datadog
+  module Contrib
+    module RSpec
+      # Patcher enables patching of 'rspec' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def target_version
+          Integration.version
+        end
+
+        def patch
+          ::RSpec::Core::Example.send(:include, Example)
+        end
+      end
+    end
+  end
+end

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

@@ -30,12 +30,11 @@ module Datadog
 
           def parse_opts(sql, opts, db_opts, dataset = nil)
             # Prepared statements don't provide their sql query in the +sql+ parameter.
-            unless sql.is_a?(String)
-              if 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
+            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
 
             {

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

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

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

@@ -8,10 +8,12 @@ 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])

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/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

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

@@ -14,33 +14,28 @@ module Datadog
 
         def call(deserialized_msg, delivery_info, metadata, handler)
           trace_options = {
-            service:   configuration[:service_name],
-            span_type: Datadog::Ext::AppTypes::WORKER
+            service: configuration[:service_name],
+            span_type: Datadog::Ext::AppTypes::WORKER,
+            on_error: configuration[:error_handler]
           }
-          request_span = tracer.trace(Ext::SPAN_JOB, trace_options)
 
-          # Set analytics sample rate
-          if Datadog::Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-            Datadog::Contrib::Analytics.set_sample_rate(request_span, configuration[:analytics_sample_rate])
-          end
+          tracer.trace(Ext::SPAN_JOB, trace_options) do |request_span|
+            # Set analytics sample rate
+            if Datadog::Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Datadog::Contrib::Analytics.set_sample_rate(request_span, configuration[:analytics_sample_rate])
+            end
 
-          # Measure service stats
-          Contrib::Analytics.set_measured(request_span)
+            # Measure service stats
+            Contrib::Analytics.set_measured(request_span)
 
-          request_span.resource = @app.to_proc.binding.eval('self.class').to_s
-          request_span.set_tag(Ext::TAG_JOB_ROUTING_KEY, delivery_info.routing_key)
-          request_span.set_tag(Ext::TAG_JOB_QUEUE, delivery_info.consumer.queue.name)
+            request_span.resource = @app.to_proc.binding.eval('self.class').to_s
+            request_span.set_tag(Ext::TAG_JOB_ROUTING_KEY, delivery_info.routing_key)
+            request_span.set_tag(Ext::TAG_JOB_QUEUE, delivery_info.consumer.queue.name)
 
-          if configuration[:tag_body]
-            request_span.set_tag(Ext::TAG_JOB_BODY, deserialized_msg)
-          end
+            request_span.set_tag(Ext::TAG_JOB_BODY, deserialized_msg) if configuration[:tag_body]
 
-          @app.call(deserialized_msg, delivery_info, metadata, handler)
-        rescue StandardError => e
-          request_span.set_error(e) unless request_span.nil?
-          raise e
-        ensure
-          request_span.finish if request_span
+            @app.call(deserialized_msg, delivery_info, metadata, handler)
+          end
         end
 
         private

data/lib/ddtrace/contrib/status_code_matcher.rb

@@ -0,0 +1,69 @@
+require 'set'
+require 'ddtrace/ext/http'
+
+module Datadog
+  module Contrib
+    # Contains methods helpful for tracing/annotating HTTP request libraries
+    class StatusCodeMatcher
+      REGEX_PARSER = /^\d{3}(?:-\d{3})?(?:,\d{3}(?:-\d{3})?)*$/.freeze
+
+      def initialize(range)
+        @error_response_range = range
+        set_range
+      end
+
+      def include?(exception_status)
+        set_range.include?(exception_status)
+      end
+
+      def to_s
+        @error_response_range.to_s
+      end
+
+      private
+
+      def set_range
+        @datadog_set ||= begin
+          set = Set.new
+          handle_statuses.each do |statuses|
+            status = statuses.to_s.split('-')
+            case status.length
+            when 1
+              set.add(Integer(status[0]))
+            when 2
+              min, max = status.minmax
+              Array(min..max).each do |i|
+                set.add(Integer(i))
+              end
+            end
+          end
+          set
+        end
+        @datadog_set
+      end
+
+      def error_responses
+        return @error_response_range if @error_response_range.is_a?(String) && !@error_response_range.nil?
+
+        @error_response_range.join(',') if @error_response_range.is_a?(Array) && !@error_response_range.empty?
+      end
+
+      def handle_statuses
+        if error_responses
+          filter_error_responses = error_responses.gsub(/\s+/, '').split(',').select do |code|
+            if !code.to_s.match(REGEX_PARSER)
+              Datadog.logger.debug("Invalid config provided: #{code}. Must be formatted like '400-403,405,410-499'.")
+              next
+            else
+              true
+            end
+          end
+          filter_error_responses.empty? ? Datadog::Ext::HTTP::ERROR_RANGE.to_a : filter_error_responses
+        else
+          Datadog.logger.debug('No valid config was provided for :error_statuses - falling back to default.')
+          Datadog::Ext::HTTP::ERROR_RANGE.to_a
+        end
+      end
+    end
+  end
+end