opentelemetry-instrumentation-sidekiq 0.13.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06105b13c70190b459d650fff91f1f3052cb1e655cd744100aeee6475bbb5b8f
-  data.tar.gz: 4b7142a06febd442ac3184270c0e73562a47ec252d5b7dc829d12d9863d7009f
+  metadata.gz: 4405583412d46b76cbc7f66b507f931946fdc4555b7ab571760efe72a185b341
+  data.tar.gz: 63c257bf5c9f033fc3b336fb4acb90ac61ddae10637bade6bc6c48cd08cb2011
 SHA512:
-  metadata.gz: c5efbba5397bff170c7f8c1cf8deee5d3c7ecdd9e6b2fde14e8fffe6cff0f88f777c91b5dfed4bd96895af188015d4e18a581376f7cc52851a9ec7ab22821d21
-  data.tar.gz: 422779d862bee296be58b695c11614bf5778648b9b009495ff9a3aea5f4b37e214f092b2a6d53072f6a89f2397dc069decc35031a4a18c55ce7fcd4690e20775
+  metadata.gz: 5fc041aa4d97dd1c19170ef17aa39ff141debd9a1c38d750862c77eda880cc643a5dea481bccaf8e82d96d8555d2ad027e7bf36c92fb5ef90b8c867fcc5eddfe
+  data.tar.gz: 9df46a9b2777fed4ee8b857a0313db47ce87b524ddbe3217547d1465650d8e3b3d95e95d9ff50ee1d8c25cec6f3b1025e261a97ecacf0f787189e311899b8591

data/CHANGELOG.md

@@ -1,10 +1,38 @@
 # Release History: opentelemetry-instrumentation-sidekiq
 
+### v0.18.0 / 2021-05-21
+
+* ADDED: Updated API depedency for 1.0.0.rc1
+* TEST: update test for redis instrumentation refactor [#760](https://github.com/open-telemetry/opentelemetry-ruby/pull/760)
+* BREAKING CHANGE: Remove optional parent_context from in_span
+
+* FIXED: Remove optional parent_context from in_span
+* FIXED: Instrument Redis more thoroughly by patching Client#process.
+
+### 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 
+* 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
 
@@ -12,7 +40,7 @@
 
 ### v0.11.0 / 2020-12-11
 
-* FIXED: Copyright comments to not reference year 
+* FIXED: Copyright comments to not reference year
 
 ### v0.10.0 / 2020-12-03
 
@@ -20,9 +48,9 @@
 
 ### v0.9.0 / 2020-11-27
 
-* BREAKING CHANGE: Add timeout for force_flush and shutdown 
+* BREAKING CHANGE: Add timeout for force_flush and shutdown
 
-* ADDED: Add timeout for force_flush and shutdown 
+* ADDED: Add timeout for force_flush and shutdown
 
 ### v0.8.0 / 2020-10-27
 
@@ -30,9 +58,9 @@
 
 ### v0.7.0 / 2020-10-07
 
-* DOCS: Adding README for Sidekiq instrumentation 
-* DOCS: Remove duplicate reference in Sidekiq README 
-* DOCS: Standardize toplevel docs structure and readme 
+* DOCS: Adding README for Sidekiq instrumentation
+* DOCS: Remove duplicate reference in Sidekiq README
+* DOCS: Standardize toplevel docs structure and readme
 
 ### v0.6.0 / 2020-09-10
 

data/README.md

@@ -33,11 +33,20 @@ end
 
 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?
+## Development
+
+You'll need Redis installed locally to run the test suite. Once you've
+installed it, it will start and stop automatically when you run `rake`.
+
+```
+redis-server test/redis.conf
+```
+
+## How can I get involved?
 
 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
 
@@ -49,4 +58,4 @@ The `opentelemetry-instrumentation-sidekiq` gem is distributed under the Apache
 [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

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

@@ -27,6 +27,13 @@ module OpenTelemetry
           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

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

@@ -15,16 +15,10 @@ module OpenTelemetry
             def call(_worker_class, job, _queue, _redis_pool)
               tracer.in_span(
                 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_kind' => 'queue'
-                },
+                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
@@ -32,6 +26,18 @@ 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"

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

@@ -13,27 +13,34 @@ module OpenTelemetry
           # by way of its middleware system
           class TracerMiddleware
             def call(_worker, msg, _queue)
-              parent_context = OpenTelemetry.propagation.text.extract(msg)
-              tracer.in_span(
-                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_kind' => 'queue'
-                },
-                with_parent: parent_context,
-                kind: :consumer
-              ) do |span|
-                span.add_event('created_at', timestamp: msg['created_at'])
-                span.add_event('enqueued_at', timestamp: msg['enqueued_at'])
-                yield
+              extracted_context = OpenTelemetry.propagation.extract(msg)
+              OpenTelemetry::Context.with_current(extracted_context) do
+                tracer.in_span(
+                  span_name(msg),
+                  attributes: build_attributes(msg),
+                  kind: :consumer
+                ) do |span|
+                  span.add_event('created_at', timestamp: msg['created_at'])
+                  span.add_event('enqueued_at', timestamp: msg['enqueued_at'])
+                  yield
+                end
               end
             end
 
             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"

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

@@ -14,7 +14,9 @@ module OpenTelemetry
 
           def ❤ # rubocop:disable Naming/MethodName
             if config[:trace_launcher_heartbeat]
-              tracer.in_span('Sidekiq::Launcher#heartbeat') { super }
+              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

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

@@ -12,7 +12,9 @@ module OpenTelemetry
         module Poller
           def enqueue
             if config[:trace_poller_enqueue]
-              tracer.in_span('Sidekiq::Scheduled::Poller#enqueue') { super }
+              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

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

@@ -8,13 +8,15 @@ module OpenTelemetry
   module Instrumentation
     module Sidekiq
       module Patches
-        # The Processor module contains the insturmentation for the process_one method
+        # The Processor module contains the instrumentation 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 }
+              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

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Sidekiq
-      VERSION = '0.13.0'
+      VERSION = '0.18.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.18.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-30 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -189,10 +203,10 @@ 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.13.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.18.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.13.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.18.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -208,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