ddtrace 1.0.0 → 1.10.1

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

@@ -1,10 +1,7 @@
-# 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 +16,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 +27,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 +39,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 +64,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 +73,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,6 @@
-# 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,6 @@
-# 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,4 @@
-# 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,5 @@
-# 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 +29,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

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Tracing
     module Contrib
@@ -8,6 +6,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 +18,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,14 @@
-# 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 +17,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,6 @@
-# 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 +12,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,6 @@
-# typed: false
-
-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 +10,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

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

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 require 'set'
 
@@ -8,11 +8,13 @@ module Datadog
       module Redis
         # Quantize contains Redis-specific resource quantization tools.
         module Quantize
-          PLACEHOLDER = '?'.freeze
-          TOO_LONG_MARK = '...'.freeze
+          PLACEHOLDER = '?'
+          TOO_LONG_MARK = '...'
           VALUE_MAX_LEN = 50
           CMD_MAX_LEN = 500
 
+          AUTH_COMMANDS = %w[AUTH auth].freeze
+
           MULTI_VERB_COMMANDS = Set.new(
             %w[
               ACL
@@ -29,8 +31,7 @@ module Datadog
           module_function
 
           def format_arg(arg)
-            str = arg.is_a?(Symbol) ? arg.to_s.upcase : arg.to_s
-            str = Core::Utils.utf8_encode(str, binary: true, placeholder: PLACEHOLDER)
+            str = Core::Utils.utf8_encode(arg, binary: true, placeholder: PLACEHOLDER)
             Core::Utils.truncate(str, VALUE_MAX_LEN, TOO_LONG_MARK)
           rescue => e
             Datadog.logger.debug("non formattable Redis arg #{str}: #{e}")
@@ -41,8 +42,8 @@ module Datadog
             command_args = resolve_command_args(command_args)
             return 'AUTH ?' if auth_command?(command_args)
 
-            cmd = command_args.map { |x| format_arg(x) }.join(' ')
-            Core::Utils.truncate(cmd, CMD_MAX_LEN, TOO_LONG_MARK)
+            verb, *args = command_args.map { |x| format_arg(x) }
+            Core::Utils.truncate("#{verb.upcase} #{args.join(' ')}", CMD_MAX_LEN, TOO_LONG_MARK)
           end
 
           def get_verb(command_args)
@@ -50,8 +51,7 @@ module Datadog
 
             return get_verb(command_args.first) if command_args.first.is_a?(Array)
 
-            arg = command_args.first
-            verb = arg.is_a?(Symbol) ? arg.to_s.upcase : arg.to_s
+            verb = command_args.first.to_s.upcase
             return verb unless MULTI_VERB_COMMANDS.include?(verb) && command_args[1]
 
             "#{verb} #{command_args[1]}"
@@ -60,7 +60,8 @@ module Datadog
           def auth_command?(command_args)
             return false unless command_args.is_a?(Array) && !command_args.empty?
 
-            command_args.first.to_sym == :auth
+            verb = command_args.first.to_s
+            AUTH_COMMANDS.include?(verb)
           end
 
           # Unwraps command array when Redis is called with the following syntax:

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

@@ -1,9 +1,7 @@
-# typed: true
-
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/redis/ext'
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative '../ext'
 
 module Datadog
   module Tracing
@@ -12,7 +10,7 @@ module Datadog
         # Tags handles generic common tags assignment.
         module Tags
           class << self
-            def set_common_tags(client, span)
+            def set_common_tags(client, span, show_command_args)
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_COMMAND)
 
@@ -20,13 +18,19 @@ module Datadog
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, client.host)
 
+              span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
+
               # Set analytics sample rate
               Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
+              span.set_tag Contrib::Ext::DB::TAG_SYSTEM, Ext::TAG_SYSTEM
+
               span.set_tag Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, client.host
               span.set_tag Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, client.port
+
+              span.set_tag Ext::TAG_DATABASE_INDEX, client.db.to_s
               span.set_tag Ext::TAG_DB, client.db
-              span.set_tag Ext::TAG_RAW_COMMAND, span.resource if show_command_args?
+              span.set_tag Ext::TAG_RAW_COMMAND, span.resource if show_command_args
             end
 
             private
@@ -42,10 +46,6 @@ module Datadog
             def analytics_sample_rate
               datadog_configuration[:analytics_sample_rate]
             end
-
-            def show_command_args?
-              datadog_configuration[:command_args]
-            end
           end
         end
       end

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

@@ -0,0 +1,70 @@
+require_relative '../patcher'
+require_relative 'ext'
+require_relative 'quantize'
+require_relative 'tags'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Redis
+        # Instrumentation for Redis 5+
+        module TraceMiddleware
+          def call(commands, redis_config)
+            Tracing.trace(Contrib::Redis::Ext::SPAN_COMMAND) do |span|
+              datadog_configuration = resolve(redis_config)
+              resource = get_command(commands, datadog_configuration[:command_args])
+
+              span.service = datadog_configuration[:service_name]
+              span.span_type = Contrib::Redis::Ext::TYPE
+              span.resource = resource
+
+              Contrib::Redis::Tags.set_common_tags(redis_config, span, datadog_configuration[:command_args])
+
+              super
+            end
+          end
+
+          def call_pipelined(commands, redis_config)
+            Tracing.trace(Contrib::Redis::Ext::SPAN_COMMAND) do |span|
+              datadog_configuration = resolve(redis_config)
+              pipelined_commands = get_pipeline_commands(commands, datadog_configuration[:command_args])
+
+              span.service = datadog_configuration[:service_name]
+              span.span_type = Contrib::Redis::Ext::TYPE
+              span.resource = pipelined_commands.join("\n")
+              span.set_metric Contrib::Redis::Ext::METRIC_PIPELINE_LEN, pipelined_commands.length
+
+              Contrib::Redis::Tags.set_common_tags(redis_config, span, datadog_configuration[:command_args])
+
+              super
+            end
+          end
+
+          private
+
+          def get_command(commands, boolean)
+            if boolean
+              Contrib::Redis::Quantize.format_command_args(commands)
+            else
+              Contrib::Redis::Quantize.get_verb(commands)
+            end
+          end
+
+          def get_pipeline_commands(commands, boolean)
+            if boolean
+              commands.map { |c| Contrib::Redis::Quantize.format_command_args(c) }
+            else
+              commands.map { |c| Contrib::Redis::Quantize.get_verb(c) }
+            end
+          end
+
+          def resolve(redis_config)
+            custom = redis_config.custom[:datadog] || {}
+
+            Datadog.configuration.tracing[:redis, redis_config.server_url].to_h.merge(custom)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require 'uri'
 
 # NOTE: This code is copied directly from Redis.

data/lib/datadog/tracing/contrib/registerable.rb

@@ -1,5 +1,3 @@
-# typed: false
-
 module Datadog
   module Tracing
     module Contrib

data/lib/datadog/tracing/contrib/registry.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Tracing
     module Contrib

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

@@ -1,8 +1,6 @@
-# typed: false
-
-require 'datadog/tracing/span_operation'
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/resque/ext'
+require_relative '../../../span_operation'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing

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

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Tracing
     module Contrib

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

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

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

@@ -1,8 +1,5 @@
-# typed: false
-
-require 'datadog/tracing/contrib/patcher'
-require 'datadog/tracing/contrib/resque/integration'
-require 'datadog/tracing/contrib/sidekiq/ext'
+require_relative '../patcher'
+require_relative '../sidekiq/ext'
 
 module Datadog
   module Tracing