opentelemetry-instrumentation-sidekiq 0.14.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: badc0143d061fc71fca09165039ddd95ba09ad4431eede006e5135f31a394ed2
-  data.tar.gz: 7f1dd7ba9d896bf57a27b4f27b0091b6e0a4ad212b0a758fb57818be2d127078
+  metadata.gz: a07180b8cf8e274f010b270dcd31129902ba821387750a47b3d85273dbb7138a
+  data.tar.gz: 2c62278ba1b6f870e23d20a860b5d18c79b9f250007e8842ba456b77c3e03aec
 SHA512:
-  metadata.gz: f7c39010f8e60d29c01b984bd5606899ea7acb001b9510d410fb8ca1a407853416227fd7d757e8d9bd7f3fbd2e51a9e8c1400c64edcec76a23947e478fdd0feb
-  data.tar.gz: 5cefbd36610b9e9da63f38e6feaf3beeeae7616c918f792163c363e1a907c2fb8ecf4b83674c2e4548cf2e59ac8bca5fc2057b9f4615b1a43167412c52a0055f
+  metadata.gz: cb7ff5f33f16783fd12ac40067c407d4bdce82e5c44b0700351b06b945a285457ef42a5bf51343a4ab9a788e0b78180832bc50aee7c55c930e212133760b70aa
+  data.tar.gz: 52ea34f638e98a2597a6ad33833dc97fe6ddf60b6636f72a2ba95c10a7549684aac2aae2d59107f3bad71f94a8dd284cac2e42aed42486beedd11d025872c541

data/CHANGELOG.md

@@ -1,16 +1,48 @@
 # Release History: opentelemetry-instrumentation-sidekiq
 
+### v0.19.0 / 2021-06-23
+
+* BREAKING CHANGE: Sidekiq propagation config 
+  - Config option enable_job_class_span_names renamed to span_naming and now expects a symbol of value :job_class, or :queue
+  - The default behaviour is no longer to have one continuous trace for the enqueue and process spans, using links is the new default.  To maintain the previous behaviour the config option propagation_style must be set to :child.
+* BREAKING CHANGE: Total order constraint on span.status= 
+
+* FIXED: Sidekiq propagation config 
+* FIXED: Total order constraint on span.status= 
+
+### 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 
+* BREAKING CHANGE: Replace getter and setter callables and remove rack specific propagators
 
-* ADDED: 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
 
@@ -18,7 +50,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
 
@@ -26,9 +58,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
 
@@ -36,9 +68,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,14 @@ module OpenTelemetry
           gem_version >= MINIMUM_VERSION
         end
 
+        option :span_naming,                 default: :queue, validate: ->(opt) { %I[job_class queue].include?(opt) }
+        option :propagation_style,           default: :link,  validate: ->(opt) { %i[link child none].include?(opt) }
+        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

@@ -12,18 +12,22 @@ module OpenTelemetry
           # TracerMiddleware propagates context and instruments Sidekiq client
           # by way of its middleware system
           class TracerMiddleware
-            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'
-                },
-                kind: :producer
-              ) do |span|
+            def call(_worker_class, job, _queue, _redis_pool) # rubocop:disable Metrics/AbcSize
+              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]
+
+              span_name = case config[:span_naming]
+                          when :job_class then "#{job['wrapped']&.to_s || job['class']} send"
+                          else "#{job['queue']} send"
+                          end
+
+              tracer.in_span(span_name, attributes: attributes, kind: :producer) do |span|
                 OpenTelemetry.propagation.inject(job)
                 span.add_event('created_at', timestamp: job['created_at'])
                 yield
@@ -32,14 +36,6 @@ 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

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

@@ -12,36 +12,51 @@ module OpenTelemetry
           # TracerMiddleware propagates context and instruments Sidekiq requests
           # by way of its middleware system
           class TracerMiddleware
-            def call(_worker, msg, _queue)
-              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'
-                },
-                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
-              end
-            end
+            def call(_worker, msg, _queue) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+              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]
 
-            private
+              span_name = case config[:span_naming]
+                          when :job_class then "#{msg['wrapped']&.to_s || msg['class']} process"
+                          else "#{msg['queue']} process"
+                          end
 
-            def span_name(msg)
-              if config[:enable_job_class_span_names]
-                "#{msg['wrapped']&.to_s || msg['class']} process"
-              else
-                "#{msg['queue']} process"
+              extracted_context = OpenTelemetry.propagation.extract(msg)
+              OpenTelemetry::Context.with_current(extracted_context) do
+                if 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'])
+                    yield
+                  end
+                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?
+                  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'])
+                    span.add_event('enqueued_at', timestamp: msg['enqueued_at'])
+                    yield
+                  rescue Exception => e # rubocop:disable Lint/RescueException
+                    span.record_exception(e)
+                    span.status = OpenTelemetry::Trace::Status.error("Unhandled exception of type: #{e.class}")
+                    raise e
+                  ensure
+                    span.finish
+                  end
+                end
               end
             end
 
+            private
+
             def config
               Sidekiq::Instrumentation.instance.config
             end

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.14.0'
+      VERSION = '0.19.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.19.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-03 00:00:00.000000000 Z
+date: 2021-06-24 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.14.0
+        version: 1.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
 - !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.14.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.19.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.14.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.19.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