Instrument gems that are required after Datadog.configure

.github/scripts/update_supported_versions.rb

@@ -99,7 +99,7 @@ def process_integrations
     integrations.each do |integration|
       next if EXCLUDED_INTEGRATIONS.include?(integration)
 
-      integration_name = resolve_integration_name(integration)
+      integration_name = resolve_integration_names(integration)[0]
 
       @integration_json_mapping[integration] = [
         @min_gems['ruby'][integration_name],
@@ -128,11 +128,11 @@ def include_hardcoded_versions
     ]
   end
 
-  def resolve_integration_name(integration)
+  def resolve_integration_names(integration)
     mod_name = SPECIAL_CASES[integration] || integration.split('_').map(&:capitalize).join
     module_name = "Datadog::Tracing::Contrib::#{mod_name}"
     integration_module = Object.const_get(module_name)::Integration
-    integration_module.respond_to?(:gem_name) ? integration_module.gem_name : integration
+    integration_module.respond_to?(:gem_names) ? integration_module.gem_names : [integration]
   rescue NameError, NoMethodError
     puts "Fallback for #{integration}: module or gem_name not found."
     integration

Gemfile

@@ -1 +1,4 @@
 eval_gemfile("#{RUBY_ENGINE}-#{RUBY_ENGINE_VERSION.split('.').take(2).join('.')}.gemfile")
+
+gem 'faraday'
+# gem 'rails', '4.0.13'

Rakefile

@@ -268,9 +268,19 @@ namespace :spec do
     :suite,
     :trilogy
   ].each do |contrib|
+    # Test for each integration. These tests will pollute the environment (e.g. load gems, monkey-patch modules).
     desc '' # "Explicitly hiding from `rake -T`"
     RSpec::Core::RakeTask.new(contrib) do |t, args|
       t.pattern = "spec/datadog/tracing/contrib/#{contrib}/**/*_spec.rb"
+      t.exclude_pattern = "spec/datadog/tracing/contrib/#{contrib}/integration_spec.rb"
+      t.rspec_opts = args.to_a.join(' ')
+    end
+
+    # Tests that have to run with a clean environment, where instrumented gems have
+    # not yet been loaded, and 3rd-party classes and modules have not been patched.
+    desc '' # "Explicitly hiding from `rake -T`"
+    RSpec::Core::RakeTask.new("#{contrib}_clean") do |t, args|
+      t.pattern = "spec/datadog/tracing/contrib/#{contrib}/integration_spec.rb"
       t.rspec_opts = args.to_a.join(' ')
     end
   end

benchmarks/devweek.rb

@@ -0,0 +1,74 @@
+# rubocop:disable
+require 'datadog'
+
+# module Datadog
+#   module Tracing
+#     module Contrib
+#       module Kernel
+#         def require(name)
+#           just_loaded = super
+#
+#           @@dd_instance.require(name) if just_loaded
+#
+#           just_loaded
+#         end
+#
+#         class Instance
+#           def initialize
+#             @on_require = {}
+#           end
+#
+#           def require(name)
+#             if @on_require.include?(name)
+#               Datadog.logger.debug { "Gem '#{name}' loaded. Invoking callback." }
+#
+#               @on_require[name].call
+#             end
+#           rescue => e
+#             Datadog.logger.debug do
+#               "Failed to execute callback for gem '#{name}': #{e.class.name} #{e.message} at #{Array(e.backtrace).join("\n")}"
+#             end
+#           end
+#
+#           def on_require(gem, &block)
+#             @on_require[gem] = block
+#           end
+#         end
+#
+#         @@dd_instance = Instance.new
+#
+#         def self.on_require(gem, &block)
+#           @@dd_instance.on_require(gem, &block)
+#         end
+#
+#         def self.patch!
+#           ::Kernel.prepend(self)
+#         end
+#
+#         DD_PATCH_ONLY_ONCE = Datadog::Core::Utils::OnlyOnce.new
+#         private_constant :DD_PATCH_ONLY_ONCE
+#       end
+#     end
+#   end
+# end
+#
+# Datadog::Tracing::Contrib::Kernel.patch! # TODO: I think this stays here actually!
+
+ENV['DD_TRACE_DEBUG'] = 'true'
+
+# Setup
+require 'datadog'
+
+Datadog.configure do |c|
+  c.tracing.instrument :faraday
+end
+
+require 'faraday'
+
+# User application
+Faraday.get('http://example.com')
+
+# Tear down
+Datadog.shutdown! # Ensure traces have been flushed
+
+# rubocop:enable

lib/datadog/tracing/contrib/action_cable/integration.rb

@@ -17,8 +17,14 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :action_cable, auto_patch: false
-          def self.gem_name
-            'actioncable'
+
+
+          def self.gems
+            ['actioncable']
+          end
+
+          def self.gem_load_paths
+            ['action_cable']
           end
 
           def self.version

lib/datadog/tracing/contrib/action_mailer/integration.rb

@@ -18,8 +18,12 @@ class Integration
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :action_mailer, auto_patch: false
 
-          def self.gem_name
-            'actionmailer'
+          def self.gems
+            ['actionmailer']
+          end
+
+          def self.gem_load_paths
+            ['action_mailer']
           end
 
           def self.version

lib/datadog/tracing/contrib/action_pack/integration.rb

@@ -18,8 +18,14 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :action_pack, auto_patch: false
-          def self.gem_name
-            'actionpack'
+
+
+          def self.gems
+            ['actionpack']
+          end
+
+          def self.gem_load_paths
+            ['action_pack']
           end
 
           def self.version

lib/datadog/tracing/contrib/action_view/integration.rb

@@ -18,8 +18,13 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :action_view, auto_patch: false
-          def self.gem_name
-            'actionview'
+
+          def self.gem_load_paths
+            ['action_view']
+          end
+
+          def self.gems
+            ['actionview', 'actionpack']
           end
 
           def self.version

lib/datadog/tracing/contrib/active_job/integration.rb

@@ -17,8 +17,14 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :active_job, auto_patch: false
-          def self.gem_name
-            'activejob'
+
+
+          def self.gems
+            ['activejob']
+          end
+
+          def self.gem_load_paths
+            ['active_job']
           end
 
           def self.version

lib/datadog/tracing/contrib/active_model_serializers/integration.rb

@@ -17,6 +17,14 @@ class Integration
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :active_model_serializers
 
+          def self.gems
+            ['active_model_serializers']
+          end
+
+          def self.gem_load_paths
+            ['active_model_serializers']
+          end
+
           def self.version
             Gem.loaded_specs['active_model_serializers'] \
               && Gem.loaded_specs['active_model_serializers'].version

lib/datadog/tracing/contrib/active_record/integration.rb

@@ -22,8 +22,12 @@ class Integration
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :active_record, auto_patch: false
 
-          def self.gem_name
-            'activerecord'
+          def self.gems
+            ['activerecord']
+          end
+
+          def self.gem_load_paths
+            ['active_record']
           end
 
           def self.version

lib/datadog/tracing/contrib/active_support/integration.rb

@@ -19,8 +19,14 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :active_support, auto_patch: false
-          def self.gem_name
-            'activesupport'
+
+
+          def self.gems
+            ['activesupport']
+          end
+
+          def self.gem_load_paths
+            ['active_support']
           end
 
           def self.version

lib/datadog/tracing/contrib/aws/integration.rb

@@ -16,8 +16,14 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :aws, auto_patch: true
-          def self.gem_name
-            'aws-sdk'
+
+
+          def self.gems
+            ['aws-sdk', 'aws-sdk-core']
+          end
+
+          def self.gem_load_paths
+            ['aws-sdk', 'aws-sdk-core']
           end
 
           def self.version

lib/datadog/tracing/contrib/concurrent_ruby/integration.rb

@@ -16,8 +16,14 @@ class Integration
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :concurrent_ruby
-          def self.gem_name
-            'concurrent-ruby'
+
+
+          def self.gems
+            ['concurrent-ruby']
+          end
+
+          def self.gem_load_paths
+            ['concurrent']
           end
 
           def self.version

lib/datadog/tracing/contrib/dalli/integration.rb

@@ -18,6 +18,14 @@ class Integration
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :dalli, auto_patch: true
 
+          def self.gems
+            ['dalli']
+          end
+
+          def self.gem_load_paths
+            ['dalli']
+          end
+
           def self.version
             Gem.loaded_specs['dalli'] && Gem.loaded_specs['dalli'].version
           end

lib/datadog/tracing/contrib/delayed_job/integration.rb

@@ -17,6 +17,14 @@ class Integration
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :delayed_job
 
+          def self.gems
+            ['delayed_job']
+          end
+
+          def self.gem_load_paths
+            ['delayed_job']
+          end
+
           def self.version
             Gem.loaded_specs['delayed_job'] && Gem.loaded_specs['delayed_job'].version
           end

lib/datadog/tracing/contrib/elasticsearch/integration.rb

@@ -17,6 +17,14 @@ class Integration
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :elasticsearch, auto_patch: true
 
+          def self.gems
+            ['elastic-transport', 'elasticsearch-transport']
+          end
+
+          def self.gem_load_paths
+            ['elastic-transport', 'elasticsearch-transport']
+          end
+
           def self.version
             # elastic-transport gem for version >= 8.0.0
             # elasticsearch-transport gem for version < 8.0.0

lib/datadog/tracing/contrib/ethon/integration.rb

@@ -18,6 +18,14 @@ class Integration
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :ethon
 
+          def self.gems
+            ['ethon']
+          end
+
+          def self.gem_load_paths
+            ['ethon']
+          end
+
           def self.version
             Gem.loaded_specs['ethon'] && Gem.loaded_specs['ethon'].version
           end

lib/datadog/tracing/contrib/excon/integration.rb

@@ -18,6 +18,14 @@ class Integration
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :excon
 
+          def self.gems
+            ['excon']
+          end
+
+          def self.gem_load_paths
+            ['excon']
+          end
+
           def self.version
             Gem.loaded_specs['excon'] && Gem.loaded_specs['excon'].version
           end