opentelemetry-instrumentation-sidekiq 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d779ad028fa986d96d8fedbb6581e7ad2063825be89ef787eea19619391ea146
-  data.tar.gz: 6164415d7a74c9b0434bda0c62884ccd44bdd84cdc6ea0cf91f4f38d51631b30
+  metadata.gz: 16931c87c910aace5d938407321eb6fc832d36b7436c2f8ac4721da5532bccea
+  data.tar.gz: da9d93ce6c105f7dcbb12a165dd0bc5a8fb9f8b73b2ed0362c7636c8e7aba0f1
 SHA512:
-  metadata.gz: 3591cffe3495f539bf38010579f91ee9b37489e5ea14b77d20dc0c173653c2eb25db14143ea47b2a0cd25e315296f67cad3d02469a91cb3eeefec0e969814c2a
-  data.tar.gz: a4c8b87b71de42f7588fcf947c4b27671060ba9046879ee4ba4be193b2ef10ea65bfec9374df6744f8d01e8d000306517a6774d5ebfbaf14bda376a8d3762bb9
+  metadata.gz: f6d91a5b9d207640e9a50d5f9770831c7b8c61d28d29da75de83d3de40ed8054029f1538947afddda8001bfa1ccd02fd202f5fab015818aee5c92c56983b5a93
+  data.tar.gz: 1f9b9e0de5512199abf9ad29335e510920583bbb5ec37e7fba26e34a3f992d6b9758b260acd2ad01219a211168306a475776761a7d6d5d66994483b7c6c090a5

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 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 

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

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

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

@@ -15,13 +15,7 @@ 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.inject(job)
@@ -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

@@ -16,13 +16,7 @@ module OpenTelemetry
               parent_context = OpenTelemetry.propagation.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'
-                },
+                attributes: build_attributes(msg),
                 with_parent: parent_context,
                 kind: :consumer
               ) do |span|
@@ -34,6 +28,18 @@ 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"

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.16.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.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-04-23 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.16.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        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
@@ -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.16.0/file.CHANGELOG.html
+  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.16.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.17.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