Contrib:Make registry a global constant repository

lib/ddtrace.rb

@@ -22,62 +22,24 @@ module Datadog
   extend Configuration
   extend AutoInstrumentBase
 
-  # Load and extend Contrib by default
+  # Load built-in Datadog integrations
+  require 'ddtrace/contrib'
+
+  # Load extension to global Datadog objects
   require 'ddtrace/contrib/extensions'
-  extend Contrib::Extensions
+  extend(Contrib::Extensions)
+  Configuration::Settings.include(Contrib::Extensions::Configuration::Settings)
+
+  # Load Contrib auto instrumentation
+  require 'ddtrace/contrib/auto_instrument'
+  extend(Contrib::AutoInstrument)
 
   # Load and extend OpenTelemetry compatibility by default
   require 'ddtrace/opentelemetry/extensions'
   extend OpenTelemetry::Extensions
 
-  # Load and extend AutoInstrument
-  require 'ddtrace/contrib/auto_instrument'
-  extend Contrib::AutoInstrument
-
   # Add shutdown hook:
   # Ensures the tracer has an opportunity to flush traces
   # and cleanup before terminating the process.
   at_exit { Datadog.shutdown! }
 end
-
-require 'ddtrace/contrib/action_cable/integration'
-require 'ddtrace/contrib/action_pack/integration'
-require 'ddtrace/contrib/action_view/integration'
-require 'ddtrace/contrib/active_model_serializers/integration'
-require 'ddtrace/contrib/active_record/integration'
-require 'ddtrace/contrib/active_support/integration'
-require 'ddtrace/contrib/aws/integration'
-require 'ddtrace/contrib/concurrent_ruby/integration'
-require 'ddtrace/contrib/dalli/integration'
-require 'ddtrace/contrib/delayed_job/integration'
-require 'ddtrace/contrib/elasticsearch/integration'
-require 'ddtrace/contrib/ethon/integration'
-require 'ddtrace/contrib/excon/integration'
-require 'ddtrace/contrib/faraday/integration'
-require 'ddtrace/contrib/grape/integration'
-require 'ddtrace/contrib/graphql/integration'
-require 'ddtrace/contrib/grpc/integration'
-require 'ddtrace/contrib/http/integration'
-require 'ddtrace/contrib/httpclient/integration'
-require 'ddtrace/contrib/httprb/integration'
-require 'ddtrace/contrib/integration'
-require 'ddtrace/contrib/kafka/integration'
-require 'ddtrace/contrib/lograge/integration'
-require 'ddtrace/contrib/presto/integration'
-require 'ddtrace/contrib/que/integration'
-require 'ddtrace/contrib/mysql2/integration'
-require 'ddtrace/contrib/mongodb/integration'
-require 'ddtrace/contrib/qless/integration'
-require 'ddtrace/contrib/racecar/integration'
-require 'ddtrace/contrib/rack/integration'
-require 'ddtrace/contrib/rails/integration'
-require 'ddtrace/contrib/rake/integration'
-require 'ddtrace/contrib/redis/integration'
-require 'ddtrace/contrib/resque/integration'
-require 'ddtrace/contrib/rest_client/integration'
-require 'ddtrace/contrib/sequel/integration'
-require 'ddtrace/contrib/shoryuken/integration'
-require 'ddtrace/contrib/sidekiq/integration'
-require 'ddtrace/contrib/sinatra/integration'
-require 'ddtrace/contrib/sneakers/integration'
-require 'ddtrace/contrib/sucker_punch/integration'

lib/ddtrace/contrib.rb

@@ -0,0 +1,63 @@
+require 'ddtrace/contrib/registry'
+
+module Datadog
+  module Contrib
+    # Registry is a global, declarative repository of all available integrations.
+    #
+    # Integrations should register themselves with the registry as early as
+    # possible as the initial tracer configuration can only activate integrations
+    # if they have already been registered.
+    #
+    # Despite that, integrations *can* be appended to the registry at any point
+    # of the program execution. Newly appended integrations can then be
+    # activated during tracer reconfiguration.
+    #
+    # The registry does not depend on runtime configuration and registered integrations
+    # must execute correctly after successive configuration changes.
+    # The registered integrations themselves can depend on the stateful configuration
+    # of the tracer.
+    REGISTRY = Registry.new
+  end
+end
+
+require 'ddtrace/contrib/action_cable/integration'
+require 'ddtrace/contrib/action_pack/integration'
+require 'ddtrace/contrib/action_view/integration'
+require 'ddtrace/contrib/active_model_serializers/integration'
+require 'ddtrace/contrib/active_record/integration'
+require 'ddtrace/contrib/active_support/integration'
+require 'ddtrace/contrib/aws/integration'
+require 'ddtrace/contrib/concurrent_ruby/integration'
+require 'ddtrace/contrib/dalli/integration'
+require 'ddtrace/contrib/delayed_job/integration'
+require 'ddtrace/contrib/elasticsearch/integration'
+require 'ddtrace/contrib/ethon/integration'
+require 'ddtrace/contrib/excon/integration'
+require 'ddtrace/contrib/faraday/integration'
+require 'ddtrace/contrib/grape/integration'
+require 'ddtrace/contrib/graphql/integration'
+require 'ddtrace/contrib/grpc/integration'
+require 'ddtrace/contrib/http/integration'
+require 'ddtrace/contrib/httpclient/integration'
+require 'ddtrace/contrib/httprb/integration'
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/kafka/integration'
+require 'ddtrace/contrib/lograge/integration'
+require 'ddtrace/contrib/presto/integration'
+require 'ddtrace/contrib/que/integration'
+require 'ddtrace/contrib/mysql2/integration'
+require 'ddtrace/contrib/mongodb/integration'
+require 'ddtrace/contrib/qless/integration'
+require 'ddtrace/contrib/racecar/integration'
+require 'ddtrace/contrib/rack/integration'
+require 'ddtrace/contrib/rails/integration'
+require 'ddtrace/contrib/rake/integration'
+require 'ddtrace/contrib/redis/integration'
+require 'ddtrace/contrib/resque/integration'
+require 'ddtrace/contrib/rest_client/integration'
+require 'ddtrace/contrib/sequel/integration'
+require 'ddtrace/contrib/shoryuken/integration'
+require 'ddtrace/contrib/sidekiq/integration'
+require 'ddtrace/contrib/sinatra/integration'
+require 'ddtrace/contrib/sneakers/integration'
+require 'ddtrace/contrib/sucker_punch/integration'

lib/ddtrace/contrib/auto_instrument.rb

@@ -25,7 +25,7 @@ def add_auto_instrument
       def self.patch_all
         integrations = []
 
-        Datadog.registry.each do |integration|
+        Contrib::REGISTRY.each do |integration|
           # some instrumentations are automatically enabled when the `rails` instrumentation is enabled,
           # patching them on their own automatically outside of the rails integration context would
           # cause undesirable service naming, so we exclude them based their auto_instrument? setting.

lib/ddtrace/contrib/extensions.rb

@@ -1,21 +1,28 @@
 require 'set'
-require 'ddtrace/contrib/registry'
+require 'ddtrace/contrib'
+require 'ddtrace/configuration/settings'
 
 module Datadog
   module Contrib
     # Extensions that can be added to the base library
     # Adds registry, configuration access for integrations.
     module Extensions
       def self.extended(base)
-        Datadog.extend(Helpers)
-        Datadog.extend(Configuration)
-        Datadog::Configuration::Settings.include(Configuration::Settings)
+        base.extend(Helpers)
+        base.extend(Configuration)
       end
 
       # Helper methods for Datadog module.
       module Helpers
+        # Returns the global integration registry.
+        #
+        # This method is not safe to use while the tracer is initializing,
+        # thus access to the registry should go through
+        # ::Datadog::Contrib::REGISTRY for internal tracer work.
+        #
+        # External use of this method is always safe.
         def registry
-          configuration.registry
+          Contrib::REGISTRY
         end
       end
 
@@ -60,11 +67,23 @@ def configure(target = configuration, opts = {})
         module Settings
           InvalidIntegrationError = Class.new(StandardError)
 
-          def self.included(base)
-            # Add the additional options to the global configuration settings
-            base.instance_eval do
-              option :registry, default: Registry.new
-            end
+          # The registry only holds declarative constant values and cannot be modified.
+          # This option is a no-op and will be removed in the future.
+          #
+          # @deprecated Use `Datadog::Contrib::REGISTRY` instead
+          def registry
+            Datadog.logger.warn('Deprecated access to `Datadog.configuration.registry`, use `Datadog.registry` instead.')
+            Contrib::REGISTRY
+          end
+
+          # The registry only holds declarative constant values and cannot be modified.
+          # This option is a no-op and will be removed in the future.
+          #
+          # @deprecated Use `Datadog::Contrib::REGISTRY` instead
+          def registry=(_arg)
+            Datadog.logger.warn('Deprecated configuration attempt of the tracer registry. ' \
+                                'The register is a global constant and cannot be directly overwritten.' \
+                                'No changes too place in this call.')
           end
 
           # For the provided `integration_name`, resolves a matching configuration
@@ -125,7 +144,7 @@ def reset!
           end
 
           def fetch_integration(name)
-            registry[name] ||
+            Contrib::REGISTRY[name] ||
               raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
           end
 

lib/ddtrace/contrib/registerable.rb

@@ -1,4 +1,4 @@
-require 'ddtrace/contrib/registry'
+require 'ddtrace/contrib'
 
 module Datadog
   module Contrib
@@ -12,7 +12,7 @@ def self.included(base)
       # Class methods for registerable behavior
       module ClassMethods
         def register_as(name, options = {})
-          registry = options.fetch(:registry, Datadog.registry)
+          registry = options.fetch(:registry, Contrib::REGISTRY)
           auto_patch = options.fetch(:auto_patch, false)
 
           registry.add(name, new(name, options), auto_patch)

spec/ddtrace/auto_instrument_spec.rb

@@ -24,7 +24,7 @@
     require 'ddtrace/auto_instrument'
   end
 
-  after { Datadog.registry[:sinatra].reset_configuration! }
+  after { Datadog::Contrib::REGISTRY[:sinatra].reset_configuration! }
 
   shared_context 'ActiveRecord database' do
     let(:application_record_class) do

spec/ddtrace/contrib/action_cable/patcher_spec.rb

@@ -32,9 +32,9 @@
 
   around do |example|
     # Reset before and after each example; don't allow global state to linger.
-    Datadog.registry[:action_cable].reset_configuration!
+    Datadog::Contrib::REGISTRY[:action_cable].reset_configuration!
     example.run
-    Datadog.registry[:action_cable].reset_configuration!
+    Datadog::Contrib::REGISTRY[:action_cable].reset_configuration!
   end
 
   context 'with server' do

spec/ddtrace/contrib/active_model_serializers/patcher_spec.rb

@@ -35,9 +35,9 @@
 
   around do |example|
     # Reset before and after each example; don't allow global state to linger.
-    Datadog.registry[:active_model_serializers].reset_configuration!
+    Datadog::Contrib::REGISTRY[:active_model_serializers].reset_configuration!
     example.run
-    Datadog.registry[:active_model_serializers].reset_configuration!
+    Datadog::Contrib::REGISTRY[:active_model_serializers].reset_configuration!
   end
 
   describe 'on render' do

spec/ddtrace/contrib/active_record/multi_db_spec.rb

@@ -83,7 +83,7 @@ def mysql_connection_string
   end
 
   before do
-    Datadog.registry[:active_record].reset_configuration!
+    Datadog::Contrib::REGISTRY[:active_record].reset_configuration!
 
     Datadog.configure do |c|
       c.use :active_record, configuration_options
@@ -93,7 +93,7 @@ def mysql_connection_string
   end
 
   after do
-    Datadog.registry[:active_record].reset_configuration!
+    Datadog::Contrib::REGISTRY[:active_record].reset_configuration!
   end
 
   context 'when databases are configured with' do

spec/ddtrace/contrib/active_record/performance_spec.rb

@@ -21,7 +21,7 @@
     end
   end
 
-  after { Datadog.registry[:active_record].reset_configuration! }
+  after { Datadog::Contrib::REGISTRY[:active_record].reset_configuration! }
 
   describe 'for an in-memory database' do
     let!(:connection) do

spec/ddtrace/contrib/active_record/tracer_spec.rb

@@ -26,9 +26,9 @@
 
   around do |example|
     # Reset before and after each example; don't allow global state to linger.
-    Datadog.registry[:active_record].reset_configuration!
+    Datadog::Contrib::REGISTRY[:active_record].reset_configuration!
     example.run
-    Datadog.registry[:active_record].reset_configuration!
+    Datadog::Contrib::REGISTRY[:active_record].reset_configuration!
   end
 
   context 'when query is made' do

spec/ddtrace/contrib/aws/instrumentation_spec.rb

@@ -21,9 +21,9 @@
 
   around do |example|
     # Reset before and after each example; don't allow global state to linger.
-    Datadog.registry[:aws].reset_configuration!
+    Datadog::Contrib::REGISTRY[:aws].reset_configuration!
     example.run
-    Datadog.registry[:aws].reset_configuration!
+    Datadog::Contrib::REGISTRY[:aws].reset_configuration!
   end
 
   context 'when the client runs' do

spec/ddtrace/contrib/dalli/instrumentation_spec.rb

@@ -22,9 +22,9 @@
 
   around do |example|
     # Reset before and after each example; don't allow global state to linger.
-    Datadog.registry[:dalli].reset_configuration!
+    Datadog::Contrib::REGISTRY[:dalli].reset_configuration!
     example.run
-    Datadog.registry[:dalli].reset_configuration!
+    Datadog::Contrib::REGISTRY[:dalli].reset_configuration!
   end
 
   describe 'when a client calls #set' do

spec/ddtrace/contrib/delayed_job/plugin_spec.rb

@@ -35,9 +35,9 @@ def job_data
 
   around do |example|
     # Reset before and after each example; don't allow global state to linger.
-    Datadog.registry[:delayed_job].reset_configuration!
+    Datadog::Contrib::REGISTRY[:delayed_job].reset_configuration!
     example.run
-    Datadog.registry[:delayed_job].reset_configuration!
+    Datadog::Contrib::REGISTRY[:delayed_job].reset_configuration!
   end
 
   describe 'instrumenting worker execution' do

spec/ddtrace/contrib/elasticsearch/patcher_spec.rb

@@ -23,9 +23,9 @@
 
   around do |example|
     # Reset before and after each example; don't allow global state to linger.
-    Datadog.registry[:elasticsearch].reset_configuration!
+    Datadog::Contrib::REGISTRY[:elasticsearch].reset_configuration!
     example.run
-    Datadog.registry[:elasticsearch].reset_configuration!
+    Datadog::Contrib::REGISTRY[:elasticsearch].reset_configuration!
   end
 
   describe 'cluster health request' do

spec/ddtrace/contrib/elasticsearch/transport_spec.rb

@@ -31,7 +31,7 @@
     end
   end
 
-  after { Datadog.registry[:elasticsearch].reset_configuration! }
+  after { Datadog::Contrib::REGISTRY[:elasticsearch].reset_configuration! }
 
   context 'when configured with middleware' do
     let(:client) do

spec/ddtrace/contrib/ethon/easy_patch_spec.rb

@@ -19,9 +19,9 @@
 
   around do |example|
     # Reset before and after each example; don't allow global state to linger.
-    Datadog.registry[:ethon].reset_configuration!
+    Datadog::Contrib::REGISTRY[:ethon].reset_configuration!
     example.run
-    Datadog.registry[:ethon].reset_configuration!
+    Datadog::Contrib::REGISTRY[:ethon].reset_configuration!
   end
 
   describe '#http_request' do

spec/ddtrace/contrib/ethon/integration_context.rb

@@ -76,8 +76,8 @@
 
   around do |example|
     # Reset before and after each example; don't allow global state to linger.
-    Datadog.registry[:ethon].reset_configuration!
+    Datadog::Contrib::REGISTRY[:ethon].reset_configuration!
     example.run
-    Datadog.registry[:ethon].reset_configuration!
+    Datadog::Contrib::REGISTRY[:ethon].reset_configuration!
   end
 end

spec/ddtrace/contrib/ethon/multi_patch_spec.rb

@@ -18,9 +18,9 @@
 
   around do |example|
     # Reset before and after each example; don't allow global state to linger.
-    Datadog.registry[:ethon].reset_configuration!
+    Datadog::Contrib::REGISTRY[:ethon].reset_configuration!
     example.run
-    Datadog.registry[:ethon].reset_configuration!
+    Datadog::Contrib::REGISTRY[:ethon].reset_configuration!
   end
 
   describe '#add' do