fix: make sidekiq instrumentation compatible with sidekiq 6.5.0 (#1304)

* fix: make sidekiq instrumentation compatible with sidekiq 6.5.0

This commit:

- changes our config method to instrumentation_config. Sidekiq's new
Component module is mixed in in a lot of places, and that module
includes a config method that we very much do not want to overwrite.

- changes the MockLoader in our test suite to be compatible with Sidekiq
6.5.0. Starting in Sidekiq 6.5.0, Sidekiq accepts the Sidekiq singleton
as an argument to Launcher.new. It seems like this is an intermediate
step to making Sidekiq::Config its own class, which is planned for
Sidekiq 7.0.

- adds appraisals for sidekiq 6.4.0 and 6.5.0

* appease the cop

Author: plantfansam

instrumentation/sidekiq/Appraisals

@@ -1,5 +1,13 @@
 # frozen_string_literal: true
 
+appraise 'sidekiq-6.5' do
+  gem 'sidekiq', '~> 6.5'
+end
+
+appraise 'sidekiq-6.4' do
+  gem 'sidekiq', '~> 6.4'
+end
+
 appraise 'sidekiq-6.3' do
   gem 'sidekiq', '~> 6.3'
 end

instrumentation/sidekiq/lib/opentelemetry/instrumentation/sidekiq/middlewares/client/tracer_middleware.rb

@@ -20,9 +20,9 @@ def call(_worker_class, job, _queue, _redis_pool) # rubocop:disable Metrics/AbcS
                 'messaging.destination' => job['queue'],
                 'messaging.destination_kind' => 'queue'
               }
-              attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+              attributes['peer.service'] = instrumentation_config[:peer_service] if instrumentation_config[:peer_service]
 
-              span_name = case config[:span_naming]
+              span_name = case instrumentation_config[:span_naming]
                           when :job_class then "#{job['wrapped']&.to_s || job['class']} send"
                           else "#{job['queue']} send"
                           end
@@ -36,7 +36,7 @@ def call(_worker_class, job, _queue, _redis_pool) # rubocop:disable Metrics/AbcS
 
             private
 
-            def config
+            def instrumentation_config
               Sidekiq::Instrumentation.instance.config
             end
 

instrumentation/sidekiq/lib/opentelemetry/instrumentation/sidekiq/middlewares/server/tracer_middleware.rb

@@ -21,16 +21,16 @@ def call(_worker, msg, _queue) # rubocop:disable Metrics/AbcSize, Metrics/Cyclom
                 'messaging.destination_kind' => 'queue',
                 'messaging.operation' => 'process'
               }
-              attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+              attributes['peer.service'] = instrumentation_config[:peer_service] if instrumentation_config[:peer_service]
 
-              span_name = case config[:span_naming]
+              span_name = case instrumentation_config[:span_naming]
                           when :job_class then "#{msg['wrapped']&.to_s || msg['class']} process"
                           else "#{msg['queue']} process"
                           end
 
               extracted_context = OpenTelemetry.propagation.extract(msg)
               OpenTelemetry::Context.with_current(extracted_context) do
-                if config[:propagation_style] == :child
+                if instrumentation_config[:propagation_style] == :child
                   tracer.in_span(span_name, attributes: attributes, kind: :consumer) do |span|
                     span.add_event('created_at', timestamp: msg['created_at'])
                     span.add_event('enqueued_at', timestamp: msg['enqueued_at'])
@@ -39,7 +39,7 @@ def call(_worker, msg, _queue) # rubocop:disable Metrics/AbcSize, Metrics/Cyclom
                 else
                   links = []
                   span_context = OpenTelemetry::Trace.current_span(extracted_context).context
-                  links << OpenTelemetry::Trace::Link.new(span_context) if config[:propagation_style] == :link && span_context.valid?
+                  links << OpenTelemetry::Trace::Link.new(span_context) if instrumentation_config[:propagation_style] == :link && span_context.valid?
                   span = tracer.start_root_span(span_name, attributes: attributes, links: links, kind: :consumer)
                   OpenTelemetry::Trace.with_span(span) do
                     span.add_event('created_at', timestamp: msg['created_at'])
@@ -58,7 +58,7 @@ def call(_worker, msg, _queue) # rubocop:disable Metrics/AbcSize, Metrics/Cyclom
 
             private
 
-            def config
+            def instrumentation_config
               Sidekiq::Instrumentation.instance.config
             end
 

instrumentation/sidekiq/lib/opentelemetry/instrumentation/sidekiq/patches/launcher.rb

@@ -13,9 +13,9 @@ module Launcher
           private
 
           def ❤ # rubocop:disable Naming/MethodName
-            if config[:trace_launcher_heartbeat]
+            if instrumentation_config[:trace_launcher_heartbeat]
               attributes = {}
-              attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+              attributes['peer.service'] = instrumentation_config[:peer_service] if instrumentation_config[:peer_service]
               tracer.in_span('Sidekiq::Launcher#heartbeat', attributes: attributes) { super }
             else
               OpenTelemetry::Common::Utilities.untraced { super }
@@ -26,7 +26,7 @@ def tracer
             Sidekiq::Instrumentation.instance.tracer
           end
 
-          def config
+          def instrumentation_config
             Sidekiq::Instrumentation.instance.config
           end
         end

instrumentation/sidekiq/lib/opentelemetry/instrumentation/sidekiq/patches/poller.rb

@@ -11,9 +11,9 @@ module Patches
         # The Poller module contains instrumentation for the enqueue and wait methods
         module Poller
           def enqueue
-            if config[:trace_poller_enqueue]
+            if instrumentation_config[:trace_poller_enqueue]
               attributes = {}
-              attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+              attributes['peer.service'] = instrumentation_config[:peer_service] if instrumentation_config[:peer_service]
               tracer.in_span('Sidekiq::Scheduled::Poller#enqueue', attributes: attributes) { super }
             else
               OpenTelemetry::Common::Utilities.untraced { super }
@@ -23,7 +23,7 @@ def enqueue
           private
 
           def wait
-            if config[:trace_poller_wait]
+            if instrumentation_config[:trace_poller_wait]
               tracer.in_span('Sidekiq::Scheduled::Poller#wait') { super }
             else
               OpenTelemetry::Common::Utilities.untraced { super }
@@ -34,7 +34,7 @@ def tracer
             Sidekiq::Instrumentation.instance.tracer
           end
 
-          def config
+          def instrumentation_config
             Sidekiq::Instrumentation.instance.config
           end
         end

instrumentation/sidekiq/lib/opentelemetry/instrumentation/sidekiq/patches/processor.rb

@@ -13,9 +13,9 @@ module Processor
           private
 
           def process_one
-            if config[:trace_processor_process_one]
+            if instrumentation_config[:trace_processor_process_one]
               attributes = {}
-              attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+              attributes['peer.service'] = instrumentation_config[:peer_service] if instrumentation_config[:peer_service]
               tracer.in_span('Sidekiq::Processor#process_one', attributes: attributes) { super }
             else
               OpenTelemetry::Common::Utilities.untraced { super }
@@ -26,7 +26,7 @@ def tracer
             Sidekiq::Instrumentation.instance.tracer
           end
 
-          def config
+          def instrumentation_config
             Sidekiq::Instrumentation.instance.config
           end
         end

instrumentation/sidekiq/test/helpers/mock_loader_new_launcher.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'sidekiq/cli'
+require 'sidekiq/launcher'
+
+class MockLoader
+  attr_reader :launcher
+
+  def initialize
+    Sidekiq[:queues] << 'default'
+
+    @launcher = Sidekiq::Launcher.new(Sidekiq)
+    @launcher.fire_event(:startup)
+  end
+
+  def poller
+    launcher.poller
+  end
+
+  def manager
+    launcher.manager
+  end
+end

instrumentation/sidekiq/test/test_helper.rb

@@ -12,10 +12,18 @@
 
 require 'minitest/autorun'
 require 'rspec/mocks/minitest_integration'
-require 'helpers/mock_loader'
 require 'active_job'
 require 'pry'
 
+# Sidekiq changed its loading mechanism in 6.5.0, but we still want to test the
+# older versions. We can eliminate the first part of this conditional when we no
+# longer support Sidekiq 6.4.x versions.
+if Gem::Version.new(Sidekiq::VERSION) < Gem::Version.new('6.5.0')
+  require 'helpers/mock_loader'
+else
+  require 'helpers/mock_loader_new_launcher'
+end
+
 # OpenTelemetry SDK config for testing
 EXPORTER = OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new
 span_processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(EXPORTER)