ddtrace 0.35.0 → 0.38.0

data/lib/ddtrace/configuration/base.rb

@@ -45,7 +45,7 @@ module Datadog
       # Instance methods for configuration
       module InstanceMethods
         def initialize(options = {})
-          configure(options)
+          configure(options) unless options.empty?
         end
 
         def configure(opts = {})

data/lib/ddtrace/configuration/components.rb

@@ -135,13 +135,13 @@ module Datadog
         old_statsd = [
           runtime_metrics.metrics.statsd,
           health_metrics.statsd
-        ].uniq
+        ].compact.uniq
 
         new_statsd =  if replacement
                         [
                           replacement.runtime_metrics.metrics.statsd,
                           replacement.health_metrics.statsd
-                        ].uniq
+                        ].compact.uniq
                       else
                         []
                       end

data/lib/ddtrace/configuration/options.rb

@@ -80,7 +80,7 @@ module Datadog
         end
 
         def options_hash
-          options.each_with_object({}) do |(key, _), hash|
+          self.class.options.merge(options).each_with_object({}) do |(key, _), hash|
             hash[key] = get_option(key)
           end
         end

data/lib/ddtrace/configuration/pin_setup.rb

@@ -13,7 +13,7 @@ module Datadog
 
         ATTRS.each { |key| pin.public_send("#{key}=", opts[key]) if opts[key] }
 
-        pin.config = opts.reject { |key, _| ATTRS.include?(key) }
+        pin.config = opts.reject { |key, _| ATTRS.include?(key) || DEPRECATED_ATTRS.include?(key) }
 
         true
       end
@@ -22,7 +22,8 @@ module Datadog
 
       attr_reader :pin, :opts
 
-      ATTRS = [:app, :tags, :app_type, :name, :tracer, :service_name].freeze
+      ATTRS = [:app, :tags, :app_type, :name, :service_name].freeze
+      DEPRECATED_ATTRS = [:tracer].freeze
 
       private_constant :ATTRS
     end

data/lib/ddtrace/configuration/settings.rb

@@ -31,6 +31,11 @@ module Datadog
         end
       end
 
+      option :api_key do |o|
+        o.default { ENV.fetch(Ext::Environment::ENV_API_KEY, nil) }
+        o.lazy
+      end
+
       settings :diagnostics do
         option :debug, default: false
 
@@ -42,6 +47,14 @@ module Datadog
 
           option :statsd
         end
+
+        settings :startup_logs do
+          option :enabled do |o|
+            # Defaults to nil as we want to know when the default value is being used
+            o.default { env_to_bool(Datadog::Ext::Diagnostics::DD_TRACE_STARTUP_LOGS, nil) }
+            o.lazy
+          end
+        end
       end
 
       settings :distributed_tracing do
@@ -138,6 +151,11 @@ module Datadog
         o.lazy
       end
 
+      option :site do |o|
+        o.default { ENV.fetch(Ext::Environment::ENV_SITE, nil) }
+        o.lazy
+      end
+
       option :tags do |o|
         o.default do
           tags = {}

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

@@ -14,7 +14,7 @@ module Datadog
             # We need to do a per-method monkey patching as some of them might
             # be redefined, and some of them not. The latest version of redis-activesupport
             # redefines write but leaves untouched read and delete:
-            # https://github.com/redis-store/redis-activesupport/blob/master/lib/active_support/cache/redis_store.rb
+            # https://github.com/redis-store/redis-activesupport/blob/v4.1.5/lib/active_support/cache/redis_store.rb
             #
             # For Rails >= 5.2 w/o redis-activesupport...
             # ActiveSupport includes a Redis cache store internally, and does not require these overrides.

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

@@ -18,6 +18,8 @@ module Datadog
           # Redefines some class behaviors for a Subscriber to make
           # it a bit simpler for an Event.
           module ClassMethods
+            DEFAULT_TRACER = -> { Datadog.tracer }
+
             def subscribe!
               super
             end
@@ -52,7 +54,7 @@ module Datadog
             end
 
             def tracer
-              Datadog.tracer
+              DEFAULT_TRACER
             end
           end
         end

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

@@ -75,7 +75,7 @@ module Datadog
             callbacks.run(name, :before_trace, id, payload, start)
 
             # Start a trace
-            tracer.trace(@span_name, @options).tap do |span|
+            tracer.trace(@span_name, @options.dup).tap do |span|
               # Assign start time if provided
               span.start_time = start unless start.nil?
               payload[:datadog_span] = span

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

@@ -16,11 +16,17 @@ module Datadog
 
         # post method runs the task within composited executor - in a different thread
         def post(*args, &task)
-          context = datadog_configuration.tracer.provider.context
+          parent_context = datadog_configuration.tracer.provider.context
 
           @composited_executor.post(*args) do
-            datadog_configuration.tracer.provider.context = context
-            yield
+            begin
+              original_context = datadog_configuration.tracer.provider.context
+              datadog_configuration.tracer.provider.context = parent_context
+              yield
+            ensure
+              # Restore context in case the current thread gets reused
+              datadog_configuration.tracer.provider.context = original_context
+            end
           end
         end
 

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

@@ -12,11 +12,14 @@ module Datadog
         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 +32,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/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/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/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?
               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/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
 
@@ -45,6 +45,9 @@ module Datadog
           else
             ::Faraday::RackBuilder.send(:prepend, RackBuilder)
           end
+
+          # Instrument the Faraday default connection (e.g. +Faraday.get+)
+          ::Faraday.default_connection.use(:ddtrace)
         end
 
         def get_option(option)
@@ -61,10 +64,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

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

@@ -34,7 +34,7 @@ module Datadog
             get_option(:service_name),
             app: Ext::APP,
             app_type: Datadog::Ext::AppTypes::WEB,
-            tracer: get_option(:tracer)
+            tracer: -> { get_option(:tracer) }
           )
           pin.onto(::Grape)
         end

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

@@ -22,7 +22,6 @@ module Datadog
         end
 
         def patch_schema!(schema)
-          tracer = get_option(:tracer)
           service_name = get_option(:service_name)
           analytics_enabled = Contrib::Analytics.enabled?(get_option(:analytics_enabled))
           analytics_sample_rate = get_option(:analytics_sample_rate)
@@ -30,7 +29,9 @@ module Datadog
           if schema.respond_to?(:use)
             schema.use(
               ::GraphQL::Tracing::DataDogTracing,
-              tracer: tracer,
+              # By default, Tracing::DataDogTracing indirectly delegates the tracer instance
+              # to +Datadog.tracer+. If we provide a tracer argument here it will be eagerly cached,
+              # and Tracing::DataDogTracing will send traces to a stale tracer instance.
               service: service_name,
               analytics_enabled: analytics_enabled,
               analytics_sample_rate: analytics_sample_rate
@@ -39,7 +40,9 @@ module Datadog
             schema.define do
               use(
                 ::GraphQL::Tracing::DataDogTracing,
-                tracer: tracer,
+                # By default, Tracing::DataDogTracing indirectly delegates the tracer instance
+                # to +Datadog.tracer+. If we provide a tracer argument here it will be eagerly cached,
+                # and Tracing::DataDogTracing will send traces to a stale tracer instance.
                 service: service_name,
                 analytics_enabled: analytics_enabled,
                 analytics_sample_rate: analytics_sample_rate

data/lib/ddtrace/contrib/grpc/datadog_interceptor.rb

@@ -38,7 +38,7 @@ module Datadog
               service_name,
               app: Ext::APP,
               app_type: Datadog::Ext::AppTypes::WEB,
-              tracer: tracer
+              tracer: -> { datadog_configuration[:tracer] }
             ).tap do |pin|
               yield(pin) if block_given?
               pin.onto(self)

data/lib/ddtrace/contrib/grpc/datadog_interceptor/client.rb

@@ -30,9 +30,7 @@ module Datadog
           private
 
           def annotate!(span, metadata)
-            metadata.each do |header, value|
-              span.set_tag(header, value)
-            end
+            span.set_tags(metadata)
 
             # Set analytics sample rate
             Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?

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

@@ -29,7 +29,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(::GRPC)
         end
 
@@ -52,10 +52,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[:grpc][:tracer] = tracer
-          end
-
           def service_name=(service_name)
             Datadog.configuration[:grpc][:service_name] = service_name
           end