ddtrace 0.41.0 → 0.46.0

data/lib/ddtrace/configuration.rb

@@ -48,18 +48,34 @@ module Datadog
         # This prevents recursive loops while initializing.
         # e.g. Get logger --> Build components --> Log message --> Repeat...
         @temp_logger ||= begin
-          logger = configuration.logger.instance || Datadog::Logger.new(STDOUT)
+          logger = configuration.logger.instance || Datadog::Logger.new($stdout)
           logger.level = configuration.diagnostics.debug ? ::Logger::DEBUG : configuration.logger.level
           logger
         end
       end
     end
 
+    # Gracefully shuts down all components.
+    #
+    # Components will still respond to method calls as usual,
+    # but might not internally perform their work after shutdown.
+    #
+    # This avoids errors being raised across the host application
+    # during shutdown, while allowing for graceful decommission of resources.
+    #
+    # Components won't be automatically reinitialized after a shutdown.
     def shutdown!
-      if instance_variable_defined?(:@components) && @components
-        components.shutdown!
-        @components = nil
-      end
+      components.shutdown! if instance_variable_defined?(:@components) && @components
+    end
+
+    # Gracefully shuts down the tracer and disposes of component references,
+    # allowing execution to start anew.
+    #
+    # In contrast with +#shutdown!+, components will be automatically
+    # reinitialized after a reset.
+    def reset!
+      shutdown!
+      @components = nil
     end
 
     protected

data/lib/ddtrace/configuration/base.rb

@@ -37,7 +37,7 @@ module Datadog
 
         def new_settings_class(&block)
           Class.new { include Datadog::Configuration::Base }.tap do |klass|
-            klass.instance_eval(&block) if block_given?
+            klass.instance_eval(&block) if block
           end
         end
       end

data/lib/ddtrace/configuration/components.rb

@@ -7,7 +7,7 @@ require 'ddtrace/workers/runtime_metrics'
 module Datadog
   module Configuration
     # Global components for the trace library.
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     class Components
       class << self
         def build_health_metrics(settings)
@@ -19,7 +19,7 @@ module Datadog
         end
 
         def build_logger(settings)
-          logger = settings.logger.instance || Datadog::Logger.new(STDOUT)
+          logger = settings.logger.instance || Datadog::Logger.new($stdout)
           logger.level = settings.diagnostics.debug ? ::Logger::DEBUG : settings.logger.level
 
           logger

data/lib/ddtrace/configuration/option_definition.rb

@@ -60,7 +60,7 @@ module Datadog
         end
 
         def default(value = nil, &block)
-          @default = block_given? ? block : value
+          @default = block || value
         end
 
         def delegate_to(&block)
@@ -71,8 +71,6 @@ module Datadog
           @helpers[name] = block
         end
 
-        # rubocop:disable Style/TrivialAccessors
-        # (Rubocop erroneously thinks #lazy == #lazy= )
         def lazy(value = true)
           @lazy = value
         end

data/lib/ddtrace/configuration/options.rb

@@ -51,6 +51,7 @@ module Datadog
         def define_helpers(helpers)
           helpers.each do |name, block|
             next unless block.is_a?(Proc)
+
             define_method(name, &block)
           end
         end
@@ -102,9 +103,7 @@ module Datadog
         end
 
         def assert_valid_option!(name)
-          unless option_defined?(name)
-            raise(InvalidOptionError, "#{self.class.name} doesn't define the option: #{name}")
-          end
+          raise(InvalidOptionError, "#{self.class.name} doesn't define the option: #{name}") unless option_defined?(name)
         end
       end
 

data/lib/ddtrace/configuration/settings.rb

@@ -69,7 +69,8 @@ module Datadog
         option :propagation_extract_style do |o|
           o.default do
             # Look for all headers by default
-            env_to_list(Ext::DistributedTracing::PROPAGATION_EXTRACT_STYLE_ENV,
+            env_to_list([Ext::DistributedTracing::PROPAGATION_STYLE_EXTRACT_ENV,
+                         Ext::DistributedTracing::PROPAGATION_EXTRACT_STYLE_ENV_OLD],
                         [Ext::DistributedTracing::PROPAGATION_STYLE_DATADOG,
                          Ext::DistributedTracing::PROPAGATION_STYLE_B3,
                          Ext::DistributedTracing::PROPAGATION_STYLE_B3_SINGLE_HEADER])
@@ -81,7 +82,8 @@ module Datadog
         option :propagation_inject_style do |o|
           o.default do
             # Only inject Datadog headers by default
-            env_to_list(Ext::DistributedTracing::PROPAGATION_INJECT_STYLE_ENV,
+            env_to_list([Ext::DistributedTracing::PROPAGATION_STYLE_INJECT_ENV,
+                         Ext::DistributedTracing::PROPAGATION_INJECT_STYLE_ENV_OLD],
                         [Ext::DistributedTracing::PROPAGATION_STYLE_DATADOG])
           end
 
@@ -185,9 +187,7 @@ module Datadog
           string_tags = Hash[new_value.collect { |k, v| [k.to_s, v] }]
 
           # Cross-populate tag values with other settings
-          if env.nil? && string_tags.key?(Ext::Environment::TAG_ENV)
-            self.env = string_tags[Ext::Environment::TAG_ENV]
-          end
+          self.env = string_tags[Ext::Environment::TAG_ENV] if env.nil? && string_tags.key?(Ext::Environment::TAG_ENV)
 
           if version.nil? && string_tags.key?(Ext::Environment::TAG_VERSION)
             self.version = string_tags[Ext::Environment::TAG_VERSION]
@@ -204,6 +204,22 @@ module Datadog
         o.lazy
       end
 
+      option :time_now_provider do |o|
+        o.default { ::Time.now }
+
+        o.on_set do |time_provider|
+          Utils::Time.now_provider = time_provider
+        end
+
+        o.resetter do |_value|
+          # TODO: Resetter needs access to the default value
+          # TODO: to help reduce duplication.
+          -> { ::Time.now }.tap do |default|
+            Utils::Time.now_provider = default
+          end
+        end
+      end
+
       settings :tracer do
         option :enabled do |o|
           o.default { env_to_bool(Datadog::Ext::Diagnostics::DD_TRACE_ENABLED, true) }

data/lib/ddtrace/context.rb

@@ -1,8 +1,8 @@
-require 'thread'
 require 'ddtrace/diagnostics/health'
 
 require 'ddtrace/context_flush'
 require 'ddtrace/context_provider'
+require 'ddtrace/utils/forking'
 
 module Datadog
   # \Context is used to keep track of a hierarchy of spans for the current
@@ -19,6 +19,8 @@ module Datadog
   # This data structure is thread-safe.
   # rubocop:disable Metrics/ClassLength
   class Context
+    include Datadog::Utils::Forking
+
     # 100k spans is about a 100Mb footprint
     DEFAULT_MAX_LENGTH = 100_000
 
@@ -123,6 +125,7 @@ module Datadog
         # on per-instrumentation code to retrieve handle parent/child relations.
         set_current_span(span.parent)
         return if span.tracer.nil?
+
         if span.parent.nil? && !all_spans_finished?
           if Datadog.configuration.diagnostics.debug
             opened_spans = @trace.length - @finished_spans
@@ -227,11 +230,26 @@ module Datadog
     # Return a string representation of the context.
     def to_s
       @mutex.synchronize do
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         "Context(trace.length:#{@trace.length},sampled:#{@sampled},finished_spans:#{@finished_spans},current_span:#{@current_span})"
       end
     end
 
+    # Generates equivalent context for forked processes.
+    #
+    # When Context from parent process is forked, child process
+    # should have a Context belonging to the same trace but not
+    # have the parent process spans.
+    def fork_clone
+      self.class.new(
+        trace_id: trace_id,
+        span_id: span_id,
+        sampled: sampled?,
+        sampling_priority: sampling_priority,
+        origin: origin
+      )
+    end
+
     private
 
     def reset(options = {})
@@ -282,6 +300,7 @@ module Datadog
     def start_time
       @mutex.synchronize do
         return nil if @trace.empty?
+
         @trace[0].start_time
       end
     end
@@ -294,11 +313,9 @@ module Datadog
     end
 
     # Iterate on each span within the trace. This is thread safe.
-    def each_span
+    def each_span(&block)
       @mutex.synchronize do
-        @trace.each do |span|
-          yield span
-        end
+        @trace.each(&block)
       end
     end
   end

data/lib/ddtrace/context_provider.rb

@@ -13,9 +13,20 @@ module Datadog
       @context.local = ctx
     end
 
-    # Return the current context.
-    def context
-      @context.local
+    # Return the local context.
+    def context(key = nil)
+      current_context = key.nil? ? @context.local : @context.local(key)
+
+      # Rebuild/reset context after a fork
+      #
+      # We don't want forked processes to copy and retransmit spans
+      # that were generated from the parent process. Reset it such
+      # that it acts like a distributed trace.
+      current_context.after_fork! do
+        current_context = self.context = current_context.fork_clone
+      end
+
+      current_context
     end
   end
 
@@ -43,8 +54,10 @@ module Datadog
     end
 
     # Return the thread-local context.
-    def local
-      Thread.current[@key] ||= Datadog::Context.new
+    def local(thread = Thread.current)
+      raise ArgumentError, '\'thread\' must be a Thread.' unless thread.is_a?(Thread)
+
+      thread[@key] ||= Datadog::Context.new
     end
   end
 end

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

@@ -56,6 +56,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/action_cable/integration.rb

@@ -1,6 +1,7 @@
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/action_cable/configuration/settings'
 require 'ddtrace/contrib/action_cable/patcher'
+require 'ddtrace/contrib/rails/utils'
 
 module Datadog
   module Contrib
@@ -25,6 +26,12 @@ module Datadog
           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

data/lib/ddtrace/contrib/action_pack/action_controller/instrumentation.rb

@@ -36,9 +36,7 @@ module Datadog
 
             begin
               # Set the resource name, if it's still the default name
-              if span.resource == span.name
-                span.resource = "#{payload.fetch(:controller)}##{payload.fetch(:action)}"
-              end
+              span.resource = "#{payload.fetch(:controller)}##{payload.fetch(:action)}" if span.resource == span.name
 
               # Set the resource name of the Rack request span unless this is an exception controller.
               unless exception_controller?(payload)

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

@@ -1,6 +1,7 @@
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/action_pack/configuration/settings'
 require 'ddtrace/contrib/action_pack/patcher'
+require 'ddtrace/contrib/rails/utils'
 
 module Datadog
   module Contrib
@@ -25,6 +26,12 @@ module Datadog
           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

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

@@ -12,10 +12,6 @@ module Datadog
 
         # Class methods for ActionView events.
         module ClassMethods
-          def span_options
-            { service: configuration[:service_name] }
-          end
-
           def tracer
             -> { configuration[:tracer] }
           end
@@ -25,7 +21,7 @@ module Datadog
           end
 
           def record_exception(span, payload)
-            if payload [:exception_object]
+            if payload[:exception_object]
               span.set_error(payload[:exception_object])
             elsif payload[:exception]
               # Fallback for ActiveSupport < 5.0

data/lib/ddtrace/contrib/action_view/events/render_partial.rb

@@ -24,6 +24,7 @@ module Datadog
           end
 
           def process(span, _event, _id, payload)
+            span.service = configuration[:service_name]
             span.span_type = Datadog::Ext::HTTP::TEMPLATE
 
             if (template_name = Utils.normalize_template_name(payload[:identifier]))

data/lib/ddtrace/contrib/action_view/events/render_template.rb

@@ -24,6 +24,7 @@ module Datadog
           end
 
           def process(span, _event, _id, payload)
+            span.service = configuration[:service_name]
             span.span_type = Datadog::Ext::HTTP::TEMPLATE
 
             if (template_name = Utils.normalize_template_name(payload[:identifier]))

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

@@ -1,6 +1,7 @@
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/action_view/configuration/settings'
 require 'ddtrace/contrib/action_view/patcher'
+require 'ddtrace/contrib/rails/utils'
 
 module Datadog
   module Contrib
@@ -32,6 +33,12 @@ module Datadog
           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

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

@@ -24,7 +24,7 @@ module Datadog
             sections_view[-1]
           end
         rescue
-          return name.to_s
+          name.to_s
         end
       end
     end

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

@@ -12,7 +12,17 @@ module Datadog
           end
 
           def resolve(key)
-            normalize(connection_resolver.resolve(key).symbolize_keys)
+            normalize(resolve_connection_key(key).symbolize_keys)
+          end
+
+          def resolve_connection_key(key)
+            result = connection_resolver.resolve(key)
+
+            if result.respond_to?(:configuration_hash) # Rails >= 6.1
+              result.configuration_hash
+            else # Rails < 6.1
+              result
+            end
           end
 
           def configurations
@@ -21,7 +31,9 @@ module Datadog
 
           def connection_resolver
             @resolver ||= begin
-              if defined?(::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver)
+              if defined?(::ActiveRecord::Base.configurations.resolve)
+                ::ActiveRecord::DatabaseConfigurations.new(configurations)
+              elsif defined?(::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver)
                 ::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(configurations)
               else
                 ::Datadog::Vendor::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(configurations)
@@ -31,9 +43,9 @@ module Datadog
 
           def normalize(hash)
             {
-              adapter:  hash[:adapter],
-              host:     hash[:host],
-              port:     hash[:port],
+              adapter: hash[:adapter],
+              host: hash[:host],
+              port: hash[:port],
               database: hash[:database],
               username: hash[:username]
             }