opentelemetry-instrumentation-que 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05301928e28e51d2dad8aa8fb1467eccf37202cd8cf4e19e2283553b9098906c'
-  data.tar.gz: 90681eedfca0e3a9cd460ad90e45ded12aee593fed5a0b65eb3b98ba2cc3e741
+  metadata.gz: 8c38bc717ae44997443d4fa9013147f40f9003cac7006fb7971660d8ff5f451d
+  data.tar.gz: d2343c6ff9279e7f1929cf3e7c1cc0a6998a97474745ddc5efb77676ff73c07e
 SHA512:
-  metadata.gz: eb9082dd3fc59fdb5242dcc16aedbb7662fb1f85dd912d12f662fddd0943d9256949da7681c269e2d799afe5d65878ba013a8f7735db037160744f44c94544f2
-  data.tar.gz: fe373cd0c5d51996331ba158d0f5b3f2d92ffd0a9f0fe421c120524e5614c63e1256b3ded34fb538451fc58a92bea04ecd5642fba94106c7b330e02eb0d352d7
+  metadata.gz: 2217e4afe351dd0acf6437bbe21e0d2fd0583f4b74f90e38fc0c9e1582a45443dadd98b57ad73ab05a4742bf2c46f94635b13abf131194fff2e4196e60ae82c4
+  data.tar.gz: 36d591016e58c7d7973b5f1c206e85962914134198a857e55873c27756086ff093ec73748187f4fbd8f012ba7de00af3f1a8d79d425e3af6465041ef5cc0536e

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History: opentelemetry-instrumentation-que
 
+### v0.5.1 / 2023-01-14
+
+* FIXED: Remove `job_options` when using `bulk_enqueue` 
+* DOCS: Fix gem homepage 
+* DOCS: More gem documentation fixes 
+
+### v0.5.0 / 2022-10-28
+
+* ADDED: Add support for `job_options` argument
+
 ### v0.4.0 / 2022-06-09
 
 * Upgrading Base dependency version

data/README.md

@@ -65,6 +65,28 @@ The `opentelemetry-instrumentation-que` gem source is [on github][repo-github],
 
 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].
 
+## Testing the gem locally
+
+To install test dependencies run:
+
+```
+bundle exec appraisal
+```
+
+To run tests on all appraised Que versions, run:
+
+```
+bundle exec appraisal rake test
+```
+
+To run tests with a specific Que version, run:
+
+```
+bundle exec appraisal [que-version] rake test
+```
+
+All appraised Que versions can be found in the [Appraisals][appraisal-file] file.
+
 ## License
 
 The `opentelemetry-instrumentation-que` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
@@ -72,7 +94,8 @@ The `opentelemetry-instrumentation-que` gem is distributed under the Apache 2.0
 [que-home]: https://github.com/que-rb/que
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
+[appraisal-file]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/que/Appraisals

data/lib/opentelemetry/instrumentation/que/instrumentation.rb

@@ -10,7 +10,7 @@ module OpenTelemetry
       # The Instrumentation class contains logic to detect and install the Que
       # instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
-        MINIMUM_VERSION = Gem::Version.new('1.0.0.beta4')
+        MINIMUM_VERSION = Gem::Version.new('1.2.0')
 
         install do |_|
           require_dependencies

data/lib/opentelemetry/instrumentation/que/middlewares/server_middleware.rb

@@ -10,7 +10,7 @@ module OpenTelemetry
       module Middlewares
         # Server middleware to trace Que jobs
         class ServerMiddleware
-          def self.call(job, &block) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          def self.call(job, &block) # rubocop:disable Metrics/MethodLength
             job_class = job_class(job)
             span_name = "#{job_class} process"
             attributes = attributes_before_job_completion(job, job_class)
@@ -74,9 +74,7 @@ module OpenTelemetry
           # tags is an array looking something like ["tag1", "traceparent:..."]
           def self.extract_context_from_tags(tags)
             # Convert tags into Hash (ignoring elements that cannot be converted)
-            tags_hash = Hash[
-              tags.map { |value| value.split(':', 2) }.select { |value| value.size == 2 }
-            ]
+            tags_hash = tags.map { |value| value.split(':', 2) }.select { |value| value.size == 2 }.to_h
             OpenTelemetry.propagation.extract(tags_hash)
           end
 

data/lib/opentelemetry/instrumentation/que/patches/que_job.rb

@@ -18,7 +18,7 @@ module OpenTelemetry
 
           # Module to prepend to Que singleton class
           module ClassMethods
-            def enqueue(*args, tags: nil, **arg_opts)
+            def enqueue(*args, job_options: {}, **arg_opts)
               tracer = Que::Instrumentation.instance.tracer
               otel_config = Que::Instrumentation.instance.config
 
@@ -37,31 +37,45 @@ module OpenTelemetry
                 # The second option (which we are using here) is to use tags.
                 # They also are not meant for tracing information but they are
                 # much safer to use than modifying the payload.
+                tags = job_options[:tags]
                 if otel_config[:propagation_style] != :none
                   tags ||= []
                   OpenTelemetry.propagation.inject(tags, setter: TagSetter)
                 end
 
-                job = super(*args, tags: tags, **arg_opts)
+                # In Que version 2.1.0 `bulk_enqueue` was introduced and in order
+                # for it to work, we must pass `job_options` to `bulk_enqueue` instead of enqueue.
+                if gem_version >= Gem::Version.new('2.1.0') && Thread.current[:que_jobs_to_bulk_insert]
+                  Thread.current[:que_jobs_to_bulk_insert][:job_options] = job_options.merge(tags: tags)
+                  job = super(*args, **arg_opts)
+                  job_attrs = Thread.current[:que_jobs_to_bulk_insert][:jobs_attrs].last
+                else
+                  job = super(*args, job_options: job_options.merge(tags: tags), **arg_opts)
+                  job_attrs = job.que_attrs
+                end
 
-                span.name = "#{job.que_attrs[:job_class]} send"
-                span.add_attributes(QueJob.job_attributes(job))
+                span.name = "#{job_attrs[:job_class]} send"
+                span.add_attributes(QueJob.job_attributes(job_attrs))
 
                 job
               end
             end
+
+            def gem_version
+              @gem_version ||= Gem.loaded_specs['que'].version
+            end
           end
 
-          def self.job_attributes(job)
+          def self.job_attributes(job_attrs)
             attributes = {
               'messaging.system' => 'que',
               'messaging.destination_kind' => 'queue',
               'messaging.operation' => 'send',
-              'messaging.destination' => job.que_attrs[:queue] || 'default',
-              'messaging.que.job_class' => job.que_attrs[:job_class],
-              'messaging.que.priority' => job.que_attrs[:priority] || 100
+              'messaging.destination' => job_attrs[:queue] || 'default',
+              'messaging.que.job_class' => job_attrs[:job_class],
+              'messaging.que.priority' => job_attrs[:priority] || 100
             }
-            attributes['messaging.message_id'] = job.que_attrs[:id] if job.que_attrs[:id]
+            attributes['messaging.message_id'] = job_attrs[:id] if job_attrs[:id]
             attributes
           end
         end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Que
-      VERSION = '0.4.0'
+      VERSION = '0.5.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-que
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2023-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -70,16 +70,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta4
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta4
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.41.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.41.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -254,14 +254,14 @@ files:
 - lib/opentelemetry/instrumentation/que/patches/que_job.rb
 - lib/opentelemetry/instrumentation/que/tag_setter.rb
 - lib/opentelemetry/instrumentation/que/version.rb
-homepage: https://github.com/open-telemetry/opentelemetry-ruby
+homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-que/v0.4.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/que
-  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-que/v0.4.0
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-que/0.5.1/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/que
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-que/0.5.1
 post_install_message: 
 rdoc_options: []
 require_paths: