opentelemetry-instrumentation-sidekiq 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4405583412d46b76cbc7f66b507f931946fdc4555b7ab571760efe72a185b341
-  data.tar.gz: 63c257bf5c9f033fc3b336fb4acb90ac61ddae10637bade6bc6c48cd08cb2011
+  metadata.gz: a07180b8cf8e274f010b270dcd31129902ba821387750a47b3d85273dbb7138a
+  data.tar.gz: 2c62278ba1b6f870e23d20a860b5d18c79b9f250007e8842ba456b77c3e03aec
 SHA512:
-  metadata.gz: 5fc041aa4d97dd1c19170ef17aa39ff141debd9a1c38d750862c77eda880cc643a5dea481bccaf8e82d96d8555d2ad027e7bf36c92fb5ef90b8c867fcc5eddfe
-  data.tar.gz: 9df46a9b2777fed4ee8b857a0313db47ce87b524ddbe3217547d1465650d8e3b3d95e95d9ff50ee1d8c25cec6f3b1025e261a97ecacf0f787189e311899b8591
+  metadata.gz: cb7ff5f33f16783fd12ac40067c407d4bdce82e5c44b0700351b06b945a285457ef42a5bf51343a4ab9a788e0b78180832bc50aee7c55c930e212133760b70aa
+  data.tar.gz: 52ea34f638e98a2597a6ad33833dc97fe6ddf60b6636f72a2ba95c10a7549684aac2aae2d59107f3bad71f94a8dd284cac2e42aed42486beedd11d025872c541

data/CHANGELOG.md

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

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

@@ -27,7 +27,8 @@ module OpenTelemetry
           gem_version >= MINIMUM_VERSION
         end
 
-        option :enable_job_class_span_names, default: false, validate: :boolean
+        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

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

@@ -12,21 +12,7 @@ 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: build_attributes(job),
-                kind: :producer
-              ) do |span|
-                OpenTelemetry.propagation.inject(job)
-                span.add_event('created_at', timestamp: job['created_at'])
-                yield
-              end
-            end
-
-            private
-
-            def build_attributes(job)
+            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'],
@@ -35,17 +21,21 @@ module OpenTelemetry
                 '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"
+              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
               end
             end
 
+            private
+
             def config
               Sidekiq::Instrumentation.instance.config
             end

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

@@ -12,24 +12,7 @@ module OpenTelemetry
           # TracerMiddleware propagates context and instruments Sidekiq requests
           # by way of its middleware system
           class TracerMiddleware
-            def call(_worker, msg, _queue)
-              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)
+            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'],
@@ -38,17 +21,42 @@ module OpenTelemetry
                 '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"
+              span_name = case config[:span_naming]
+                          when :job_class then "#{msg['wrapped']&.to_s || msg['class']} process"
+                          else "#{msg['queue']} process"
+                          end
+
+              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/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Sidekiq
-      VERSION = '0.18.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.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.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.0
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -203,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.18.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.18.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-sidekiq/v0.19.0
 post_install_message: 
 rdoc_options: []
 require_paths: