ddtrace 0.44.0 → 0.49.0

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

@@ -53,9 +53,7 @@ module Datadog
             end
           end
 
-          following = if middleware.instance_variable_defined?('@app')
-                        middleware.instance_variable_get('@app')
-                      end
+          following = (middleware.instance_variable_get('@app') if middleware.instance_variable_defined?('@app'))
 
           retain_middleware_name(following)
         end

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

@@ -1,7 +1,12 @@
 module Datadog
   module Contrib
     module Rack
-      # QueueTime simply...
+      # Retrieves the time spent in an upstream proxy
+      # for the current Rack request.
+      #
+      # This time captures the request delay introduced but
+      # such proxy before the request made it to the Ruby
+      # process.
       module QueueTime
         REQUEST_START = 'HTTP_X_REQUEST_START'.freeze
         QUEUE_START = 'HTTP_X_QUEUE_START'.freeze

data/lib/ddtrace/contrib/rails/auto_instrument_railtie.rb

@@ -0,0 +1,10 @@
+require 'ddtrace'
+
+# Railtie to include AutoInstrumentation in rails loading
+class DatadogAutoInstrumentRailtie < Rails::Railtie
+  # we want to load before config initializers so that any user supplied config
+  # in config/initializers/datadog.rb will take precedence
+  initializer 'datadog.start_tracer', before: :load_config_initializers do
+    Datadog::Contrib::AutoInstrument.patch_all
+  end
+end

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

@@ -3,6 +3,7 @@ require 'ddtrace/contrib/rails/framework'
 require 'ddtrace/contrib/rails/middlewares'
 require 'ddtrace/contrib/rails/log_injection'
 require 'ddtrace/contrib/rack/middlewares'
+require 'ddtrace/utils/only_once'
 
 module Datadog
   module Contrib
@@ -11,6 +12,9 @@ module Datadog
       module Patcher
         include Contrib::Patcher
 
+        BEFORE_INITIALIZE_ONLY_ONCE_PER_APP = Hash.new { |h, key| h[key] = Datadog::Utils::OnlyOnce.new }
+        AFTER_INITIALIZE_ONLY_ONCE_PER_APP = Hash.new { |h, key| h[key] = Datadog::Utils::OnlyOnce.new }
+
         module_function
 
         def target_version
@@ -29,7 +33,7 @@ module Datadog
         end
 
         def before_intialize(app)
-          do_once(:rails_before_initialize, for: app) do
+          BEFORE_INITIALIZE_ONLY_ONCE_PER_APP[app].run do
             # Middleware must be added before the application is initialized.
             # Otherwise the middleware stack will be frozen.
             # Sometimes we don't want to activate middleware e.g. OpenTracing, etc.
@@ -86,7 +90,7 @@ module Datadog
         end
 
         def after_intialize(app)
-          do_once(:rails_after_initialize, for: app) do
+          AFTER_INITIALIZE_ONLY_ONCE_PER_APP[app].run do
             # Finish configuring the tracer after the application is initialized.
             # We need to wait for some things, like application name, middleware stack, etc.
             setup_tracer

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

@@ -14,6 +14,10 @@ module Datadog
             ::Rails.application.class.to_s.underscore
           end
         end
+
+        def self.railtie_supported?
+          !(defined?(::Rails::VERSION::MAJOR) && ::Rails::VERSION::MAJOR >= 3 && defined?(::Rails::Railtie)).nil?
+        end
       end
     end
   end

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

@@ -16,7 +16,8 @@ module Datadog
             return super unless enabled?
 
             tracer.trace(Ext::SPAN_INVOKE, span_options) do |span|
-              super.tap { annotate_invoke!(span, args) }
+              annotate_invoke!(span, args)
+              super
             end
           ensure
             shutdown_tracer!
@@ -26,7 +27,8 @@ module Datadog
             return super unless enabled?
 
             tracer.trace(Ext::SPAN_EXECUTE, span_options) do |span|
-              super.tap { annotate_execute!(span, args) }
+              annotate_execute!(span, args)
+              super
             end
           ensure
             shutdown_tracer!

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

@@ -18,7 +18,7 @@ module Datadog
         end
 
         def self.loaded?
-          !defined?(::Rake).nil?
+          !defined?(::Rake::Task).nil?
         end
 
         def self.compatible?

data/lib/ddtrace/contrib/redis/configuration/resolver.rb

@@ -6,12 +6,19 @@ module Datadog
       module Configuration
         UNIX_SCHEME = 'unix'.freeze
 
-        # Converts Symbols, Strings, and Hashes to a normalized connection settings Hash.
+        # Converts String URLs and Hashes to a normalized connection settings Hash.
         class Resolver < Contrib::Configuration::Resolver
-          def resolve(key_or_hash)
-            return :default if key_or_hash == :default
+          # @param [Hash,String] Redis connection information
+          def resolve(hash)
+            super(parse_matcher(hash))
+          end
+
+          protected
+
+          def parse_matcher(matcher)
+            matcher = { url: matcher } if matcher.is_a?(String)
 
-            normalize(connection_resolver.resolve(key_or_hash))
+            normalize(connection_resolver.resolve(matcher))
           end
 
           def normalize(hash)

data/lib/ddtrace/contrib/redis/quantize.rb

@@ -56,6 +56,7 @@ module Datadog
 
         def auth_command?(command_args)
           return false unless command_args.is_a?(Array) && !command_args.empty?
+
           command_args.first.to_sym == :auth
         end
 

data/lib/ddtrace/contrib/redis/vendor/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ezra Zygmuntowicz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/ddtrace/contrib/redis/vendor/resolver.rb

@@ -56,11 +56,9 @@ module Datadog
             defaults = DEFAULTS.dup
             options = options.dup
 
-            defaults.keys.each do |key|
+            defaults.each_key do |key|
               # Fill in defaults if needed
-              if defaults[key].respond_to?(:call)
-                defaults[key] = defaults[key].call
-              end
+              defaults[key] = defaults[key].call if defaults[key].respond_to?(:call)
 
               # Symbolize only keys that are needed
               options[key] = options[key.to_s] if options.key?(key.to_s)
@@ -73,9 +71,10 @@ module Datadog
             if url
               uri = URI(url)
 
-              if uri.scheme == 'unix'
+              case uri.scheme
+              when 'unix'
                 defaults[:path] = uri.path
-              elsif uri.scheme == 'redis' || uri.scheme == 'rediss'
+              when 'redis', 'rediss'
                 defaults[:scheme]   = uri.scheme
                 defaults[:host]     = uri.host if uri.host
                 defaults[:port]     = uri.port if uri.port
@@ -90,7 +89,7 @@ module Datadog
             end
 
             # Use default when option is not specified or nil
-            defaults.keys.each do |key|
+            defaults.each_key do |key|
               options[key] = defaults[key] if options[key].nil?
             end
 

data/lib/ddtrace/contrib/registry.rb

@@ -17,9 +17,9 @@ module Datadog
         end
       end
 
-      def each
+      def each(&block)
         @mutex.synchronize do
-          @data.each { |_, entry| yield(entry) }
+          @data.each_value(&block)
         end
       end
 

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

@@ -23,7 +23,23 @@ module Datadog
           end
 
           option :service_name, default: Ext::SERVICE_NAME
-          option :workers, default: []
+
+          # A list Ruby worker classes to be instrumented.
+          # The value of `nil` has special semantics: it instruments all workers dynamically.
+          #
+          # TODO: 1.0: Automatic patching should be the default behavior.
+          # We should not provide this option in the future,
+          # as our integrations should always instrument all possible scenarios when feasible.
+          option :workers, default: nil do |o|
+            o.on_set do |value|
+              unless value.nil?
+                Datadog.logger.warn(
+                  "DEPRECATED: Resque integration now instruments all workers. \n" \
+                  'The `workers:` option is unnecessary and will be removed in the future.'
+                )
+              end
+            end
+          end
           option :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
         end
       end

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

@@ -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.send(: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,6 +65,7 @@ module Datadog
         def forked?
           pin = Datadog::Pin.get_from(::Resque)
           return false unless pin
+
           pin.config[:forked] == true
         end
 
@@ -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/request_patch.rb

@@ -54,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/rspec/configuration/settings.rb

@@ -12,16 +12,6 @@ module Datadog
             o.lazy
           end
 
-          option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, true) }
-            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 do |o|
             o.default { Datadog.configuration.service || Ext::SERVICE_NAME }
             o.lazy

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

@@ -10,30 +10,29 @@ module Datadog
         # Instance methods for configuration
         module InstanceMethods
           def run(example_group_instance, reporter)
-            configuration = Datadog.configuration[:rspec]
             return super unless configuration[:enabled]
 
-            test_name = "#{example_group.description}::#{description}"
+            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: example_group.instance_variable_get(:@tags).merge(Datadog.configuration.tags)
+              tags: tags.merge(Datadog.configuration.tags)
             }
 
-            configuration[:tracer].trace(configuration[:operation_name], trace_options) do |span|
+            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, example_group.file_path)
+              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)
 
-              # Set analytics sample rate
-              if Datadog::Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-                Datadog::Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-              end
-
               # Measure service stats
               Contrib::Analytics.set_measured(span)
 
@@ -51,9 +50,24 @@ module Datadog
                   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

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

@@ -4,13 +4,10 @@ module Datadog
       # RSpec integration constants
       module Ext
         APP = 'rspec'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_RSPEC_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RSPEC_ANALYTICS_SAMPLE_RATE'.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
-        EXAMPLE_GROUP_OPERATION_NAME = 'rspec.example_group'.freeze
         SERVICE_NAME = 'rspec'.freeze
         TEST_TYPE = 'test'.freeze
       end

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

@@ -21,13 +21,18 @@ module Datadog
 
         def self.loaded?
           !defined?(::RSpec).nil? && !defined?(::RSpec::Core).nil? && \
-            !defined?(::RSpec::Core::Example).nil? && !defined?(::RSpec::Core::ExampleGroup).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