opentelemetry-instrumentation-resque 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e6fb49eb3be763274583ec56559628984788f0ad375e9ea8e918e69e067ca69
-  data.tar.gz: dcf359e2db4a9f41db8d16143bc547c3fd7ff8269255d8d7648d74d1a22e7427
+  metadata.gz: bf90ba504c51858ede701a5517139e757090db7d7b5cad74e705af71c6d749b9
+  data.tar.gz: d1c6c0d56daa9c3d5f7460b9272a0a81a6cf87e7e2a48ac67f1f5b93a35e4b11
 SHA512:
-  metadata.gz: 3d8c6e47e905da28d8a3dd72a4e24809b6a56e4179dda1576ab92c31dc04b6cda3d3c568def04215a2d35e372275e9a0ddb4ca6eb858439bb8c9d6fac5e20284
-  data.tar.gz: a8a38299b1c33465e41683914eae9814ca68e26c34437ca411b894f4d270ff3d5f7db05f642cc81fddf1a4f68d59a98877401101f855440dddc00e32639468bc
+  metadata.gz: e54453118a9035506cbe4024057bcd04cc3d96e6b73df9fb555efaa5cd3a39d8f72287d3ab26bcc60dd9cda092bcbccb72a309edbb220a4b9a64bab429e55320
+  data.tar.gz: 36ba410d67292c72f743f4cc87527d8339f4f046cd55aea42601cb5bd4836351424b67ee72e73a92290297f5918687c241903cf377566231c399f5876d10fdbd

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-resque
 
+### v0.5.1 / 2024-02-08
+
+* DOCS: Relocate Resque config option comments to render in Yard docs
+
 ### v0.5.0 / 2023-09-07
 
 * FIXED: Align messaging instrumentation operation names

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

@@ -7,7 +7,61 @@
 module OpenTelemetry
   module Instrumentation
     module Resque
-      # The Instrumentation class contains logic to detect and install the Resque instrumentation
+      # The {OpenTelemetry::Instrumentation::Resque::Instrumentation} class contains logic to detect and install the Resque instrumentation
+      #
+      # Installation and configuration of this instrumentation is done within the
+      # {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry/SDK#configure-instance_method OpenTelemetry::SDK#configure}
+      # block, calling {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry%2FSDK%2FConfigurator:use use()}
+      # or {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry%2FSDK%2FConfigurator:use_all use_all()}.
+      #
+      # ## Configuration keys and options
+      #
+      # ### `:span_naming`
+      #
+      # Specifies how the span names are set. Can be one of:
+      #
+      # - `:queue` **(default)** - The job span name will appear as '<destination / queue name> <operation>',
+      #   for example `default process`.
+      # - `:job_class` - The job span name will appear as '<job class name> <operation>',
+      #   for example `SimpleJob process`.
+      #
+      # ### `:propagation_style`
+      #
+      # Specifies how the job's execution is traced and related to the trace where the job was enqueued.
+      #
+      # - `:link` **(default)** - The job will be represented by a separate trace from the span that enqueued the job.
+      #     - The initial span of the job trace will be associated with the span that enqueued the job, via a
+      #       {https://opentelemetry.io/docs/concepts/signals/traces/#span-links Span Link}.
+      # - `:child` - The job will be represented within the same logical trace, as a direct
+      #   child of the span that enqueued the job.
+      # - `:none` - The job will be represented by a separate trace from the span that enqueued the job.
+      #   There will be no explicit relationship between the job trace and the trace containing the span that
+      #   enqueued the job.
+      #
+      # ### `:force_flush`
+      #
+      # Specifies whether spans are forcibly flushed (exported out of process) upon every job completion.
+      #
+      #   - `:ask_the_job` **(default)** - Synchronously flush completed spans when a job completes if workers are
+      #     forked for each job.
+      #       - Determined by checking if {https://www.rubydoc.info/gems/resque/Resque%2FWorker:fork_per_job%3F Resque::Worker#fork_per_job?}
+      #         is true. Spans must be flushed and exported before a worker process terminates or no telemetry will be sent.
+      #   - `:always` - All completed spans will be synchronously flushed at the end of a job's execution.
+      #   - `:never` - Job completion will not affect the export of spans out of worker processes.
+      #       - Selecting this option will result in spans being lost if the worker process ends before
+      #         the spans are flushed. You might select this option if you wish to coordinate the timing for flushing
+      #         completed spans yourself.
+      #
+      # @example An explicit default configuration
+      #   OpenTelemetry::SDK.configure do |c|
+      #     c.use_all({
+      #       'OpenTelemetry::Instrumentation::Resque' => {
+      #         span_naming: :queue,
+      #         propagation_style: :link
+      #         force_flush: :ask_the_job,
+      #       },
+      #     })
+      #   end
       class Instrumentation < OpenTelemetry::Instrumentation::Base
         install do |_config|
           require_dependencies
@@ -18,30 +72,6 @@ module OpenTelemetry
           defined?(::Resque)
         end
 
-        ## 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]

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Resque
-      VERSION = '0.5.0'
+      VERSION = '0.5.1'
     end
   end
 end

data/lib/opentelemetry/instrumentation/resque.rb

@@ -9,7 +9,7 @@ require 'opentelemetry-instrumentation-base'
 
 module OpenTelemetry
   module Instrumentation
-    # Contains the OpenTelemetry instrumentation for the Resque gem
+    # (see OpenTelemetry::Instrumentation::Resque::Instrumentation)
     module Resque
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-resque
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-07 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -142,14 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.56.1
+        version: 1.60.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.56.1
+        version: 1.60.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: '3.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: '3.19'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -214,10 +228,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-resque/0.5.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-resque/0.5.1/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.5.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-resque/0.5.1
 post_install_message: 
 rdoc_options: []
 require_paths: