ddtrace 1.0.0 → 1.9.0

data/lib/datadog/tracing/contrib/rack/patcher.rb

@@ -91,10 +91,12 @@ module Datadog
               if get_option(:application)
                 MiddlewareNamePatcher.patch
               else
-                Datadog.logger.warn(%(
+                Datadog.logger.warn(
+                  %(
                 Rack :middleware_names requires you to also pass :application.
                 Middleware names have NOT been patched; please provide :application.
-                e.g. use: :rack, middleware_names: true, application: my_rack_app).freeze)
+                e.g. use: :rack, middleware_names: true, application: my_rack_app).freeze
+                )
               end
             end
           end
@@ -102,6 +104,14 @@ module Datadog
           def get_option(option)
             Datadog.configuration.tracing[:rack].get_option(option)
           end
+
+          def patch_successful
+            MiddlewarePatcher.patch_successful || MiddlewareNamePatcher.patch_successful
+          end
+
+          def patch_error_result
+            MiddlewarePatcher.patch_error_result || MiddlewareNamePatcher.patch_error_result
+          end
         end
       end
     end

data/lib/datadog/tracing/contrib/rails/auto_instrument_railtie.rb

@@ -1,6 +1,6 @@
 # typed: ignore
 
-require 'datadog/tracing/contrib/auto_instrument'
+require_relative '../auto_instrument'
 
 # Railtie to include AutoInstrumentation in rails loading
 class DatadogAutoInstrumentRailtie < Rails::Railtie

data/lib/datadog/tracing/contrib/rails/configuration/settings.rb

@@ -1,6 +1,6 @@
 # typed: false
 
-require 'datadog/tracing/contrib/configuration/settings'
+require_relative '../../configuration/settings'
 
 module Datadog
   module Tracing
@@ -47,6 +47,9 @@ module Datadog
             end
 
             option :distributed_tracing, default: true
+
+            option :request_queuing, default: false
+
             option :exception_controller do |o|
               o.on_set do |value|
                 # Update ActionPack exception controller too

data/lib/datadog/tracing/contrib/rails/framework.rb

@@ -1,17 +1,16 @@
 # typed: false
 
-require 'datadog/tracing'
-require 'datadog/tracing/contrib/action_cable/integration'
-require 'datadog/tracing/contrib/action_mailer/integration'
-require 'datadog/tracing/contrib/action_pack/integration'
-require 'datadog/tracing/contrib/action_view/integration'
-require 'datadog/tracing/contrib/active_record/integration'
-require 'datadog/tracing/contrib/active_support/integration'
-require 'datadog/tracing/contrib/grape/endpoint'
-require 'datadog/tracing/contrib/lograge/integration'
-require 'datadog/tracing/contrib/rails/ext'
-require 'datadog/tracing/contrib/rails/utils'
-require 'datadog/tracing/contrib/semantic_logger/integration'
+require_relative '../action_cable/integration'
+require_relative '../action_mailer/integration'
+require_relative '../action_pack/integration'
+require_relative '../action_view/integration'
+require_relative '../active_record/integration'
+require_relative '../active_support/integration'
+require_relative '../grape/endpoint'
+require_relative '../lograge/integration'
+require_relative 'ext'
+require_relative 'utils'
+require_relative '../semantic_logger/integration'
 
 module Datadog
   module Tracing
@@ -36,18 +35,14 @@ module Datadog
             #       used to reconfigure tracer components with Rails-sourced defaults.
             #       This is a trade-off we take to get nice defaults.
             Datadog.configure do |datadog_config|
+              rails_config = datadog_config.tracing[:rails]
+
               # By default, default service would be guessed from the script
               # being executed, but here we know better, get it from Rails config.
               # Don't set this if service has been explicitly provided by the user.
-              rails_service_name = Datadog.configuration.tracing[:rails][:service_name] \
-                                    || Datadog.configuration.service_without_fallback \
-                                    || Utils.app_name
-
-              datadog_config.service ||= rails_service_name
-            end
-
-            Datadog.configure do |datadog_config|
-              rails_config = datadog_config.tracing[:rails]
+              if datadog_config.service_without_fallback.nil?
+                datadog_config.service = rails_config[:service_name] || Utils.app_name
+              end
 
               activate_rack!(datadog_config, rails_config)
               activate_action_cable!(datadog_config, rails_config)
@@ -68,7 +63,8 @@ module Datadog
               application: ::Rails.application,
               service_name: rails_config[:service_name],
               middleware_names: rails_config[:middleware_names],
-              distributed_tracing: rails_config[:distributed_tracing]
+              distributed_tracing: rails_config[:distributed_tracing],
+              request_queuing: rails_config[:request_queuing]
             )
           end
 

data/lib/datadog/tracing/contrib/rails/integration.rb

@@ -1,10 +1,10 @@
 # typed: false
 
-require 'datadog/tracing/contrib/integration'
+require_relative '../integration'
 
-require 'datadog/tracing/contrib/rails/ext'
-require 'datadog/tracing/contrib/rails/configuration/settings'
-require 'datadog/tracing/contrib/rails/patcher'
+require_relative 'ext'
+require_relative 'configuration/settings'
+require_relative 'patcher'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/rails/log_injection.rb

@@ -1,7 +1,5 @@
 # typed: false
 
-require 'datadog/tracing'
-
 module Datadog
   module Tracing
     module Contrib
@@ -22,24 +20,11 @@ module Datadog
             end
           rescue StandardError => e
             # TODO: can we use Datadog.logger at this point?
-            Datadog.logger.warn("Unable to add Datadog Trace context to ActiveSupport::TaggedLogging: #{e.message}")
+            Datadog.logger.warn(
+              "Unable to add Datadog Trace context to ActiveSupport::TaggedLogging: #{e.class.name} #{e.message}"
+            )
             false
           end
-
-          def datadog_trace_log_hash(correlation)
-            {
-              # Adds IDs as tags to log output
-              dd: {
-                # To preserve precision during JSON serialization, use strings for large numbers
-                trace_id: correlation.trace_id.to_s,
-                span_id: correlation.span_id.to_s,
-                env: correlation.env.to_s,
-                service: correlation.service.to_s,
-                version: correlation.version.to_s
-              },
-              ddsource: ['ruby']
-            }
-          end
         end
       end
     end

data/lib/datadog/tracing/contrib/rails/middlewares.rb

@@ -1,7 +1,6 @@
 # typed: true
 
-require 'datadog/tracing'
-require 'datadog/tracing/contrib/action_pack/utils'
+require_relative '../action_pack/utils'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/rails/patcher.rb

@@ -1,13 +1,12 @@
 # typed: ignore
 
-require 'datadog/core/utils/only_once'
-require 'datadog/tracing'
-require 'datadog/tracing/contrib/rack/middlewares'
-require 'datadog/tracing/contrib/rails/framework'
-require 'datadog/tracing/contrib/rails/log_injection'
-require 'datadog/tracing/contrib/rails/middlewares'
-require 'datadog/tracing/contrib/rails/utils'
-require 'datadog/tracing/contrib/semantic_logger/patcher'
+require_relative '../../../core/utils/only_once'
+require_relative '../rack/middlewares'
+require_relative 'framework'
+require_relative 'log_injection'
+require_relative 'middlewares'
+require_relative 'utils'
+require_relative '../semantic_logger/patcher'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/rails/railtie.rb

@@ -1,8 +1,8 @@
 # typed: ignore
 
-require 'datadog/tracing/contrib/rails/framework'
-require 'datadog/tracing/contrib/rails/middlewares'
-require 'datadog/tracing/contrib/rack/middlewares'
+require_relative 'framework'
+require_relative 'middlewares'
+require_relative '../rack/middlewares'
 
 module Datadog
   # Railtie class initializes

data/lib/datadog/tracing/contrib/rails/utils.rb

@@ -1,6 +1,6 @@
 # typed: false
 
-require 'datadog/tracing/contrib/analytics'
+require_relative '../analytics'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/rake/configuration/settings.rb

@@ -1,7 +1,9 @@
 # typed: false
 
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/rake/ext'
+require 'set'
+
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing
@@ -28,6 +30,19 @@ module Datadog
 
             option :quantize, default: {}
             option :service_name
+
+            # A list of rake tasks, using their string names, to be instrumented.
+            # An empty list, or not setting this option means no task is instrumented.
+            # Automatically instrumenting all Rake tasks can lead to long-running tasks
+            # causing undue memory accumulation, as the trace for such tasks is never flushed.
+            option :tasks do |o|
+              o.default { [] }
+              o.lazy
+              o.on_set do |value|
+                # DEV: It should be possible to modify the value after it's set. E.g. for normalization.
+                options[:tasks].instance_variable_set(:@value, value.map(&:to_s).to_set)
+              end
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/rake/instrumentation.rb

@@ -1,10 +1,9 @@
 # typed: false
 
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/rake/ext'
-require 'datadog/tracing/contrib/utils/quantization/hash'
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative '../utils/quantization/hash'
 
 module Datadog
   module Tracing
@@ -19,7 +18,7 @@ module Datadog
           # Instance methods for Rake instrumentation
           module InstanceMethods
             def invoke(*args)
-              return super unless enabled?
+              return super if !enabled? || !instrumented_task?
 
               Tracing.trace(Ext::SPAN_INVOKE, **span_options) do |span|
                 annotate_invoke!(span, args)
@@ -30,7 +29,7 @@ module Datadog
             end
 
             def execute(args = nil)
-              return super unless enabled?
+              return super if !enabled? || !instrumented_task?
 
               Tracing.trace(Ext::SPAN_EXECUTE, **span_options) do |span|
                 annotate_execute!(span, args)
@@ -42,6 +41,12 @@ module Datadog
 
             private
 
+            # Task names are verified dynamically, in order to be agnostic of
+            # when tracing is configured in relation to Rake task declaration.
+            def instrumented_task?
+              configuration[:tasks].include?(name)
+            end
+
             def shutdown_tracer!
               Tracing.shutdown! if Tracing.active_span.nil? && ::Rake.application.top_level_tasks.include?(name)
             end
@@ -61,7 +66,7 @@ module Datadog
               span.set_tag(Ext::TAG_TASK_ARG_NAMES, arg_names)
               span.set_tag(Ext::TAG_INVOKE_ARGS, quantize_args(args)) unless args.nil?
             rescue StandardError => e
-              Datadog.logger.debug("Error while tracing Rake invoke: #{e.message}")
+              Datadog.logger.debug("Error while tracing Rake invoke: #{e.class.name} #{e.message}")
             end
 
             def annotate_execute!(span, args)
@@ -70,7 +75,7 @@ module Datadog
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_EXECUTE)
               span.set_tag(Ext::TAG_EXECUTE_ARGS, quantize_args(args.to_hash)) unless args.nil?
             rescue StandardError => e
-              Datadog.logger.debug("Error while tracing Rake execute: #{e.message}")
+              Datadog.logger.debug("Error while tracing Rake execute: #{e.class.name} #{e.message}")
             end
 
             def quantize_args(args)

data/lib/datadog/tracing/contrib/rake/integration.rb

@@ -1,8 +1,8 @@
 # typed: false
 
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/rake/configuration/settings'
-require 'datadog/tracing/contrib/rake/patcher'
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/rake/patcher.rb

@@ -1,10 +1,8 @@
 # typed: true
 
-require 'datadog/tracing'
-require 'datadog/tracing/contrib/patcher'
-require 'datadog/tracing/contrib/rake/ext'
-require 'datadog/tracing/contrib/rake/instrumentation'
-require 'datadog/tracing/contrib/rake/integration'
+require_relative '../patcher'
+require_relative 'ext'
+require_relative 'instrumentation'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/redis/configuration/resolver.rb

@@ -1,6 +1,6 @@
 # typed: true
 
-require 'datadog/tracing/contrib/redis/vendor/resolver'
+require_relative '../vendor/resolver'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/redis/configuration/settings.rb

@@ -1,7 +1,7 @@
 # typed: false
 
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/redis/ext'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing
@@ -31,7 +31,10 @@ module Datadog
               o.lazy
             end
 
-            option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
+            option :service_name do |o|
+              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.lazy
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/redis/ext.rb

@@ -8,6 +8,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_REDIS_ENABLED'.freeze
+          ENV_SERVICE_NAME = 'DD_TRACE_REDIS_SERVICE_NAME'.freeze
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_REDIS_ANALYTICS_ENABLED'.freeze
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_REDIS_ANALYTICS_SAMPLE_RATE'.freeze
           ENV_COMMAND_ARGS = 'DD_REDIS_COMMAND_ARGS'.freeze
@@ -19,6 +20,8 @@ module Datadog
           TYPE = 'redis'.freeze
           TAG_COMPONENT = 'redis'.freeze
           TAG_OPERATION_COMMAND = 'command'.freeze
+          TAG_SYSTEM = 'redis'.freeze
+          TAG_DATABASE_INDEX = 'db.redis.database_index'.freeze
         end
       end
     end

data/lib/datadog/tracing/contrib/redis/instrumentation.rb

@@ -1,17 +1,16 @@
 # typed: false
 
-require 'datadog/tracing'
-require 'datadog/tracing/contrib/patcher'
-require 'datadog/tracing/contrib/redis/configuration/resolver'
-require 'datadog/tracing/contrib/redis/ext'
-require 'datadog/tracing/contrib/redis/quantize'
-require 'datadog/tracing/contrib/redis/tags'
+require_relative '../patcher'
+require_relative 'configuration/resolver'
+require_relative 'ext'
+require_relative 'quantize'
+require_relative 'tags'
 
 module Datadog
   module Tracing
     module Contrib
       module Redis
-        # Instrumentation for Redis
+        # Instrumentation for Redis < 5
         module Instrumentation
           def self.included(base)
             base.prepend(InstanceMethods)
@@ -20,47 +19,58 @@ module Datadog
           # InstanceMethods - implementing instrumentation
           module InstanceMethods
             def call(*args, &block)
-              response = nil
+              show_command_args = command_args?
+
               Tracing.trace(Contrib::Redis::Ext::SPAN_COMMAND) do |span|
-                span.service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
+                span.service = service_name
                 span.span_type = Contrib::Redis::Ext::TYPE
-                span.resource = get_command(args)
-                Contrib::Redis::Tags.set_common_tags(self, span)
+                span.resource = get_command(args, show_command_args)
+                Contrib::Redis::Tags.set_common_tags(self, span, show_command_args)
 
-                response = super
+                super
               end
-
-              response
             end
 
             def call_pipeline(*args, &block)
-              response = nil
+              show_command_args = command_args?
+
               Tracing.trace(Contrib::Redis::Ext::SPAN_COMMAND) do |span|
-                span.service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
+                span.service = service_name
                 span.span_type = Contrib::Redis::Ext::TYPE
-                commands = get_pipeline_commands(args)
-                span.resource = commands.join("\n")
+                commands = get_pipeline_commands(args, show_command_args)
+                span.resource = commands.any? ? commands.join("\n") : '(none)'
                 span.set_metric Contrib::Redis::Ext::METRIC_PIPELINE_LEN, commands.length
-                Contrib::Redis::Tags.set_common_tags(self, span)
+                Contrib::Redis::Tags.set_common_tags(self, span, show_command_args)
 
-                response = super
+                super
               end
-
-              response
             end
 
             private
 
-            def get_command(args)
-              if datadog_configuration[:command_args]
+            def command_args?
+              pinned = Datadog.configuration_for(redis_instance, :command_args)
+
+              return pinned unless pinned.nil?
+
+              datadog_configuration[:command_args]
+            end
+
+            def service_name
+              Datadog.configuration_for(redis_instance, :service_name) ||
+                datadog_configuration[:service_name]
+            end
+
+            def get_command(args, show_command_args)
+              if show_command_args
                 Contrib::Redis::Quantize.format_command_args(*args)
               else
                 Contrib::Redis::Quantize.get_verb(*args)
               end
             end
 
-            def get_pipeline_commands(args)
-              if datadog_configuration[:command_args]
+            def get_pipeline_commands(args, show_command_args)
+              if show_command_args
                 args[0].commands.map { |c| Contrib::Redis::Quantize.format_command_args(c) }
               else
                 args[0].commands.map { |c| Contrib::Redis::Quantize.get_verb(c) }

data/lib/datadog/tracing/contrib/redis/integration.rb

@@ -1,8 +1,8 @@
 # typed: false
 
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/redis/configuration/settings'
-require 'datadog/tracing/contrib/redis/patcher'
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
 
 module Datadog
   module Tracing
@@ -14,19 +14,52 @@ module Datadog
 
           MINIMUM_VERSION = Gem::Version.new('3.2')
 
+          # Support `Config#custom`
+          # https://github.com/redis-rb/redis-client/blob/master/CHANGELOG.md#0110
+          REDISCLIENT_MINIMUM_VERSION = Gem::Version.new('0.11.0')
+
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :redis, auto_patch: true
 
+          # Until Redis 4, all instrumentation happened in one gem: redis.
+          # Since Redis 5, instrumentation happens in a separate gem: redis-client.
+          # Because Redis 4 does not depend on redis-client, it's possible for both gems to be installed at the same time.
+          # For example, if Sidekiq 7 and Redis 4 are installed: both redis and redis-client will be installed.
+          # If redis-client and redis > 5 are installed, than they will be in sync, and only redis-client will be installed.
           def self.version
+            redis_version || redis_client_version
+          end
+
+          def self.redis_version
             Gem.loaded_specs['redis'] && Gem.loaded_specs['redis'].version
           end
 
+          def self.redis_client_version
+            Gem.loaded_specs['redis-client'] && Gem.loaded_specs['redis-client'].version
+          end
+
           def self.loaded?
+            redis_loaded? || redis_client_loaded?
+          end
+
+          def self.redis_loaded?
             !defined?(::Redis).nil?
           end
 
+          def self.redis_client_loaded?
+            !defined?(::RedisClient).nil?
+          end
+
           def self.compatible?
-            super && version >= MINIMUM_VERSION
+            super && (redis_compatible? || redis_client_compatible?)
+          end
+
+          def self.redis_compatible?
+            !!(redis_version && redis_version >= MINIMUM_VERSION)
+          end
+
+          def self.redis_client_compatible?
+            !!(redis_client_version && redis_client_version >= REDISCLIENT_MINIMUM_VERSION)
           end
 
           def new_configuration

data/lib/datadog/tracing/contrib/redis/patcher.rb

@@ -1,9 +1,8 @@
-# typed: false
+# typed: ignore
 
-require 'datadog/tracing/contrib/patcher'
-require 'datadog/tracing/contrib/redis/ext'
-require 'datadog/tracing/contrib/redis/configuration/resolver'
-require 'datadog/tracing/contrib/redis/integration'
+require_relative '../patcher'
+require_relative 'ext'
+require_relative 'configuration/resolver'
 
 module Datadog
   module Tracing
@@ -13,21 +12,65 @@ module Datadog
         module Patcher
           include Contrib::Patcher
 
+          # Patch for redis instance
+          module InstancePatch
+            def self.included(base)
+              base.prepend(InstanceMethods)
+            end
+
+            # Instance method patch for redis instance
+            module InstanceMethods
+              # `options` could be frozen
+              def initialize(options = {})
+                super(options.merge(redis_instance: self))
+              end
+            end
+          end
+
+          # Patch for redis client
+          module ClientPatch
+            def self.included(base)
+              base.prepend(InstanceMethods)
+            end
+
+            # Instance method patch for redis client
+            module InstanceMethods
+              def initialize(options = {})
+                @redis_instance = options.delete(:redis_instance)
+
+                super(options)
+              end
+
+              private
+
+              attr_reader :redis_instance
+            end
+          end
+
           module_function
 
-          def target_version
-            Integration.version
+          def default_tags
+            [].tap do |tags|
+              tags << "target_redis_version:#{Integration.redis_version}"               if Integration.redis_version
+              tags << "target_redis_client_version:#{Integration.redis_client_version}" if Integration.redis_client_version
+            end
           end
 
-          # patch applies our patch if needed
           def patch
-            # do not require these by default, but only when actually patching
-            require 'redis'
-            require 'datadog/tracing/contrib/redis/tags'
-            require 'datadog/tracing/contrib/redis/quantize'
-            require 'datadog/tracing/contrib/redis/instrumentation'
+            # Redis 5+ extracts RedisClient to its own gem and provide instrumentation interface
+            if Integration.redis_client_compatible?
+              require_relative 'trace_middleware'
+
+              ::RedisClient.register(TraceMiddleware)
+            end
+
+            if Integration.redis_compatible? && Integration.redis_version < Gem::Version.new('5.0.0')
+              require_relative 'instrumentation'
 
-            ::Redis::Client.include(Instrumentation)
+              ::Redis.include(InstancePatch)
+              ::Redis::Client.include(ClientPatch)
+              ::Redis::Client.include(Instrumentation)
+            end
           end
         end
       end