ddtrace 1.18.0 → 1.20.0

data/lib/datadog/tracing/contrib/faraday/middleware.rb

@@ -24,7 +24,7 @@ module Datadog
             # Do this once to reduce expensive regex calls.
             request_options = build_request_options!(env)
 
-            Tracing.trace(Ext::SPAN_REQUEST) do |span, trace|
+            Tracing.trace(Ext::SPAN_REQUEST, on_error: request_options[:on_error]) do |span, trace|
               annotate!(span, env, request_options)
               propagate!(trace, span, env) if request_options[:distributed_tracing] && Tracing.enabled?
               app.call(env).on_complete { |resp| handle_response(span, resp, request_options) }

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

@@ -18,6 +18,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool, nilable: true
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/grape/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_GRAPE_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPE_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPE_ANALYTICS_SAMPLE_RATE'
           SPAN_ENDPOINT_RENDER = 'grape.endpoint_render'

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

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool, nilable: true
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/graphql/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_GRAPHQL_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPHQL_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPHQL_ANALYTICS_SAMPLE_RATE'
           SERVICE_NAME = 'graphql'

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

@@ -18,6 +18,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -10,6 +10,7 @@ module Datadog
           ENV_ENABLED = 'DD_TRACE_GRPC_ENABLED'
           ENV_SERVICE_NAME = 'DD_TRACE_GRPC_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_GRPC_PEER_SERVICE'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRPC_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRPC_ANALYTICS_SAMPLE_RATE'
           DEFAULT_PEER_SERVICE_NAME = 'grpc'

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

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/http/distributed/fetcher.rb

@@ -13,8 +13,8 @@ module Datadog
           #
           # In case both variants are present, the verbatim match will be used.
           class Fetcher < Tracing::Distributed::Fetcher
-            # DEV: Should we try to parse both verbatim an Rack-formatted headers,
-            # DEV: given Rack-formatted is the most common format in Ruby?
+            # @param [String] name the header name
+            # @return [String, nil] the header value or nil if not found
             def [](name)
               # Try to fetch with the plain key
               value = super(name)

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

@@ -10,6 +10,7 @@ module Datadog
           ENV_ENABLED = 'DD_TRACE_HTTP_ENABLED'
           ENV_SERVICE_NAME = 'DD_TRACE_NET_HTTP_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_NET_HTTP_PEER_SERVICE'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTP_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_HTTP_ANALYTICS_SAMPLE_RATE'
           ENV_ERROR_STATUS_CODES = 'DD_TRACE_HTTP_ERROR_STATUS_CODES'

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

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -11,6 +11,7 @@ module Datadog
           ENV_SERVICE_NAME = 'DD_TRACE_HTTPCLIENT_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_HTTPCLIENT_PEER_SERVICE'
 
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTPCLIENT_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_HTTPCLIENT_ANALYTICS_SAMPLE_RATE'
           ENV_ERROR_STATUS_CODES = 'DD_TRACE_HTTPCLIENT_ERROR_STATUS_CODES'

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

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -10,6 +10,7 @@ module Datadog
           ENV_ENABLED = 'DD_TRACE_HTTPRB_ENABLED'
           ENV_SERVICE_NAME = 'DD_TRACE_HTTPRB_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_HTTPRB_PEER_SERVICE'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTPRB_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_EHTTPRB_ANALYTICS_SAMPLE_RATE'
           ENV_ERROR_STATUS_CODES = 'DD_TRACE_HTTPCLIENT_ERROR_STATUS_CODES'

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

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/kafka/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_KAFKA_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_KAFKA_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_KAFKA_ANALYTICS_SAMPLE_RATE'
           SPAN_CONNECTION_REQUEST = 'kafka.connection.request'

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

@@ -19,6 +19,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -10,6 +10,7 @@ module Datadog
           ENV_ENABLED = 'DD_TRACE_MONGO_ENABLED'
           ENV_SERVICE_NAME = 'DD_TRACE_MONGO_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_MONGO_PEER_SERVICE'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_MONGO_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_MONGO_ANALYTICS_SAMPLE_RATE'
           DEFAULT_PEER_SERVICE_NAME = 'mongodb'

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

@@ -19,6 +19,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED
@@ -50,6 +51,10 @@ module Datadog
               o.type :string, nilable: true
               o.env Ext::ENV_PEER_SERVICE
             end
+
+            option :on_error do |o|
+              o.type :proc, nilable: true
+            end
           end
         end
       end

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

@@ -11,6 +11,7 @@ module Datadog
           ENV_SERVICE_NAME = 'DD_TRACE_MYSQL2_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_MYSQL2_PEER_SERVICE'
 
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_MYSQL2_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_MYSQL2_ANALYTICS_SAMPLE_RATE'
           DEFAULT_PEER_SERVICE_NAME = 'mysql2'

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

@@ -21,8 +21,9 @@ module Datadog
           module InstanceMethods
             def query(sql, options = {})
               service = Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
+              on_error = Datadog.configuration_for(self, :on_error) || datadog_configuration[:on_error]
 
-              Tracing.trace(Ext::SPAN_QUERY, service: service) do |span, trace_op|
+              Tracing.trace(Ext::SPAN_QUERY, service: service, on_error: on_error) do |span, trace_op|
                 span.resource = sql
                 span.span_type = Tracing::Metadata::Ext::SQL::TYPE
 

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

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -10,6 +10,7 @@ module Datadog
           ENV_ENABLED = 'DD_TRACE_OPENSEARCH_ENABLED'
           ENV_SERVICE_NAME = 'DD_TRACE_OPENSEARCH_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_OPENSEARCH_PEER_SERVICE'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_OPENSEARCH_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_OPENSEARCH_ANALYTICS_SAMPLE_RATE'
           DEFAULT_PEER_SERVICE_NAME = 'opensearch'

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

@@ -19,6 +19,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -10,6 +10,7 @@ module Datadog
           ENV_ENABLED = 'DD_TRACE_PG_ENABLED'
           ENV_SERVICE_NAME = 'DD_TRACE_PG_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_PG_PEER_SERVICE'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_PG_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_PG_ANALYTICS_SAMPLE_RATE'
           DEFAULT_PEER_SERVICE_NAME = 'pg'

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

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -10,6 +10,7 @@ module Datadog
           ENV_ENABLED = 'DD_TRACE_PRESTO_ENABLED'
           ENV_SERVICE_NAME = 'DD_TRACE_PRESTO_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_PRESTO_PEER_SERVICE'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_PRESTO_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_PRESTO_ANALYTICS_SAMPLE_RATE'
           DEFAULT_PEER_SERVICE_NAME = 'presto'

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

@@ -11,6 +11,7 @@ module Datadog
           # Custom settings for the Qless integration
           # @public_api
           class Settings < Contrib::Configuration::Settings
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -7,6 +7,7 @@ module Datadog
         # Qless integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_QLESS_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_QLESS_ANALYTICS_SAMPLE_RATE'
           ENV_TAG_JOB_DATA = 'DD_QLESS_TAG_JOB_DATA'

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

@@ -20,6 +20,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -7,6 +7,7 @@ module Datadog
         # Que integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_QUE_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_QUE_ANALYTICS_SAMPLE_RATE'
           ENV_ENABLED = 'DD_TRACE_QUE_ENABLED'

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

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/racecar/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_RACECAR_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_RACECAR_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RACECAR_ANALYTICS_SAMPLE_RATE'
           DEFAULT_PEER_SERVICE_NAME = 'racecar'

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

@@ -22,6 +22,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool, nilable: true
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/rack/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_RACK_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_RACK_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RACK_ANALYTICS_SAMPLE_RATE'
           RACK_ENV_REQUEST_SPAN = 'datadog.rack_request_span'

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

@@ -2,6 +2,7 @@ require 'date'
 
 require_relative '../../../core/environment/variable_helpers'
 require_relative '../../../core/backport'
+require_relative '../../../core/remote/tie/tracing'
 require_relative '../../client_ip'
 require_relative '../../metadata/ext'
 require_relative '../../propagation/http'
@@ -71,7 +72,7 @@ module Datadog
 
             return @app.call(env) if previous_request_span
 
-            Datadog::Core::Remote.active_remote.barrier(:once) unless Datadog::Core::Remote.active_remote.nil?
+            boot = Datadog::Core::Remote::Tie.boot
 
             # Extract distributed tracing context before creating any spans,
             # so that all spans will be added to the distributed trace.
@@ -91,9 +92,15 @@ module Datadog
             # we must ensure that the span `resource` is set later
             request_span = Tracing.trace(Ext::SPAN_REQUEST, **trace_options)
             request_span.resource = nil
-            request_trace = Tracing.active_trace
+
+            # When tracing and distributed tracing are both disabled, `.active_trace` will be `nil`,
+            # Return a null object to continue operation
+            request_trace = Tracing.active_trace || TraceOperation.new
+
             env[Ext::RACK_ENV_REQUEST_SPAN] = request_span
 
+            Datadog::Core::Remote::Tie::Tracing.tag(boot, request_span)
+
             # Copy the original env, before the rest of the stack executes.
             # Values may change; we want values before that happens.
             original_env = env.dup

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

@@ -1,5 +1,3 @@
-require_relative '../auto_instrument'
-
 # Railtie to include AutoInstrumentation in rails loading
 class DatadogAutoInstrumentRailtie < Rails::Railtie
   # we want to load before config initializers so that any user supplied config

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

@@ -29,6 +29,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool, nilable: true
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -9,6 +9,7 @@ module Datadog
         module Ext
           APP = 'rails'
           ENV_ENABLED = 'DD_TRACE_RAILS_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_RAILS_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RAILS_ANALYTICS_SAMPLE_RATE'
           ENV_DISABLE = 'DISABLE_DATADOG_RAILS'

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

@@ -19,6 +19,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/rake/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_RAKE_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_RAKE_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RAKE_ANALYTICS_SAMPLE_RATE'
           SERVICE_NAME = 'rake'

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

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -10,6 +10,7 @@ module Datadog
           ENV_ENABLED = 'DD_TRACE_REDIS_ENABLED'
           ENV_SERVICE_NAME = 'DD_TRACE_REDIS_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_REDIS_PEER_SERVICE'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_REDIS_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_REDIS_ANALYTICS_SAMPLE_RATE'
           ENV_COMMAND_ARGS = 'DD_REDIS_COMMAND_ARGS'

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

@@ -28,7 +28,7 @@ module Datadog
             private
 
             def command_args?
-              pinned = Datadog.configuration_for(redis_instance, :command_args)
+              pinned = Datadog.configuration_for(self, :command_args)
 
               return pinned unless pinned.nil?
 
@@ -36,7 +36,7 @@ module Datadog
             end
 
             def service_name
-              Datadog.configuration_for(redis_instance, :service_name) ||
+              Datadog.configuration_for(self, :service_name) ||
                 datadog_configuration[:service_name]
             end
 

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

@@ -10,38 +10,48 @@ module Datadog
         module Patcher
           include Contrib::Patcher
 
-          # Patch for redis instance
-          module InstancePatch
+          # Patch for redis instance (with redis < 5)
+          module DatadogPinPatch
             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))
+              def datadog_pin=(pin)
+                pin.onto(datadog_target)
+              end
+
+              def datadog_target
+                # For `redis-rb` 4.x
+                return _client if respond_to?(:_client)
+                # For `redis-rb` 3.x
+                return client if respond_to?(:client)
+
+                Datadog.logger.warn 'Fail to apply configuration on redis client instance with '  \
+                                                        '`Datadog.configure_onto(redis)`.'
+
+                # Null object instead of raising error
+                self
               end
             end
           end
 
-          # Patch for redis client
-          module ClientPatch
+          # Patch for redis instance (with redis >= 5)
+          module NotSupportedNoticePatch
             def self.included(base)
               base.prepend(InstanceMethods)
             end
 
-            # Instance method patch for redis client
+            # Instance method patch for redis instance
             module InstanceMethods
-              def initialize(options = {})
-                @redis_instance = options.delete(:redis_instance)
-
-                super(options)
+              def datadog_pin=(_pin)
+                Datadog.logger.warn \
+                  '`Datadog.configure_onto(redis)` is not supported on Redis 5+. To instrument '\
+                  "a redis instance with custom configuration, please initialize it with:\n"\
+                  "  `Redis.new(..., custom: { datadog: { service_name: 'my-service' } })`.\n\n" \
+                  'See: https://github.com/DataDog/dd-trace-rb/blob/master/docs/GettingStarted.md#redis'
               end
-
-              private
-
-              attr_reader :redis_instance
             end
           end
 
@@ -62,12 +72,15 @@ module Datadog
               ::RedisClient.register(TraceMiddleware)
             end
 
-            if Integration.redis_compatible? && Integration.redis_version < Gem::Version.new('5.0.0')
-              require_relative 'instrumentation'
+            if Integration.redis_compatible?
+              if Integration.redis_version < Gem::Version.new('5.0.0')
+                require_relative 'instrumentation'
 
-              ::Redis.include(InstancePatch)
-              ::Redis::Client.include(ClientPatch)
-              ::Redis::Client.include(Instrumentation)
+                ::Redis.include(DatadogPinPatch)
+                ::Redis::Client.include(Instrumentation)
+              else # warn about non-supported configure_onto usage
+                ::Redis.include(NotSupportedNoticePatch)
+              end
             end
           end
         end

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

@@ -18,6 +18,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/resque/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_RESQUE_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_RESQUE_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RESQUE_ANALYTICS_SAMPLE_RATE'
           SERVICE_NAME = 'resque'

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

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -10,6 +10,7 @@ module Datadog
           ENV_ENABLED = 'DD_TRACE_REST_CLIENT_ENABLED'
           ENV_SERVICE_NAME = 'DD_TRACE_REST_CLIENT_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_REST_CLIENT_PEER_SERVICE'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_REST_CLIENT_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_REST_CLIENT_ANALYTICS_SAMPLE_RATE'
           DEFAULT_PEER_SERVICE_NAME = 'rest_client'

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

@@ -16,6 +16,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

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

@@ -8,6 +8,7 @@ module Datadog
         module Ext
           APP = 'roda'
           ENV_ENABLED = 'DD_TRACE_RODA_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_RODA_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_RODA_ANALYTICS_SAMPLE_RATE'
           SPAN_REQUEST = 'roda.request'

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

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/sequel/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_SEQUEL_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_SEQUEL_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SEQUEL_ANALYTICS_SAMPLE_RATE'
           SPAN_QUERY = 'sequel.query'

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

@@ -18,6 +18,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/shoryuken/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_SHORYUKEN_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_SHORYUKEN_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SHORYUKEN_ANALYTICS_SAMPLE_RATE'
           SERVICE_NAME = 'shoryuken'