opentelemetry-instrumentation-sidekiq 0.10.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1348a87123eadcb378d285875b8aa056d1504ba7570119fc0198798d0eab42d
-  data.tar.gz: 389b4b4c843538e106383f75c9eb82e17bc60b74952f5fdd9a6e39d3fa57e6f6
+  metadata.gz: b47b423da167e94b32a86eaa9cf407e1903b9b65592de432509f3dc16baf8352
+  data.tar.gz: f638e9ade781101950fecd483f0843be24888415f1b2bd017ff0519074e9533e
 SHA512:
-  metadata.gz: 52f9e6cb70e5702f000af558efef43e3ad7389e5ccdb2b9c77b61cc5ca6b2d92588dedabc882dd90360f319ea93fddf3d3f53f9b4d062fe7aa3ccb1da2dd096b
-  data.tar.gz: a305271c481c84204b0adce8eb062ba0db0f8ade6204560fe2dd95c6652bbc12609319afd7906a9721d5f54930964939eb85dc9a7182ffaf42d629775cfa153a
+  metadata.gz: ab5a6394031d48a5d0f5615036ba29ab6401c5daa69abdf54924a4ae495eaaff59d5f3ad1a900ae84d3c328ee15068b95042ac6272426f68226573d8a590de94
+  data.tar.gz: 9bb8b5615861fa1bfcef29d295c80c47db8fcb48bb425534cea7d305ac65a5bdba18076ab3197afe71900046a60131194e3459ac78d166ea0b1825073e930633

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Release History: opentelemetry-instrumentation-sidekiq
 
+### 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)
+
+### v0.11.0 / 2020-12-11
+
+* FIXED: Copyright comments to not reference year 
+
 ### v0.10.0 / 2020-12-03
 
 * (No significant changes)

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 OpenTelemetry Authors
+   Copyright The OpenTelemetry Authors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -31,7 +31,7 @@ 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?
 
@@ -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

data/lib/opentelemetry-instrumentation-sidekiq.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation/sidekiq.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -16,3 +16,4 @@ end
 
 require_relative './sidekiq/instrumentation'
 require_relative './sidekiq/version'
+require 'opentelemetry/common'

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -10,21 +10,52 @@ 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
+
         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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -14,14 +14,17 @@ module OpenTelemetry
           class TracerMiddleware
             def call(_worker_class, job, _queue, _redis_pool)
               tracer.in_span(
-                job['wrapped']&.to_s || job['class'],
+                span_name(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' => job['queue'],
+                  'messaging.destination_kind' => 'queue'
                 },
                 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 +32,18 @@ module OpenTelemetry
 
             private
 
+            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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -13,12 +13,15 @@ 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'],
+                span_name(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' => msg['queue'],
+                  'messaging.destination_kind' => 'queue'
                 },
                 with_parent: parent_context,
                 kind: :consumer
@@ -31,6 +34,18 @@ module OpenTelemetry
 
             private
 
+            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,34 @@
+# 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]
+              tracer.in_span('Sidekiq::Launcher#heartbeat') { 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,42 @@
+# 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]
+              tracer.in_span('Sidekiq::Scheduled::Poller#enqueue') { 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,34 @@
+# 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 insturmentation for the process_one method
+        module Processor
+          private
+
+          def process_one
+            if config[:trace_processor_process_one]
+              tracer.in_span('Sidekiq::Processor#process_one') { 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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
 module OpenTelemetry
   module Instrumentation
     module Sidekiq
-      VERSION = '0.10.0'
+      VERSION = '0.15.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.15.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -167,15 +181,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.10.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.15.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.10.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.15.0
 post_install_message: 
 rdoc_options: []
 require_paths: