opentelemetry-instrumentation-sidekiq 0.12.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 716d469116c3607a34fcfe5dcafcbf137e93e46605453a99ec230da3406fe289
-  data.tar.gz: 74dee616eb89a34fe64dd1c3afa5420b257a169ab223b535a7c9768db891597b
+  metadata.gz: 16931c87c910aace5d938407321eb6fc832d36b7436c2f8ac4721da5532bccea
+  data.tar.gz: da9d93ce6c105f7dcbb12a165dd0bc5a8fb9f8b73b2ed0362c7636c8e7aba0f1
 SHA512:
-  metadata.gz: f80ddb2310202e502eff0e41110618607d64635ed5c72c38a6bdd8f1b75c1b61f44b1a76fa2de458767e6968ffeb2db69be199ffe89701786ca31fbe37aff3b7
-  data.tar.gz: 9286e78ff1002456c3470a02457bcbdf59ac94fda195d3a418f5946aede6f9d606072615900e44ef81bc0f2266b9ac25060bcc1dee2efcf8070905314a40a043
+  metadata.gz: f6d91a5b9d207640e9a50d5f9770831c7b8c61d28d29da75de83d3de40ed8054029f1538947afddda8001bfa1ccd02fd202f5fab015818aee5c92c56983b5a93
+  data.tar.gz: 1f9b9e0de5512199abf9ad29335e510920583bbb5ec37e7fba26e34a3f992d6b9758b260acd2ad01219a211168306a475776761a7d6d5d66994483b7c6c090a5

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Release History: opentelemetry-instrumentation-sidekiq
 
+### v0.17.0 / 2021-04-22
+
+* ADDED: Accept config for sidekiq peer service attribute 
+
+### v0.16.0 / 2021-03-17
+
+* FIXED: Example scripts now reference local common lib 
+* DOCS: Replace Gitter with GitHub Discussions 
+
+### v0.15.0 / 2021-02-18
+
+* ADDED: Add instrumentation config validation 
+
+### v0.14.0 / 2021-02-03
+
+* BREAKING CHANGE: Replace getter and setter callables and remove rack specific propagators 
+
+* ADDED: Replace getter and setter callables and remove rack specific propagators 
+
+### v0.13.0 / 2021-01-29
+
+* ADDED: Instrument sidekiq background work 
+* FIXED: Adjust Sidekiq middlewares to match semantic conventions 
+* FIXED: Set minimum compatible version and use untraced helper 
+
 ### v0.12.0 / 2020-12-24
 
 * (No significant changes)

data/README.md

@@ -31,13 +31,13 @@ end
 ```
 ## Examples
 
-Example usage can be seen in the `./example/sidekiq.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/master/instrumentation/sidekiq/example/sidekiq.rb)
+Example usage can be seen in the `./example/sidekiq.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/instrumentation/sidekiq/example/sidekiq.rb)
 
 ## How can I get invovled?
 
 The `opentelemetry-instrumentation-sidekiq` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
 ## License
 
@@ -46,7 +46,7 @@ The `opentelemetry-instrumentation-sidekiq` gem is distributed under the Apache
 [sidekiq-home]: https://github.com/mperham/sidekiq
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
-[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/lib/opentelemetry/instrumentation/sidekiq.rb

@@ -5,6 +5,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry'
+require 'opentelemetry-instrumentation-base'
 
 module OpenTelemetry
   module Instrumentation
@@ -16,3 +17,4 @@ end
 
 require_relative './sidekiq/instrumentation'
 require_relative './sidekiq/version'
+require 'opentelemetry/common'

data/lib/opentelemetry/instrumentation/sidekiq/instrumentation.rb

@@ -10,21 +10,53 @@ module OpenTelemetry
       # The Instrumentation class contains logic to detect and install the Sidekiq
       # instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
+        MINIMUM_VERSION = Gem::Version.new('4.2.10')
+
         install do |_config|
           require_dependencies
           add_client_middleware
           add_server_middleware
+          patch_on_startup
         end
 
         present do
           defined?(::Sidekiq)
         end
 
+        compatible do
+          gem_version >= MINIMUM_VERSION
+        end
+
+        option :enable_job_class_span_names, default: false, validate: :boolean
+        option :trace_launcher_heartbeat,    default: false, validate: :boolean
+        option :trace_poller_enqueue,        default: false, validate: :boolean
+        option :trace_poller_wait,           default: false, validate: :boolean
+        option :trace_processor_process_one, default: false, validate: :boolean
+        option :peer_service,                default: nil,   validate: :string
+
         private
 
+        def gem_version
+          Gem.loaded_specs['sidekiq'].version
+        end
+
         def require_dependencies
           require_relative 'middlewares/client/tracer_middleware'
           require_relative 'middlewares/server/tracer_middleware'
+
+          require_relative 'patches/processor'
+          require_relative 'patches/launcher'
+          require_relative 'patches/poller'
+        end
+
+        def patch_on_startup
+          ::Sidekiq.configure_server do |config|
+            config.on(:startup) do
+              ::Sidekiq::Processor.prepend(Patches::Processor)
+              ::Sidekiq::Launcher.prepend(Patches::Launcher)
+              ::Sidekiq::Scheduled::Poller.prepend(Patches::Poller)
+            end
+          end
         end
 
         def add_client_middleware

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

@@ -14,14 +14,11 @@ module OpenTelemetry
           class TracerMiddleware
             def call(_worker_class, job, _queue, _redis_pool)
               tracer.in_span(
-                job['wrapped']&.to_s || job['class'],
-                attributes: {
-                  'messaging.message_id' => job['jid'],
-                  'messaging.destination' => job['queue']
-                },
+                span_name(job),
+                attributes: build_attributes(job),
                 kind: :producer
               ) do |span|
-                OpenTelemetry.propagation.text.inject(job)
+                OpenTelemetry.propagation.inject(job)
                 span.add_event('created_at', timestamp: job['created_at'])
                 yield
               end
@@ -29,6 +26,30 @@ module OpenTelemetry
 
             private
 
+            def build_attributes(job)
+              attributes = {
+                'messaging.system' => 'sidekiq',
+                'messaging.sidekiq.job_class' => job['wrapped']&.to_s || job['class'],
+                'messaging.message_id' => job['jid'],
+                'messaging.destination' => job['queue'],
+                'messaging.destination_kind' => 'queue'
+              }
+              attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+              attributes
+            end
+
+            def span_name(job)
+              if config[:enable_job_class_span_names]
+                "#{job['wrapped']&.to_s || job['class']} enqueue"
+              else
+                "#{job['queue']} send"
+              end
+            end
+
+            def config
+              Sidekiq::Instrumentation.instance.config
+            end
+
             def tracer
               Sidekiq::Instrumentation.instance.tracer
             end

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

@@ -13,13 +13,10 @@ module OpenTelemetry
           # by way of its middleware system
           class TracerMiddleware
             def call(_worker, msg, _queue)
-              parent_context = OpenTelemetry.propagation.text.extract(msg)
+              parent_context = OpenTelemetry.propagation.extract(msg)
               tracer.in_span(
-                msg['wrapped']&.to_s || msg['class'],
-                attributes: {
-                  'messaging.message_id' => msg['jid'],
-                  'messaging.destination' => msg['queue']
-                },
+                span_name(msg),
+                attributes: build_attributes(msg),
                 with_parent: parent_context,
                 kind: :consumer
               ) do |span|
@@ -31,6 +28,30 @@ module OpenTelemetry
 
             private
 
+            def build_attributes(msg)
+              attributes = {
+                'messaging.system' => 'sidekiq',
+                'messaging.sidekiq.job_class' => msg['wrapped']&.to_s || msg['class'],
+                'messaging.message_id' => msg['jid'],
+                'messaging.destination' => msg['queue'],
+                'messaging.destination_kind' => 'queue'
+              }
+              attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+              attributes
+            end
+
+            def span_name(msg)
+              if config[:enable_job_class_span_names]
+                "#{msg['wrapped']&.to_s || msg['class']} process"
+              else
+                "#{msg['queue']} process"
+              end
+            end
+
+            def config
+              Sidekiq::Instrumentation.instance.config
+            end
+
             def tracer
               Sidekiq::Instrumentation.instance.tracer
             end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Sidekiq
+      module Patches
+        # The Launcher module contains the instrumentation for the Sidekiq heartbeat
+        module Launcher
+          private
+
+          def ❤ # rubocop:disable Naming/MethodName
+            if config[:trace_launcher_heartbeat]
+              attributes = {}
+              attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+              tracer.in_span('Sidekiq::Launcher#heartbeat', attributes: attributes) { super }
+            else
+              OpenTelemetry::Common::Utilities.untraced { super }
+            end
+          end
+
+          def tracer
+            Sidekiq::Instrumentation.instance.tracer
+          end
+
+          def config
+            Sidekiq::Instrumentation.instance.config
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Sidekiq
+      module Patches
+        # The Poller module contains instrumentation for the enqueue and wait methods
+        module Poller
+          def enqueue
+            if config[:trace_poller_enqueue]
+              attributes = {}
+              attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+              tracer.in_span('Sidekiq::Scheduled::Poller#enqueue', attributes: attributes) { super }
+            else
+              OpenTelemetry::Common::Utilities.untraced { super }
+            end
+          end
+
+          private
+
+          def wait
+            if config[:trace_poller_wait]
+              tracer.in_span('Sidekiq::Scheduled::Poller#wait') { super }
+            else
+              OpenTelemetry::Common::Utilities.untraced { super }
+            end
+          end
+
+          def tracer
+            Sidekiq::Instrumentation.instance.tracer
+          end
+
+          def config
+            Sidekiq::Instrumentation.instance.config
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Sidekiq
+      module Patches
+        # The Processor module contains the instrumentation for the process_one method
+        module Processor
+          private
+
+          def process_one
+            if config[:trace_processor_process_one]
+              attributes = {}
+              attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+              tracer.in_span('Sidekiq::Processor#process_one', attributes: attributes) { super }
+            else
+              OpenTelemetry::Common::Utilities.untraced { super }
+            end
+          end
+
+          def tracer
+            Sidekiq::Instrumentation.instance.tracer
+          end
+
+          def config
+            Sidekiq::Instrumentation.instance.config
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/sidekiq/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Sidekiq
-      VERSION = '0.12.0'
+      VERSION = '0.17.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.17.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-24 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -167,15 +195,18 @@ files:
 - lib/opentelemetry/instrumentation/sidekiq/instrumentation.rb
 - lib/opentelemetry/instrumentation/sidekiq/middlewares/client/tracer_middleware.rb
 - lib/opentelemetry/instrumentation/sidekiq/middlewares/server/tracer_middleware.rb
+- lib/opentelemetry/instrumentation/sidekiq/patches/launcher.rb
+- lib/opentelemetry/instrumentation/sidekiq/patches/poller.rb
+- lib/opentelemetry/instrumentation/sidekiq/patches/processor.rb
 - lib/opentelemetry/instrumentation/sidekiq/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.12.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/instrumentation/sidekiq
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.17.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/sidekiq
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.12.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.17.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -191,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Sidekiq instrumentation for the OpenTelemetry framework