ddtrace 0.44.0 → 0.49.0

data/lib/ddtrace/configuration/settings.rb

@@ -3,6 +3,7 @@ require 'ddtrace/configuration/base'
 
 require 'ddtrace/ext/analytics'
 require 'ddtrace/ext/distributed'
+require 'ddtrace/ext/profiling'
 require 'ddtrace/ext/runtime'
 require 'ddtrace/ext/sampling'
 
@@ -13,9 +14,6 @@ module Datadog
     class Settings
       include Base
 
-      #
-      # Configuration options
-      #
       settings :analytics do
         option :enabled do |o|
           o.default { env_to_bool(Ext::Analytics::ENV_TRACE_ANALYTICS_ENABLED, nil) }
@@ -108,6 +106,49 @@ module Datadog
         get_option(:logger).instance = logger
       end
 
+      settings :profiling do
+        option :enabled do |o|
+          o.default { env_to_bool(Ext::Profiling::ENV_ENABLED, false) }
+          o.lazy
+        end
+
+        settings :exporter do
+          option :transport
+          option :transport_options do |o|
+            o.setter do
+              # NOTE: As of April 2021 there may be a few profiler private beta customers with this setting, but since I'm
+              # marking this as deprecated before public beta, we can remove this for 1.0 without concern.
+              Datadog.logger.warn(
+                'Configuring the profiler c.profiling.exporter.transport_options is no longer needed, as the profiler ' \
+                'will reuse your existing global or tracer configuration. ' \
+                'This setting is deprecated for removal in a future ddtrace version ' \
+                '(1.0 or profiling GA, whichever comes first).'
+              )
+              nil
+            end
+            o.default { nil }
+            o.lazy
+          end
+        end
+
+        option :max_events, default: 32768
+
+        # Controls the maximum number of frames for each thread sampled. Can be tuned to avoid omitted frames in the
+        # produced profiles. Increasing this may increase the overhead of profiling.
+        option :max_frames do |o|
+          o.default { env_to_int(Ext::Profiling::ENV_MAX_FRAMES, 400) }
+          o.lazy
+        end
+
+        settings :upload do
+          option :timeout_seconds do |o|
+            o.setter { |value| value.nil? ? 30.0 : value.to_f }
+            o.default { env_to_float(Ext::Profiling::ENV_UPLOAD_TIMEOUT, 30.0) }
+            o.lazy
+          end
+        end
+      end
+
       option :report_hostname do |o|
         o.default { env_to_bool(Ext::NET::ENV_REPORT_HOSTNAME, false) }
         o.lazy
@@ -187,9 +228,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]
@@ -206,6 +245,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,4 +1,3 @@
-require 'thread'
 require 'ddtrace/diagnostics/health'
 
 require 'ddtrace/context_flush'
@@ -126,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
@@ -230,7 +230,7 @@ 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
@@ -300,6 +300,7 @@ module Datadog
     def start_time
       @mutex.synchronize do
         return nil if @trace.empty?
+
         @trace[0].start_time
       end
     end
@@ -312,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

@@ -55,7 +55,6 @@ module Datadog
 
     # Return the thread-local context.
     def local(thread = Thread.current)
-      raise ArgumentError, '\'thread\' must be a Thread.' unless thread.is_a?(Thread)
       thread[@key] ||= Datadog::Context.new
     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)
@@ -63,7 +61,7 @@ module Datadog
                 # [christian] in some cases :status is not defined,
                 # rather than firing an error, simply acknowledge we don't know it.
                 status = payload.fetch(:status, '?').to_s
-                span.status = 1 if status.starts_with?('5')
+                span.status = 1 if status.start_with?('5')
               elsif Utils.exception_is_error?(exception)
                 span.set_error(exception)
               end

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_pack/utils.rb

@@ -11,7 +11,7 @@ module Datadog
             # You can add custom errors via `config.action_dispatch.rescue_responses`
             status = ::ActionDispatch::ExceptionWrapper.status_code_for_exception(exception.class.name)
             # Only 5XX exceptions are actually errors (e.g. don't flag 404s)
-            status.to_s.starts_with?('5')
+            status.to_s.start_with?('5')
           else
             true
           end

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

@@ -21,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/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/makara_resolver.rb

@@ -0,0 +1,30 @@
+module Datadog
+  module Contrib
+    module ActiveRecord
+      module Configuration
+        # The `makara` gem has the concept of **role**, which can be
+        # inferred from the configuration `name`, in the form of:
+        # `master/0`, `replica/0`, `replica/1`, etc.
+        # The first part of this string is the database role.
+        #
+        # This allows the matching of a connection based on its role,
+        # instead of connection-specific information.
+        module MakaraResolver
+          def normalize_for_config(active_record_config)
+            hash = super
+            hash[:makara_role] = active_record_config[:makara_role]
+            hash
+          end
+
+          def normalize_for_resolve(active_record_config)
+            hash = super
+
+            hash[:makara_role] = active_record_config[:name].split('/')[0].to_s if active_record_config[:name].is_a?(String)
+
+            hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,43 +1,132 @@
 require 'ddtrace/contrib/configuration/resolver'
 require 'ddtrace/vendor/active_record/connection_specification'
+require_relative 'makara_resolver'
 
 module Datadog
   module Contrib
     module ActiveRecord
       module Configuration
         # Converts Symbols, Strings, and Hashes to a normalized connection settings Hash.
+        #
+        # When matching using a Hash, these are the valid fields:
+        # ```
+        # {
+        #   adapter: ...,
+        #   host: ...,
+        #   port: ...,
+        #   database: ...,
+        #   username: ...,
+        #   role: ...,
+        # }
+        # ```
+        #
+        # Partial matching is supported: not including certain fields or setting them to `nil`
+        # will cause them to matching all values for that field. For example: `database: nil`
+        # will match any database, given the remaining fields match.
+        #
+        # Any fields not listed above are discarded.
+        #
+        # When more than one configuration could be matched, the last one to match is selected,
+        # based on addition order (`#add`).
         class Resolver < Contrib::Configuration::Resolver
-          def initialize(configurations = nil)
-            @configurations = configurations
+          prepend MakaraResolver
+
+          def initialize(active_record_configuration = nil)
+            super()
+
+            @active_record_configuration = active_record_configuration
           end
 
-          def resolve(key)
-            normalize(connection_resolver.resolve(key).symbolize_keys)
+          def active_record_configuration
+            @active_record_configuration || ::ActiveRecord::Base.configurations
           end
 
-          def configurations
-            @configurations || ::ActiveRecord::Base.configurations
+          def add(matcher, value)
+            parsed = parse_matcher(matcher)
+
+            # In case of error parsing, don't store `nil` key
+            # as it wouldn't be useful for matching configuration
+            # hashes in `#resolve`.
+            super(parsed, value) if parsed
           end
 
-          def connection_resolver
-            @resolver ||= begin
-              if defined?(::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver)
-                ::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(configurations)
-              else
-                ::Datadog::Vendor::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(configurations)
+          def resolve(db_config)
+            active_record_config = resolve_connection_key(db_config).symbolize_keys
+
+            hash = normalize_for_resolve(active_record_config)
+
+            # Hashes in Ruby maintain insertion order
+            _, config = @configurations.reverse_each.find do |matcher, _|
+              matcher.none? do |key, value|
+                value != hash[key]
               end
             end
+
+            config
+          rescue => e
+            Datadog.logger.error(
+              "Failed to resolve ActiveRecord configuration key #{db_config.inspect}. " \
+              "Cause: #{e.message} Source: #{e.backtrace.first}"
+            )
+
+            nil
           end
 
-          def normalize(hash)
+          protected
+
+          def parse_matcher(matcher)
+            resolved_pattern = resolve_connection_key(matcher).symbolize_keys
+            normalized = normalize_for_config(resolved_pattern)
+
+            # Remove empty fields to allow for partial matching
+            normalized.reject! { |_, v| v.nil? }
+
+            normalized
+          rescue => e
+            Datadog.logger.error(
+              "Failed to resolve ActiveRecord configuration key #{matcher.inspect}. " \
+              "Cause: #{e.message} Source: #{e.backtrace.first}"
+            )
+          end
+
+          def connection_resolver
+            @resolver ||= if defined?(::ActiveRecord::Base.configurations.resolve)
+                            ::ActiveRecord::DatabaseConfigurations.new(active_record_configuration)
+                          elsif defined?(::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver)
+                            ::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(
+                              active_record_configuration
+                            )
+                          else
+                            ::Datadog::Vendor::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(
+                              active_record_configuration
+                            )
+                          end
+          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
+
+          # Extract only fields we'd like to match
+          # from the ActiveRecord configuration.
+          def normalize_for_config(active_record_config)
             {
-              adapter:  hash[:adapter],
-              host:     hash[:host],
-              port:     hash[:port],
-              database: hash[:database],
-              username: hash[:username]
+              adapter: active_record_config[:adapter],
+              host: active_record_config[:host],
+              port: active_record_config[:port],
+              database: active_record_config[:database],
+              username: active_record_config[:username]
             }
           end
+
+          # Both resolvers perform the same operations for this implementation, but can be specialized
+          alias_method :normalize_for_resolve, :normalize_for_config
         end
       end
     end