ddtrace 0.35.1 → 0.39.0

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

@@ -5,6 +5,7 @@ module Datadog
       module Ext
         APP = 'concurrent-ruby'.freeze
         SERVICE_NAME = 'concurrent-ruby'.freeze
+        ENV_ENABLED = 'DD_TRACE_CONCURRENT_RUBY_ENABLED'.freeze
       end
     end
   end

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

@@ -9,14 +9,18 @@ module Datadog
 
         option :analytics_enabled, default: false
         option :analytics_sample_rate, default: 1.0
+        option :enabled, default: true
         option :service_name
         option :tracer do |o|
           o.delegate_to { Datadog.tracer }
+          o.on_set do |_value|
+            log_deprecation_warning(:tracer)
+          end
         end
 
         def configure(options = {})
           self.class.options.dependency_order.each do |name|
-            self[name] = options.fetch(name, self[name])
+            self[name] = options[name] if options.key?(name)
           end
 
           yield(self) if block_given?
@@ -29,6 +33,21 @@ module Datadog
         def []=(name, value)
           respond_to?("#{name}=") ? send("#{name}=", value) : set_option(name, value)
         end
+
+        DEPRECATION_WARNING = %(
+          Explicitly providing a tracer instance is DEPRECATED.
+          It's recommended to not provide an explicit tracer instance
+          and let Datadog::Contrib::Configuration::Settings resolve
+          the correct tracer internally.
+          ).freeze
+
+        include Datadog::Patcher # DEV includes #do_once here. We should move that logic to a generic component.
+
+        def log_deprecation_warning(method_name)
+          do_once(method_name) do
+            Datadog.logger.warn("#{method_name}:#{DEPRECATION_WARNING}:#{caller.join("\n")}")
+          end
+        end
       end
     end
   end

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

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the Dalli integration
         class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
           option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           end
 

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

@@ -4,8 +4,11 @@ module Datadog
       # Dalli integration constants
       module Ext
         APP = 'dalli'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_DALLI_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_DALLI_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_DALLI_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_DALLI_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_DALLI_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DALLI_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_DALLI_ANALYTICS_SAMPLE_RATE'.freeze
         QUANTIZE_MAX_CMD_LENGTH = 100
         SERVICE_NAME = 'memcached'.freeze
         SPAN_COMMAND = 'memcached.command'.freeze

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

@@ -29,7 +29,7 @@ module Datadog
               get_option(:service_name),
               app: Ext::APP,
               app_type: Datadog::Ext::AppTypes::CACHE,
-              tracer: get_option(:tracer)
+              tracer: -> { get_option(:tracer) }
             ).onto(::Dalli)
         end
 
@@ -47,10 +47,6 @@ module Datadog
             Upgrade to the configuration API using the migration guide here:
             https://github.com/DataDog/dd-trace-rb/releases/tag/v0.11.0).freeze
 
-          def tracer=(tracer)
-            Datadog.configuration[:dalli][:tracer] = tracer
-          end
-
           def service_name=(service_name)
             Datadog.configuration[:dalli][:service_name] = service_name
           end

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

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the DelayedJob integration
         class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
           option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           end
 

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

@@ -4,8 +4,11 @@ module Datadog
       # DelayedJob integration constants
       module Ext
         APP = 'delayed_job'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_DELAYED_JOB_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_DELAYED_JOB_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_DELAYED_JOB_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_DELAYED_JOB_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'delayed_job'.freeze
         SPAN_JOB = 'delayed_job'.freeze
         TAG_ATTEMPTS = 'delayed_job.attempts'.freeze

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

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the Elasticsearch integration
         class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
           option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           end
 

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

@@ -4,8 +4,11 @@ module Datadog
       # Elasticsearch integration constants
       module Ext
         APP = 'elasticsearch'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_ELASTICSEARCH_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_ELASTICSEARCH_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_ELASTICSEARCH_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ELASTICSEARCH_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_ELASTICSEARCH_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ELASTICSEARCH_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ELASTICSEARCH_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'elasticsearch'.freeze
         SPAN_QUERY = 'elasticsearch.query'.freeze
         SPAN_TYPE_QUERY = 'elasticsearch'.freeze

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

@@ -37,14 +37,13 @@ module Datadog
             end
 
             def initialize(*args, &block)
-              tracer = Datadog.configuration[:elasticsearch][:tracer]
               service = Datadog.configuration[:elasticsearch][:service_name]
 
               pin = Datadog::Pin.new(
                 service,
                 app: Datadog::Contrib::Elasticsearch::Ext::APP,
                 app_type: Datadog::Ext::AppTypes::DB,
-                tracer: tracer
+                tracer: -> { Datadog.configuration[:elasticsearch][:tracer] }
               )
               pin.onto(self)
               initialize_without_datadog(*args, &block)

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

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the Ethon integration
         class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
           option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           end
 

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

@@ -4,8 +4,11 @@ module Datadog
       # Ethon integration constants
       module Ext
         APP = 'ethon'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_ETHON_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_ETHON_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_ETHON_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ETHON_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_ETHON_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ETHON_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ETHON_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'ethon'.freeze
         SPAN_REQUEST = 'ethon.request'.freeze
         SPAN_MULTI_REQUEST = 'ethon.multi.request'.freeze

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

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the Excon integration
         class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
           option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           end
 

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

@@ -4,8 +4,11 @@ module Datadog
       # Excon integration constants
       module Ext
         APP = 'excon'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_EXCON_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_EXCON_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_EXCON_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_EXCON_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_EXCON_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_EXCON_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_EXCON_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'excon'.freeze
         SPAN_REQUEST = 'excon.request'.freeze
       end

data/lib/ddtrace/contrib/extensions.rb

@@ -1,3 +1,4 @@
+require 'set'
 require 'ddtrace/contrib/registry'
 
 module Datadog
@@ -7,6 +8,7 @@ module Datadog
     module Extensions
       def self.extended(base)
         Datadog.send(:extend, Helpers)
+        Datadog.send(:extend, Configuration)
         Datadog::Configuration::Settings.send(:include, Configuration::Settings)
       end
 
@@ -17,7 +19,24 @@ module Datadog
         end
       end
 
+      # Configuration methods for Datadog module.
       module Configuration
+        def configure(target = configuration, opts = {})
+          # Reconfigure core settings
+          super
+
+          # Activate integrations
+          if target.respond_to?(:integrations_pending_activation)
+            target.integrations_pending_activation.each do |integration|
+              integration.patch if integration.respond_to?(:patch)
+            end
+
+            target.integrations_pending_activation.clear
+          end
+
+          target
+        end
+
         # Extensions for Datadog::Configuration::Settings
         module Settings
           InvalidIntegrationError = Class.new(StandardError)
@@ -34,22 +53,37 @@ module Datadog
             integration.configuration(configuration_name) unless integration.nil?
           end
 
-          def use(integration_name, options = {}, &block)
+          def instrument(integration_name, options = {}, &block)
             integration = fetch_integration(integration_name)
 
-            unless integration.nil?
+            unless integration.nil? || !integration.default_configuration.enabled
               configuration_name = options[:describes] || :default
               filtered_options = options.reject { |k, _v| k == :describes }
               integration.configure(configuration_name, filtered_options, &block)
+              instrumented_integrations[integration_name] = integration
+
+              # Add to activation list
+              integrations_pending_activation << integration
             end
+          end
+
+          alias_method :use, :instrument
 
-            integration.patch if integration.respond_to?(:patch)
+          def integrations_pending_activation
+            @integrations_pending_activation ||= Set.new
           end
 
-          private
+          def instrumented_integrations
+            @instrumented_integrations ||= {}
+          end
+
+          def reset!
+            instrumented_integrations.clear
+            super
+          end
 
           def fetch_integration(name)
-            get_option(:registry)[name] ||
+            registry[name] ||
               raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
           end
         end

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

@@ -12,13 +12,18 @@ module Datadog
             Datadog::Ext::HTTP::ERROR_RANGE.cover?(env[:status])
           end
 
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
           option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           end
 

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

@@ -4,8 +4,11 @@ module Datadog
       # Faraday integration constants
       module Ext
         APP = 'faraday'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_FARADAY_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_FARADAY_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_FARADAY_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_FARADAY_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_FARADAY_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_FARADAY_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_FARADAY_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'faraday'.freeze
         SPAN_REQUEST = 'faraday.request'.freeze
       end

data/lib/ddtrace/contrib/faraday/middleware.rb

@@ -16,7 +16,7 @@ module Datadog
 
         def initialize(app, options = {})
           super(app)
-          @options = datadog_configuration.options_hash.merge(options)
+          @options = options
         end
 
         def call(env)
@@ -33,7 +33,7 @@ module Datadog
 
         private
 
-        attr_reader :app, :options
+        attr_reader :app
 
         def annotate!(span, env, options)
           span.resource = resource_name(env)
@@ -69,7 +69,9 @@ module Datadog
         end
 
         def build_request_options!(env)
-          datadog_configuration(env[:url].host).options_hash.merge(options)
+          datadog_configuration.options_hash # integration level settings
+                               .merge(datadog_configuration(env[:url].host).options_hash) # per-host override
+                               .merge(@options) # middleware instance override
         end
 
         def datadog_configuration(host = :default)

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

@@ -31,7 +31,7 @@ module Datadog
               get_option(:service_name),
               app: Ext::APP,
               app_type: Datadog::Ext::AppTypes::WEB,
-              tracer: get_option(:tracer)
+              tracer: -> { get_option(:tracer) }
             ).onto(::Faraday)
         end
 
@@ -41,8 +41,20 @@ module Datadog
 
         def add_default_middleware!
           if target_version >= Gem::Version.new('1.0.0')
+            # Patch the default connection (e.g. +Faraday.get+)
+            ::Faraday.default_connection.use(:ddtrace)
+
+            # Patch new connection instances (e.g. +Faraday.new+)
             ::Faraday::Connection.send(:prepend, Connection)
           else
+            # Patch the default connection (e.g. +Faraday.get+)
+            #
+            # We insert our middleware before the 'adapter', which is
+            # always the last handler.
+            idx = ::Faraday.default_connection.builder.handlers.size - 1
+            ::Faraday.default_connection.builder.insert(idx, Middleware)
+
+            # Patch new connection instances (e.g. +Faraday.new+)
             ::Faraday::RackBuilder.send(:prepend, RackBuilder)
           end
         end
@@ -61,10 +73,6 @@ module Datadog
             Upgrade to the configuration API using the migration guide here:
             https://github.com/DataDog/dd-trace-rb/releases/tag/v0.11.0).freeze
 
-          def tracer=(tracer)
-            Datadog.configuration[:faraday][:tracer] = tracer
-          end
-
           def service_name=(service_name)
             Datadog.configuration[:faraday][:service_name] = service_name
           end