ddtrace 0.41.0 → 0.52.0

data/lib/ddtrace/contrib/rails/framework.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/pin'
 require 'ddtrace/ext/app_types'
 
@@ -7,6 +8,8 @@ require 'ddtrace/contrib/action_cable/integration'
 require 'ddtrace/contrib/action_pack/integration'
 require 'ddtrace/contrib/action_view/integration'
 require 'ddtrace/contrib/grape/endpoint'
+require 'ddtrace/contrib/lograge/integration'
+require 'ddtrace/contrib/semantic_logger/integration'
 
 require 'ddtrace/contrib/rails/ext'
 require 'ddtrace/contrib/rails/utils'
@@ -46,6 +49,8 @@ module Datadog
             activate_action_pack!(datadog_config, rails_config)
             activate_action_view!(datadog_config, rails_config)
             activate_active_record!(datadog_config, rails_config)
+            activate_lograge!(datadog_config, rails_config)
+            activate_semantic_logger!(datadog_config, rails_config)
           end
         end
 
@@ -53,7 +58,7 @@ module Datadog
           # We set defaults here instead of in the patcher because we need to wait
           # for the Rails application to be fully initialized.
           datadog_config[:rails].tap do |config|
-            config[:service_name] ||= (Datadog.configuration.service || Utils.app_name)
+            config[:service_name] ||= (Datadog.configure.service_without_fallback || Utils.app_name)
             config[:database_service] ||= "#{config[:service_name]}-#{Contrib::ActiveRecord::Utils.adapter_name}"
             config[:controller_service] ||= config[:service_name]
             config[:cache_service] ||= "#{config[:service_name]}-cache"
@@ -118,6 +123,26 @@ module Datadog
             service_name: rails_config[:database_service]
           )
         end
+
+        def self.activate_lograge!(datadog_config, rails_config)
+          return unless defined?(::Lograge)
+
+          if rails_config[:log_injection]
+            datadog_config.use(
+              :lograge
+            )
+          end
+        end
+
+        def self.activate_semantic_logger!(datadog_config, rails_config)
+          return unless defined?(::SemanticLogger)
+
+          if rails_config[:log_injection]
+            datadog_config.use(
+              :semantic_logger
+            )
+          end
+        end
       end
     end
   end

data/lib/ddtrace/contrib/rails/integration.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 
 require 'ddtrace/contrib/rails/ext'

data/lib/ddtrace/contrib/rails/log_injection.rb

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Contrib
     # Instrument Rails.
@@ -6,46 +7,6 @@ module Datadog
       module LogInjection
         module_function
 
-        def add_lograge_logger(app)
-          # custom_options defaults to nil and can be either a hash or a lambda which returns a hash
-          # https://github.com/roidrage/lograge/blob/1729eab7956bb95c5992e4adab251e4f93ff9280/lib/lograge.rb#L28
-          if (custom_options = app.config.lograge.custom_options).nil?
-            # if it's not set, we set to a lambda that returns DD tracing context
-            app.config.lograge.custom_options = lambda do |_event|
-              # Retrieves trace information for current thread
-              correlation = Datadog.tracer.active_correlation
-
-              datadog_trace_log_hash(correlation)
-            end
-          # check if lambda, if so then define a new lambda which invokes the original lambda and
-          # merges the returned hash with the the DD tracing context hash.
-          elsif custom_options.respond_to?(:call)
-            app.config.lograge.custom_options = lambda do |event|
-              # invoke original lambda
-              result = custom_options.call(event)
-              # Retrieves trace information for current thread
-              correlation = Datadog.tracer.active_correlation
-              # merge original lambda with datadog context
-              result.merge(datadog_trace_log_hash(correlation))
-            end
-          # otherwise if it's just a static hash, we have to wrap that hash in a lambda to retrieve
-          # the DD tracing context, then merge the tracing context with the original static hash.
-          # don't modify if custom_options is not an accepted format.
-          elsif custom_options.is_a?(Hash)
-            app.config.lograge.custom_options = lambda do |_event|
-              # Retrieves trace information for current thread
-              correlation = Datadog.tracer.active_correlation
-
-              # merge original lambda with datadog context
-              custom_options.merge(datadog_trace_log_hash(correlation))
-            end
-          end
-        rescue StandardError => e
-          # TODO: can we use Datadog.logger at this point?
-          Datadog.logger.warn("Unable to add Datadog Trace context to Lograge: #{e.message}")
-          false
-        end
-
         def add_as_tagged_logging_logger(app)
           # we want to check if the current logger is a tagger logger instance
           # log_tags defaults to nil so we have to set as an array if nothing exists yet

data/lib/ddtrace/contrib/rails/middlewares.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/http'
 require 'ddtrace/contrib/action_pack/utils'
 

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

@@ -1,8 +1,11 @@
+# typed: false
 require 'ddtrace/contrib/rails/utils'
 require 'ddtrace/contrib/rails/framework'
 require 'ddtrace/contrib/rails/middlewares'
 require 'ddtrace/contrib/rails/log_injection'
 require 'ddtrace/contrib/rack/middlewares'
+require 'ddtrace/contrib/semantic_logger/patcher'
+require 'ddtrace/utils/only_once'
 
 module Datadog
   module Contrib
@@ -11,6 +14,9 @@ module Datadog
       module Patcher
         include Contrib::Patcher
 
+        BEFORE_INITIALIZE_ONLY_ONCE_PER_APP = Hash.new { |h, key| h[key] = Datadog::Utils::OnlyOnce.new }
+        AFTER_INITIALIZE_ONLY_ONCE_PER_APP = Hash.new { |h, key| h[key] = Datadog::Utils::OnlyOnce.new }
+
         module_function
 
         def target_version
@@ -29,7 +35,7 @@ module Datadog
         end
 
         def before_intialize(app)
-          do_once(:rails_before_initialize, for: app) do
+          BEFORE_INITIALIZE_ONLY_ONCE_PER_APP[app].run do
             # Middleware must be added before the application is initialized.
             # Otherwise the middleware stack will be frozen.
             # Sometimes we don't want to activate middleware e.g. OpenTracing, etc.
@@ -53,16 +59,31 @@ module Datadog
         end
 
         def add_logger(app)
+          should_warn = true
           # check if lograge key exists
-          if app.config.respond_to?(:lograge) && app.config.lograge.enabled
-            Datadog::Contrib::Rails::LogInjection.add_lograge_logger(app)
-          # if lograge isn't set, check if tagged logged is enabed.
+          # Note: Rails executes initializers sequentially based on alphabetical order,
+          # and lograge config could occur after datadog config.
+          # So checking for `app.config.lograge.enabled` may yield a false negative,
+          # and adding custom options naively if `config.lograge` exists from the lograge Railtie,
+          # is inconsistent since a lograge initializer would override it.
+          # Instead, we patch Lograge `custom_options` internals directly
+          # as part of Rails framework patching
+          # and just flag off the warning log here.
+          # SemanticLogger we similarly patch in the after_initiaize block, and should flag
+          # off the warning log here if we know we'll patch this gem later.
+          should_warn = false if app.config.respond_to?(:lograge) || defined?(::SemanticLogger)
+
+          # if lograge isn't set, check if tagged logged is enabled.
           # if so, add proc that injects trace identifiers for tagged logging.
-          elsif (logger = app.config.logger) && logger.is_a?(::ActiveSupport::TaggedLogging)
+          if (logger = app.config.logger) &&
+             defined?(::ActiveSupport::TaggedLogging) &&
+             logger.is_a?(::ActiveSupport::TaggedLogging)
+
             Datadog::Contrib::Rails::LogInjection.add_as_tagged_logging_logger(app)
-          else
-            Datadog.logger.warn("Unabe to enable Datadog Trace context, Logger #{logger} is not supported")
+            should_warn = false
           end
+
+          Datadog.logger.warn("Unable to enable Datadog Trace context, Logger #{logger} is not supported") if should_warn
         end
 
         def patch_after_intialize
@@ -72,7 +93,7 @@ module Datadog
         end
 
         def after_intialize(app)
-          do_once(:rails_after_initialize, for: app) do
+          AFTER_INITIALIZE_ONLY_ONCE_PER_APP[app].run do
             # Finish configuring the tracer after the application is initialized.
             # We need to wait for some things, like application name, middleware stack, etc.
             setup_tracer

data/lib/ddtrace/contrib/rails/railtie.rb

@@ -1,3 +1,4 @@
+# typed: ignore
 require 'ddtrace/contrib/rails/framework'
 require 'ddtrace/contrib/rails/middlewares'
 require 'ddtrace/contrib/rack/middlewares'

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/analytics'
 
 module Datadog
@@ -14,6 +15,10 @@ module Datadog
             ::Rails.application.class.to_s.underscore
           end
         end
+
+        def self.railtie_supported?
+          !(defined?(::Rails::VERSION::MAJOR) && ::Rails::VERSION::MAJOR >= 3 && defined?(::Rails::Railtie)).nil?
+        end
       end
     end
   end

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/rake/ext'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Rake

data/lib/ddtrace/contrib/rake/instrumentation.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/rake/ext'
 
@@ -7,7 +8,7 @@ module Datadog
       # Instrumentation for Rake tasks
       module Instrumentation
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # Instance methods for Rake instrumentation
@@ -16,7 +17,8 @@ module Datadog
             return super unless enabled?
 
             tracer.trace(Ext::SPAN_INVOKE, span_options) do |span|
-              super.tap { annotate_invoke!(span, args) }
+              annotate_invoke!(span, args)
+              super
             end
           ensure
             shutdown_tracer!
@@ -26,7 +28,8 @@ module Datadog
             return super unless enabled?
 
             tracer.trace(Ext::SPAN_EXECUTE, span_options) do |span|
-              super.tap { annotate_execute!(span, args) }
+              annotate_execute!(span, args)
+              super
             end
           ensure
             shutdown_tracer!

data/lib/ddtrace/contrib/rake/integration.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/rake/configuration/settings'
 require 'ddtrace/contrib/rake/patcher'
@@ -18,7 +19,7 @@ module Datadog
         end
 
         def self.loaded?
-          !defined?(::Rake).nil?
+          !defined?(::Rake::Task).nil?
         end
 
         def self.compatible?

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/rake/ext'
@@ -18,7 +19,7 @@ module Datadog
 
         def patch
           # Add instrumentation patch to Rake task
-          ::Rake::Task.send(:include, Instrumentation)
+          ::Rake::Task.include(Instrumentation)
         end
 
         def get_option(option)

data/lib/ddtrace/contrib/redis/configuration/resolver.rb

@@ -1,19 +1,29 @@
+# typed: true
 require 'ddtrace/contrib/redis/vendor/resolver'
 
 module Datadog
   module Contrib
     module Redis
       module Configuration
-        # Converts Symbols, Strings, and Hashes to a normalized connection settings Hash.
+        UNIX_SCHEME = 'unix'.freeze
+
+        # Converts String URLs and Hashes to a normalized connection settings Hash.
         class Resolver < Contrib::Configuration::Resolver
-          def resolve(key_or_hash)
-            return :default if key_or_hash == :default
+          # @param [Hash,String] Redis connection information
+          def resolve(hash)
+            super(parse_matcher(hash))
+          end
+
+          protected
+
+          def parse_matcher(matcher)
+            matcher = { url: matcher } if matcher.is_a?(String)
 
-            normalize(connection_resolver.resolve(key_or_hash))
+            normalize(connection_resolver.resolve(matcher))
           end
 
           def normalize(hash)
-            return { url: hash[:url] } if hash[:scheme] == 'unix'
+            return { url: hash[:url] } if hash[:scheme] == UNIX_SCHEME
 
             # Connexion strings are always converted to host, port, db and scheme
             # but the host, port, db and scheme will generate the :url only after

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/redis/ext'
 
@@ -22,6 +23,11 @@ module Datadog
             o.lazy
           end
 
+          option :command_args do |o|
+            o.default { env_to_bool(Ext::ENV_COMMAND_ARGS, true) }
+            o.lazy
+          end
+
           option :service_name, default: Ext::SERVICE_NAME
         end
       end

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Redis
@@ -9,6 +10,7 @@ module Datadog
         ENV_ANALYTICS_ENABLED_OLD = 'DD_REDIS_ANALYTICS_ENABLED'.freeze
         ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_REDIS_ANALYTICS_SAMPLE_RATE'.freeze
         ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_REDIS_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_COMMAND_ARGS = 'DD_REDIS_COMMAND_ARGS'.freeze
         METRIC_PIPELINE_LEN = 'redis.pipeline_length'.freeze
         SERVICE_NAME = 'redis'.freeze
         SPAN_COMMAND = 'redis.command'.freeze

data/lib/ddtrace/contrib/redis/integration.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/redis/configuration/settings'
 require 'ddtrace/contrib/redis/patcher'

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/redis/ext'
 require 'ddtrace/contrib/redis/configuration/resolver'
@@ -28,6 +29,7 @@ module Datadog
 
         # rubocop:disable Metrics/MethodLength
         # rubocop:disable Metrics/BlockLength
+        # rubocop:disable Metrics/AbcSize
         def patch_redis_client
           ::Redis::Client.class_eval do
             alias_method :call_without_datadog, :call
@@ -40,7 +42,7 @@ module Datadog
               pin.tracer.trace(Datadog::Contrib::Redis::Ext::SPAN_COMMAND) do |span|
                 span.service = pin.service
                 span.span_type = Datadog::Contrib::Redis::Ext::TYPE
-                span.resource = Datadog::Contrib::Redis::Quantize.format_command_args(*args)
+                span.resource = get_command(args)
                 Datadog::Contrib::Redis::Tags.set_common_tags(self, span)
 
                 response = call_without_datadog(*args, &block)
@@ -59,10 +61,10 @@ module Datadog
               pin.tracer.trace(Datadog::Contrib::Redis::Ext::SPAN_COMMAND) do |span|
                 span.service = pin.service
                 span.span_type = Datadog::Contrib::Redis::Ext::TYPE
-                commands = args[0].commands.map { |c| Datadog::Contrib::Redis::Quantize.format_command_args(c) }
+                commands = get_pipeline_commands(args)
                 span.resource = commands.join("\n")
-                Datadog::Contrib::Redis::Tags.set_common_tags(self, span)
                 span.set_metric Datadog::Contrib::Redis::Ext::METRIC_PIPELINE_LEN, commands.length
+                Datadog::Contrib::Redis::Tags.set_common_tags(self, span)
 
                 response = call_pipeline_without_datadog(*args, &block)
               end
@@ -84,6 +86,22 @@ module Datadog
 
             private
 
+            def get_command(args)
+              if datadog_configuration[:command_args]
+                Datadog::Contrib::Redis::Quantize.format_command_args(*args)
+              else
+                Datadog::Contrib::Redis::Quantize.get_verb(*args)
+              end
+            end
+
+            def get_pipeline_commands(args)
+              if datadog_configuration[:command_args]
+                args[0].commands.map { |c| Datadog::Contrib::Redis::Quantize.format_command_args(c) }
+              else
+                args[0].commands.map { |c| Datadog::Contrib::Redis::Quantize.get_verb(c) }
+              end
+            end
+
             def datadog_configuration
               Datadog.configuration[:redis, options]
             end

data/lib/ddtrace/contrib/redis/quantize.rb

@@ -1,3 +1,6 @@
+# typed: true
+require 'set'
+
 module Datadog
   module Contrib
     module Redis
@@ -8,6 +11,19 @@ module Datadog
         VALUE_MAX_LEN = 50
         CMD_MAX_LEN = 500
 
+        MULTI_VERB_COMMANDS = Set.new(
+          %w[
+            ACL
+            CLIENT
+            CLUSTER
+            COMMAND
+            CONFIG
+            DEBUG
+            LATENCY
+            MEMORY
+          ]
+        ).freeze
+
         module_function
 
         def format_arg(arg)
@@ -27,8 +43,21 @@ module Datadog
           Utils.truncate(cmd, CMD_MAX_LEN, TOO_LONG_MARK)
         end
 
+        def get_verb(command_args)
+          return unless command_args.is_a?(Array)
+
+          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
+          return verb unless MULTI_VERB_COMMANDS.include?(verb) && command_args[1]
+
+          "#{verb} #{command_args[1]}"
+        end
+
         def auth_command?(command_args)
           return false unless command_args.is_a?(Array) && !command_args.empty?
+
           command_args.first.to_sym == :auth
         end