ddtrace 0.36.0 → 0.41.0

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

@@ -0,0 +1,81 @@
+module Datadog
+  module Contrib
+    # Instrument Rails.
+    module Rails
+      # Rails log injection helper methods
+      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
+          if (log_tags = app.config.log_tags).nil?
+            app.config.log_tags = [proc { Datadog.tracer.active_correlation.to_s }]
+          # if existing log_tags configuration exists, append to the end of the array
+          elsif log_tags.is_a?(Array)
+            app.config.log_tags << proc { Datadog.tracer.active_correlation.to_s }
+          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}")
+          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
+end

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

@@ -24,11 +24,16 @@ module Datadog
         rescue Exception => e
           tracer = Datadog.configuration[:rails][:tracer]
           span = tracer.active_span
-          unless span.nil?
+          if !span.nil? && ActionPack::Utils.exception_is_error?(e)
             # Only set error if it's supposed to be flagged as such
             # e.g. we don't want to flag 404s.
             # You can add custom errors via `config.action_dispatch.rescue_responses`
-            span.set_error(e) if ActionPack::Utils.exception_is_error?(e)
+            span.set_error(e)
+
+            # Some exception gets handled by Rails middleware before it can be set on Rack middleware
+            # The rack span is the root span of the request and should make sure it has the full exception
+            # set on it.
+            env[:datadog_rack_request_span].set_error(e) if env[:datadog_rack_request_span]
           end
           raise e
         end

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

@@ -1,6 +1,7 @@
 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'
 
 module Datadog
@@ -33,6 +34,7 @@ module Datadog
             # Otherwise the middleware stack will be frozen.
             # Sometimes we don't want to activate middleware e.g. OpenTracing, etc.
             add_middleware(app) if Datadog.configuration[:rails][:middleware]
+            add_logger(app) if Datadog.configuration[:rails][:log_injection]
           end
         end
 
@@ -50,6 +52,19 @@ module Datadog
           )
         end
 
+        def add_logger(app)
+          # 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.
+          # if so, add proc that injects trace identifiers for tagged logging.
+          elsif (logger = app.config.logger) && 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")
+          end
+        end
+
         def patch_after_intialize
           ::ActiveSupport.on_load(:after_initialize) do
             Datadog::Contrib::Rails::Patcher.after_intialize(self)

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

@@ -7,17 +7,21 @@ module Datadog
       module Configuration
         # Custom settings for the Rake 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
 
-          option :enabled, default: true
           option :quantize, default: {}
           option :service_name, default: Ext::SERVICE_NAME
         end

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

@@ -4,8 +4,11 @@ module Datadog
       # Rake integration constants
       module Ext
         APP = 'rake'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_RAKE_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_RAKE_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_RAKE_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_RAKE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_RAKE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RAKE_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_RAKE_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'rake'.freeze
         SPAN_INVOKE = 'rake.invoke'.freeze
         SPAN_EXECUTE = 'rake.execute'.freeze

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

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the Redis 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/redis/ext.rb

@@ -4,8 +4,11 @@ module Datadog
       # Redis integration constants
       module Ext
         APP = 'redis'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_REDIS_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_REDIS_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_REDIS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_REDIS_ANALYTICS_ENABLED'.freeze
+        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
         METRIC_PIPELINE_LEN = 'redis.pipeline_length'.freeze
         SERVICE_NAME = 'redis'.freeze
         SPAN_COMMAND = 'redis.command'.freeze

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

@@ -76,7 +76,7 @@ module Datadog
                   datadog_configuration[:service_name],
                   app: Ext::APP,
                   app_type: Datadog::Ext::AppTypes::DB,
-                  tracer: datadog_configuration[:tracer]
+                  tracer: -> { datadog_configuration[:tracer] }
                 )
                 pin.onto(self)
               end

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

@@ -1,3 +1,4 @@
+require 'ddtrace/ext/integration'
 require 'ddtrace/ext/net'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/redis/ext'
@@ -9,6 +10,9 @@ module Datadog
       module Tags
         class << self
           def set_common_tags(client, span)
+            # Tag as an external peer service
+            span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
             # Set analytics sample rate
             Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 

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

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the Resque 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/resque/ext.rb

@@ -4,8 +4,11 @@ module Datadog
       # Resque integration constants
       module Ext
         APP = 'resque'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_RESQUE_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_RESQUE_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_RESQUE_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_RESQUE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_RESQUE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RESQUE_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_RESQUE_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'resque'.freeze
         SPAN_JOB = 'resque.job'.freeze
       end

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

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the RestClient 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/rest_client/ext.rb

@@ -4,8 +4,11 @@ module Datadog
       # RestClient integration constants
       module Ext
         APP = 'rest_client'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_REST_CLIENT_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_REST_CLIENT_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_REST_CLIENT_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_REST_CLIENT_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_REST_CLIENT_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_REST_CLIENT_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_REST_CLIENT_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'rest_client'.freeze
         SPAN_REQUEST = 'rest_client.request'.freeze
       end

data/lib/ddtrace/contrib/rest_client/request_patch.rb

@@ -1,5 +1,6 @@
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/distributed'
+require 'ddtrace/ext/integration'
 require 'ddtrace/propagation/http_propagator'
 require 'ddtrace/contrib/rest_client/ext'
 
@@ -31,6 +32,9 @@ module Datadog
           def datadog_tag_request(uri, span)
             span.resource = method.to_s.upcase
 
+            # Tag as an external peer service
+            span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
             # Set analytics sample rate
             Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
@@ -62,11 +66,11 @@ module Datadog
             # rubocop:disable Lint/RescueException
           rescue Exception => e
             # rubocop:enable Lint/RescueException
-            span.set_error(e)
+            span.set_error(e) if span
 
             raise e
           ensure
-            span.finish
+            span.finish if span
           end
 
           private

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

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the Sequel 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
         end

data/lib/ddtrace/contrib/sequel/database.rb

@@ -24,7 +24,7 @@ module Datadog
               span.service = datadog_pin.service
               span.resource = opts[:query]
               span.span_type = Datadog::Ext::SQL::TYPE
-              Utils.set_analytics_sample_rate(span)
+              Utils.set_common_tags(span)
               span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
               response = super(sql, options)
             end
@@ -36,7 +36,7 @@ module Datadog
               Datadog.configuration[:sequel][:service_name] || adapter_name,
               app: Ext::APP,
               app_type: Datadog::Ext::AppTypes::DB,
-              tracer: Datadog.configuration[:sequel][:tracer] || Datadog.tracer
+              tracer: -> { Datadog.configuration[:sequel][:tracer] }
             )
           end
 
@@ -52,6 +52,8 @@ module Datadog
                       elsif instance_variable_defined?(:@pool) && @pool
                         @pool.db.opts
                       end
+            sql = sql.is_a?(::Sequel::SQL::Expression) ? literal(sql) : sql.to_s
+
             Utils.parse_opts(sql, opts, db_opts)
           end
         end

data/lib/ddtrace/contrib/sequel/dataset.rb

@@ -38,15 +38,16 @@ module Datadog
           private
 
           def trace_execute(super_method, sql, options, &block)
-            opts = Utils.parse_opts(sql, options, db.opts)
+            opts = Utils.parse_opts(sql, options, db.opts, self)
             response = nil
 
             datadog_pin.tracer.trace(Ext::SPAN_QUERY) do |span|
               span.service = datadog_pin.service
               span.resource = opts[:query]
               span.span_type = Datadog::Ext::SQL::TYPE
-              Utils.set_analytics_sample_rate(span)
+              Utils.set_common_tags(span)
               span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
+              span.set_tag(Ext::TAG_PREPARED_NAME, opts[:prepared_name]) if opts[:prepared_name]
               response = super_method.call(sql, options, &block)
             end
             response

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

@@ -4,11 +4,15 @@ module Datadog
       # Sequel integration constants
       module Ext
         APP = 'sequel'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_SEQUEL_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_SEQUEL_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_SEQUEL_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_SEQUEL_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_SEQUEL_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SEQUEL_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_SEQUEL_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'sequel'.freeze
         SPAN_QUERY = 'sequel.query'.freeze
         TAG_DB_VENDOR = 'sequel.db.vendor'.freeze
+        TAG_PREPARED_NAME = 'sequel.prepared.name'.freeze
       end
     end
   end

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

@@ -1,28 +1,57 @@
+require 'ddtrace/ext/integration'
+
 module Datadog
   module Contrib
     module Sequel
       # General purpose functions for Sequel
       module Utils
         class << self
+          # Ruby database connector library
+          #
+          # e.g. adapter:mysql2 (database:mysql), adapter:jdbc (database:postgres)
           def adapter_name(database)
-            Datadog::Utils::Database.normalize_vendor(database.adapter_scheme.to_s)
+            scheme = database.adapter_scheme.to_s
+
+            if scheme == 'jdbc'.freeze
+              # The subtype is more important in this case,
+              # otherwise all database adapters will be 'jdbc'.
+              database_type(database)
+            else
+              Datadog::Utils::Database.normalize_vendor(scheme)
+            end
           end
 
-          def parse_opts(sql, opts, db_opts)
-            if ::Sequel::VERSION >= '4.37.0' && !sql.is_a?(String)
-              # In 4.37.0, sql was converted to a prepared statement object
-              sql = sql.prepared_sql unless sql.is_a?(Symbol)
+          # Database engine
+          #
+          # e.g. database:mysql (adapter:mysql2), database:postgres (adapter:jdbc)
+          def database_type(database)
+            Datadog::Utils::Database.normalize_vendor(database.database_type.to_s)
+          end
+
+          def parse_opts(sql, opts, db_opts, dataset = nil)
+            # Prepared statements don't provide their sql query in the +sql+ parameter.
+            unless sql.is_a?(String)
+              if dataset && dataset.respond_to?(:prepared_sql) && (resolved_sql = dataset.prepared_sql)
+                # The dataset contains the resolved SQL query and prepared statement name.
+                prepared_name = dataset.prepared_statement_name
+                sql = resolved_sql
+              end
             end
 
             {
               name: opts[:type],
               query: sql,
+              prepared_name: prepared_name,
               database: db_opts[:database],
               host: db_opts[:host]
             }
           end
 
-          def set_analytics_sample_rate(span)
+          def set_common_tags(span)
+            # Tag as an external peer service
+            span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
+            # Set analytics sample rate
             Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
           end