opentelemetry-instrumentation-que 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1c00a2cbeefbed1f471d57a3c8064f455f2071372aa4b9214139c34bab86055
-  data.tar.gz: faafdea99b51729f502c44197e94f181a7958cc19d5b6131c94824f37f2cc1ff
+  metadata.gz: 3c1bf2b83d06c852eb0b413c4ee7436c914c9d85eb645e9e41abd14b74979634
+  data.tar.gz: a78cdb0937c00ca29015c686de0e1103c21b5336249860b62af63a6548a0e91e
 SHA512:
-  metadata.gz: 913508f316cdb100a7aaa0fc989b31c80db02ae5a280686ba4ac13d7efbd9a0b31b76ec8e797cd2f5e7a324dee5dde054b321b5b490c8a5971503e56b697af2f
-  data.tar.gz: 125d0286409db71f66c68ab8240808865ed07909104779baa8d31bae158abc1e61ec99a94fec92eb5d19572b76b55953d49eba536c555f995d052356b5be4627
+  metadata.gz: 98c0e7d9c79363cec480e256bd8a2a6efb2aa7f0121ba9fce25ad27c8b9710479e5c8e532b423a7782f7da377d4ed72dd8fc550896b1bc031cdc27f76a232e2f
+  data.tar.gz: 67cc2f7e5d211062e5a1c695ebb241ca362155888626a1261e9119dd113064d2afab64ad4694d96d0f9c663169b75f85dcac2aa78c7f6830b1bd40ffe24b5dea

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Release History: opentelemetry-instrumentation-que
 
+### v0.6.0 / 2023-04-17
+
+* BREAKING CHANGE: Drop support for EoL Ruby 2.7 
+
+* ADDED: Drop support for EoL Ruby 2.7 
+* FIXED: Drop Rails dependency for ActiveSupport Instrumentation 
+
+### 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

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.
@@ -76,3 +98,4 @@ The `opentelemetry-instrumentation-que` gem is distributed under the Apache 2.0
 [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/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/MethodLength
+          def self.call(job, &block)
             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

@@ -43,27 +43,39 @@ module OpenTelemetry
                   OpenTelemetry.propagation.inject(tags, setter: TagSetter)
                 end
 
-                job_options = job_options.merge(tags: tags)
-                job = super(*args, job_options: job_options, **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.5.0'
+      VERSION = '0.6.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-que
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-28 00:00:00.000000000 Z
+date: 2023-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -126,16 +126,16 @@ dependencies:
   name: opentelemetry-test-helpers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.48.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.48.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-contrib
+homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-que/v0.5.0/file.CHANGELOG.html
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-que/0.6.0/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://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-que/v0.5.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-que/0.6.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -270,14 +270,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Que instrumentation for the OpenTelemetry framework