opentelemetry-instrumentation-resque 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97330a63e02e03814520d6a664ae17db7d77e1d6a6c55099711da2034f872423
-  data.tar.gz: 86c92282316dece9f34040720c88d18573872012e3693f60ed131ebdd35cb697
+  metadata.gz: 3de68fbde8d85fe64048f623302ca558d1b7f9d40055423ad78ad98de1b78fa6
+  data.tar.gz: ead9715d8295efe47c3c76dc45be70af570f0551f3dcdcc1b8b09b096829fa6d
 SHA512:
-  metadata.gz: d2b77162dcbd2874d32b5f74f1ce0cb78d5a370662585e73ca9af586f7b2d3ab475858f442ef162f785d98c2fb1dc87b35f82b05f389a862a25954473085702b
-  data.tar.gz: 375c7d171a1e37f21532f5d398df97ad7183862ddfa8c5121c27eecf90c20ad3932ef890f87dbdc5739153beaf141cecfec6b9566c427175a502a3685ab240e5
+  metadata.gz: ea3ba0e44b285739855a0853db2ee6cd8599ed58a3a591ad9922e04f5b0620c9741d774328852bf95b8727f0f42fa71aa9ebe22d04b983102b0b32a6daebde0b
+  data.tar.gz: a54a7f5c1e2b5b9d78242a2e13f0a21ade43c387f61e395a5da3464afc8927978a036c9856c8a6c951d7264048d22dd01a1fb5655ee95b5027464a9acd3c92fa

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Release History: opentelemetry-instrumentation-resque
 
+### v0.4.0 / 2023-04-17
+
+* BREAKING CHANGE: Drop support for EoL Ruby 2.7 
+
+* ADDED: Drop support for EoL Ruby 2.7 
+* ADDED: Add :force_flush option to Resque instrumentation 
+* FIXED: Fix flaky tests for resque. 
+
+### v0.3.1 / 2023-01-14
+
+* DOCS: Fix gem homepage 
+* DOCS: More gem documentation fixes 
+
 ### v0.3.0 / 2022-06-09
 
 * Upgrading Base dependency version

data/README.md

@@ -32,7 +32,7 @@ end
 
 ## Examples
 
-Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/instrumentation/resque/example/trace_demonstration.rb)
+Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/resque/example/trace_demonstration.rb)
 
 ## How can I get involved?
 
@@ -47,7 +47,7 @@ The `opentelemetry-instrumentation-resque` gem is distributed under the Apache 2
 [resque-home]: https://github.com/resque/resque
 [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

data/lib/opentelemetry/instrumentation/resque/instrumentation.rb

@@ -18,8 +18,33 @@ module OpenTelemetry
           defined?(::Resque)
         end
 
-        option :span_naming,       default: :queue, validate: %I[job_class queue]
-        option :propagation_style, default: :link,  validate: %i[link child none]
+        ## Supported configuration keys for the install config hash:
+        #
+        # force_flush: controls if spans are forcibly flushed upon job completion
+        #   - :ask_the_job (default) - if `Resque::Worker#fork_per_job?` is set,
+        #     all completed spans will be synchronously flushed at the end of a
+        #     job's execution
+        #   - :always - all completed spans will be synchronously flushed at the
+        #     end of a job's execution
+        #   - :never - the job will not intervene with the processing of spans
+        #
+        # span_naming: when `:job_class`, the span names will be set to
+        #   '<job class name> <operation>'. When `:queue`, the span names
+        #   will be set to '<destination / queue name> <operation>'
+        #
+        # propagation_style: controls how the job's execution is traced and related
+        #   to the trace where the job was enqueued. Can be one of:
+        #   - :link (default) - the job will be executed in a separate trace. The
+        #     initial span of the execution trace will be linked to the span that
+        #     enqueued the job, via a Span Link.
+        #   - :child - the job will be executed in the same logical trace, as a direct
+        #     child of the span that enqueued the job.
+        #   - :none - the job's execution will not be explicitly linked to the span that
+        #     enqueued the job.
+
+        option :force_flush,       default: :ask_the_job, validate: %I[ask_the_job always never]
+        option :span_naming,       default: :queue,       validate: %I[job_class queue]
+        option :propagation_style, default: :link,        validate: %i[link child none]
 
         private
 

data/lib/opentelemetry/instrumentation/resque/patches/resque_job.rb

@@ -10,12 +10,12 @@ module OpenTelemetry
       module Patches
         # Module to prepend to Resque::Job for instrumentation
         module ResqueJob
-          def perform # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          def perform # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
             job_args = args || []
 
             # Check if the job is being wrapped by ActiveJob
             # before retrieving the job class name
-            job_class = if payload_class_name == 'ActiveJob::QueueAdapters::ResqueAdapter::JobWrapper' && job_args[0]&.is_a?(Hash)
+            job_class = if payload_class_name == 'ActiveJob::QueueAdapters::ResqueAdapter::JobWrapper' && job_args[0].is_a?(Hash)
                           job_args[0]['job_class']
                         else
                           payload_class_name
@@ -54,6 +54,11 @@ module OpenTelemetry
                 end
               end
             end
+          ensure
+            if (config[:force_flush] == :ask_the_job && worker&.fork_per_job?) ||
+               config[:force_flush] == :always
+              OpenTelemetry.tracer_provider.force_flush
+            end
           end
 
           private

data/lib/opentelemetry/instrumentation/resque/patches/resque_module.rb

@@ -21,7 +21,7 @@ module OpenTelemetry
             def push(queue, item)
               # Check if the job is being wrapped by ActiveJob
               # before retrieving the job class name
-              job_class = if item[:class] == 'ActiveJob::QueueAdapters::ResqueAdapter::JobWrapper' && item[:args][0]&.is_a?(Hash)
+              job_class = if item[:class] == 'ActiveJob::QueueAdapters::ResqueAdapter::JobWrapper' && item[:args][0].is_a?(Hash)
                             item[:args][0]['job_class']
                           else
                             item[:class]

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Resque
-      VERSION = '0.3.0'
+      VERSION = '0.4.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-resque
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-09 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: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,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
@@ -98,30 +98,30 @@ 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: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.48.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.48.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -224,14 +224,14 @@ files:
 - lib/opentelemetry/instrumentation/resque/patches/resque_job.rb
 - lib/opentelemetry/instrumentation/resque/patches/resque_module.rb
 - lib/opentelemetry/instrumentation/resque/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-resque/v0.3.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/resque
-  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-resque/v0.3.0
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-resque/0.4.0/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/resque
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-resque/0.4.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -240,14 +240,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: Resque instrumentation for the OpenTelemetry framework