ddtrace 0.48.0 → 0.51.1

data/lib/ddtrace/configuration/options.rb

@@ -7,8 +7,8 @@ module Datadog
     # Behavior for a configuration object that has options
     module Options
       def self.included(base)
-        base.send(:extend, ClassMethods)
-        base.send(:include, InstanceMethods)
+        base.extend(ClassMethods)
+        base.include(InstanceMethods)
       end
 
       # Class behavior for a configuration object with options

data/lib/ddtrace/configuration/settings.rb

@@ -3,9 +3,10 @@ require 'ddtrace/configuration/base'
 
 require 'ddtrace/ext/analytics'
 require 'ddtrace/ext/distributed'
+require 'ddtrace/ext/environment'
 require 'ddtrace/ext/profiling'
-require 'ddtrace/ext/runtime'
 require 'ddtrace/ext/sampling'
+require 'ddtrace/ext/test'
 
 module Datadog
   module Configuration
@@ -14,9 +15,32 @@ module Datadog
     class Settings
       include Base
 
-      #
-      # Configuration options
-      #
+      def initialize(*_)
+        super
+
+        # WORKAROUND: The values for services, version, and env can get set either directly OR as a side effect of
+        # accessing tags (reading or writing). This is of course really confusing and error-prone, e.g. in an app
+        # WITHOUT this workaround where you define `DD_TAGS=env:envenvtag,service:envservicetag,version:envversiontag`
+        # and do:
+        #
+        # puts Datadog.configuration.instance_exec { "#{service} #{env} #{version}" }
+        # Datadog.configuration.tags
+        # puts Datadog.configuration.instance_exec { "#{service} #{env} #{version}" }
+        #
+        # the output will be:
+        #
+        # [empty]
+        # envservicetag envenvtag envversiontag
+        #
+        # That is -- the proper values for service/env/version are only set AFTER something accidentally or not triggers
+        # the resolution of the tags.
+        # This is really confusing, error prone, etc, so calling tags here is a really hacky but effective way to
+        # avoid this. I could not think of a better way of fixing this issue without massive refactoring of tags parsing
+        # (so that the individual service/env/version get correctly set even from their tags values, not as a side
+        # effect). Sorry :(
+        tags
+      end
+
       settings :analytics do
         option :enabled do |o|
           o.default { env_to_bool(Ext::Analytics::ENV_TRACE_ANALYTICS_ENABLED, nil) }
@@ -93,6 +117,7 @@ module Datadog
       end
 
       option :env do |o|
+        # NOTE: env also gets set as a side effect of tags. See the WORKAROUND note in #initialize for details.
         o.default { ENV.fetch(Ext::Environment::ENV_ENVIRONMENT, nil) }
         o.lazy
       end
@@ -116,9 +141,22 @@ module Datadog
         end
 
         settings :exporter do
-          option :instances
           option :transport
-          option :transport_options, default: ->(_o) { {} }, lazy: true
+          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
@@ -131,7 +169,7 @@ module Datadog
         end
 
         settings :upload do
-          option :timeout do |o|
+          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
@@ -187,8 +225,17 @@ module Datadog
       end
 
       option :service do |o|
-        o.default { ENV.fetch(Ext::Environment::ENV_SERVICE, nil) }
+        # NOTE: service also gets set as a side effect of tags. See the WORKAROUND note in #initialize for details.
+        o.default { ENV.fetch(Ext::Environment::ENV_SERVICE, Ext::Environment::FALLBACK_SERVICE_NAME) }
         o.lazy
+
+        # There's a few cases where we don't want to use the fallback service name, so this helper allows us to get a
+        # nil instead so that one can do
+        # nice_service_name = Datadog.configure.service_without_fallback || nice_service_name_default
+        o.helper(:service_without_fallback) do
+          service_name = service
+          service_name unless service_name.equal?(Ext::Environment::FALLBACK_SERVICE_NAME)
+        end
       end
 
       option :site do |o|
@@ -215,16 +262,17 @@ module Datadog
 
         o.setter do |new_value, old_value|
           # Coerce keys to strings
-          string_tags = Hash[new_value.collect { |k, v| [k.to_s, v] }]
+          string_tags = new_value.collect { |k, v| [k.to_s, v] }.to_h
 
           # Cross-populate tag values with other settings
+
           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]
           end
 
-          if service.nil? && string_tags.key?(Ext::Environment::TAG_SERVICE)
+          if service_without_fallback.nil? && string_tags.key?(Ext::Environment::TAG_SERVICE)
             self.service = string_tags[Ext::Environment::TAG_SERVICE]
           end
 
@@ -235,6 +283,23 @@ module Datadog
         o.lazy
       end
 
+      settings :test_mode do
+        option :enabled do |o|
+          o.default { env_to_bool(Ext::Test::ENV_MODE_ENABLED, false) }
+          o.lazy
+        end
+
+        option :context_flush do |o|
+          o.default { nil }
+          o.lazy
+        end
+
+        option :writer_options do |o|
+          o.default { {} }
+          o.lazy
+        end
+      end
+
       option :time_now_provider do |o|
         o.default { ::Time.now }
 
@@ -322,6 +387,7 @@ module Datadog
       end
 
       option :version do |o|
+        # NOTE: version also gets set as a side effect of tags. See the WORKAROUND note in #initialize for details.
         o.default { ENV.fetch(Ext::Environment::ENV_VERSION, nil) }
         o.lazy
       end

data/lib/ddtrace/context.rb

@@ -189,6 +189,9 @@ module Datadog
         # Root span is finished at this point, we can configure it
         annotate_for_flush!(@current_root_span)
 
+        # Allow caller to modify trace before context is reset
+        yield(trace) if block_given?
+
         reset
         [trace, sampled]
       end
@@ -227,6 +230,20 @@ module Datadog
       attach_origin(span) if @origin
     end
 
+    def attach_sampling_priority(span)
+      span.set_metric(
+        Ext::DistributedTracing::SAMPLING_PRIORITY_KEY,
+        @sampling_priority
+      )
+    end
+
+    def attach_origin(span)
+      span.set_tag(
+        Ext::DistributedTracing::ORIGIN_KEY,
+        @origin
+      )
+    end
+
     # Return a string representation of the context.
     def to_s
       @mutex.synchronize do
@@ -282,20 +299,6 @@ module Datadog
       @finished_spans > 0 && @trace.length == @finished_spans
     end
 
-    def attach_sampling_priority(span)
-      span.set_metric(
-        Ext::DistributedTracing::SAMPLING_PRIORITY_KEY,
-        @sampling_priority
-      )
-    end
-
-    def attach_origin(span)
-      span.set_tag(
-        Ext::DistributedTracing::ORIGIN_KEY,
-        @origin
-      )
-    end
-
     # Return the start time of the root span, or nil if there are no spans or this is undefined.
     def start_time
       @mutex.synchronize do

data/lib/ddtrace/context_flush.rb

@@ -9,9 +9,15 @@ module Datadog
       #
       # @return [Array<Span>] trace to be flushed, or +nil+ if the trace is not finished
       def consume!(context)
-        trace, sampled = context.get
+        trace, sampled = get_trace(context)
         trace if sampled
       end
+
+      protected
+
+      def get_trace(context)
+        context.get
+      end
     end
 
     # Performs partial trace flushing to avoid large traces residing in memory for too long
@@ -34,7 +40,7 @@ module Datadog
       #
       # @return [Array<Span>] partial or complete trace to be flushed, or +nil+ if no spans are finished
       def consume!(context)
-        trace, sampled = context.get
+        trace, sampled = get_trace(context)
 
         return nil unless sampled
         return trace if trace && !trace.empty?
@@ -42,6 +48,12 @@ module Datadog
         partial_trace(context)
       end
 
+      protected
+
+      def get_trace(context)
+        context.get
+      end
+
       private
 
       def partial_trace(context)

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

@@ -8,8 +8,8 @@ module Datadog
       # Defines basic behaviors for an event.
       module Event
         def self.included(base)
-          base.send(:include, ActiveSupport::Notifications::Event)
-          base.send(:extend, ClassMethods)
+          base.include(ActiveSupport::Notifications::Event)
+          base.extend(ClassMethods)
         end
 
         # Class methods for events.
@@ -34,8 +34,8 @@ module Datadog
       # but to start a fresh tracing context.
       module RootContextEvent
         def self.included(base)
-          base.send(:include, ActiveSupport::Notifications::Event)
-          base.send(:extend, ClassMethods)
+          base.include(ActiveSupport::Notifications::Event)
+          base.extend(ClassMethods)
         end
 
         # Class methods for events.

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

@@ -61,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/action_controller/patcher.rb

@@ -16,7 +16,7 @@ module Datadog
           end
 
           def patch
-            ::ActionController::Metal.send(:prepend, ActionController::Instrumentation::Metal)
+            ::ActionController::Metal.prepend(ActionController::Instrumentation::Metal)
           end
         end
       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

@@ -6,8 +6,8 @@ module Datadog
       # Defines basic behavior for an ActionView event.
       module Event
         def self.included(base)
-          base.send(:include, ActiveSupport::Notifications::Event)
-          base.send(:extend, ClassMethods)
+          base.include(ActiveSupport::Notifications::Event)
+          base.extend(ClassMethods)
         end
 
         # Class methods for ActionView events.

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

@@ -31,12 +31,12 @@ module Datadog
             #  Rendering events are not nested in this version, creating
             #  render_partial spans outside of the parent render_template span.
             #  We fall back to manual patching instead.
-            ::ActionView::TemplateRenderer.send(:prepend, Instrumentation::TemplateRenderer::RailsLessThan4)
-            ::ActionView::PartialRenderer.send(:prepend, Instrumentation::PartialRenderer::RailsLessThan4)
+            ::ActionView::TemplateRenderer.prepend(Instrumentation::TemplateRenderer::RailsLessThan4)
+            ::ActionView::PartialRenderer.prepend(Instrumentation::PartialRenderer::RailsLessThan4)
           elsif defined?(::ActionView::Rendering) && defined?(::ActionView::Partials::PartialRenderer)
             # NOTE: Rails < 3.1 compatibility: different classes are used
-            ::ActionView::Rendering.send(:prepend, Instrumentation::TemplateRenderer::Rails30)
-            ::ActionView::Partials::PartialRenderer.send(:prepend, Instrumentation::PartialRenderer::RailsLessThan4)
+            ::ActionView::Rendering.prepend(Instrumentation::TemplateRenderer::Rails30)
+            ::ActionView::Partials::PartialRenderer.prepend(Instrumentation::PartialRenderer::RailsLessThan4)
           else
             Datadog.logger.debug('Expected Template/Partial classes not found; template rendering disabled')
           end

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

@@ -9,8 +9,8 @@ module Datadog
       # Defines basic behaviors for an ActiveModelSerializers event.
       module Event
         def self.included(base)
-          base.send(:include, ActiveSupport::Notifications::Event)
-          base.send(:extend, ClassMethods)
+          base.include(ActiveSupport::Notifications::Event)
+          base.extend(ClassMethods)
         end
 
         # Class methods for ActiveModelSerializers events.

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

@@ -6,8 +6,8 @@ module Datadog
       # Defines basic behaviors for an ActiveRecord event.
       module Event
         def self.included(base)
-          base.send(:include, ActiveSupport::Notifications::Event)
-          base.send(:extend, ClassMethods)
+          base.include(ActiveSupport::Notifications::Event)
+          base.extend(ClassMethods)
         end
 
         # Class methods for ActiveRecord events.

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

@@ -1,4 +1,4 @@
-require 'ddtrace/ext/runtime'
+require 'datadog/core/environment/ext'
 
 module Datadog
   module Contrib
@@ -54,7 +54,7 @@ module Datadog
 
         # DEV: JRuby responds to {ObjectSpace._id2ref}, despite raising an error
         # DEV: when invoked. Thus, we have to explicitly check for Ruby runtime.
-        if Datadog::Ext::Runtime::RUBY_ENGINE != 'jruby'
+        if Datadog::Core::Environment::Ext::RUBY_ENGINE != 'jruby'
           # CRuby has access to {ObjectSpace._id2ref}, which allows for
           # direct look up of the connection object.
           def self.connection_from_id(connection_id)

data/lib/ddtrace/contrib/active_support/cache/patcher.rb

@@ -30,37 +30,37 @@ module Datadog
           end
 
           def patch_cache_store_read
-            cache_store_class(:read).send(:prepend, Cache::Instrumentation::Read)
+            cache_store_class(:read).prepend(Cache::Instrumentation::Read)
           end
 
           def patch_cache_store_read_multi
-            cache_store_class(:read_multi).send(:prepend, Cache::Instrumentation::ReadMulti)
+            cache_store_class(:read_multi).prepend(Cache::Instrumentation::ReadMulti)
           end
 
           def patch_cache_store_fetch
-            cache_store_class(:fetch).send(:prepend, Cache::Instrumentation::Fetch)
+            cache_store_class(:fetch).prepend(Cache::Instrumentation::Fetch)
           end
 
           def patch_cache_store_fetch_multi
             klass = cache_store_class(:fetch_multi)
             return unless klass.public_method_defined?(:fetch_multi)
 
-            klass.send(:prepend, Cache::Instrumentation::FetchMulti)
+            klass.prepend(Cache::Instrumentation::FetchMulti)
           end
 
           def patch_cache_store_write
-            cache_store_class(:write).send(:prepend, Cache::Instrumentation::Write)
+            cache_store_class(:write).prepend(Cache::Instrumentation::Write)
           end
 
           def patch_cache_store_write_multi
             klass = cache_store_class(:write_multi)
             return unless klass.public_method_defined?(:write_multi)
 
-            klass.send(:prepend, Cache::Instrumentation::WriteMulti)
+            klass.prepend(Cache::Instrumentation::WriteMulti)
           end
 
           def patch_cache_store_delete
-            cache_store_class(:delete).send(:prepend, Cache::Instrumentation::Delete)
+            cache_store_class(:delete).prepend(Cache::Instrumentation::Delete)
           end
         end
       end

data/lib/ddtrace/contrib/active_support/cache/redis.rb

@@ -35,11 +35,7 @@ module Datadog
           end
 
           # Decorate Cache patcher with Redis support
-          Cache::Patcher.instance_eval do
-            class << self
-              prepend Redis::Patcher
-            end
-          end
+          Cache::Patcher.singleton_class.prepend(Redis::Patcher)
         end
       end
     end

data/lib/ddtrace/contrib/active_support/notifications/event.rb

@@ -10,8 +10,8 @@ module Datadog
         # invoke Event.subscribe! to more easily subscribe to an event.
         module Event
           def self.included(base)
-            base.send(:include, Subscriber)
-            base.send(:extend, ClassMethods)
+            base.include(Subscriber)
+            base.extend(ClassMethods)
             base.send(:on_subscribe) { base.subscribe }
           end