opentelemetry-instrumentation-sidekiq 0.25.0 → 0.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4821c5cb6ee46e964a0050c474d971356103b3db4b16475afee181fc54e30e2f
-  data.tar.gz: 917279144fe2883f62094ff2e968e5254879d8f07c201c0604a9f0ec82e4cc56
+  metadata.gz: c239c96790354d8c1e436b049ce3c4fde4b7c8e8f6054f1a80ce0c0424fbd3f7
+  data.tar.gz: 7cb6bfa66c3181ca764a394e20e237dca1b277e599f7f9d6081e7afb73f4e585
 SHA512:
-  metadata.gz: 89e5de5de2299788004e6ec4917751aa6d6c08092be69892fafe3d0b731a86dd72672e89149a590996288023bbf8dd2a57344313d8303849d3c9f7891dd79258
-  data.tar.gz: 6f2a81ac8712100dc5761a79b67021cc4247929f4fe8807d45c1e9b52e2d494e3191373898c2b9ea7bea1983cfe23fc3e4f2bc12a96d1e055743958569d67d95
+  metadata.gz: a438fb384e7bf524266dc89fc741f5911d839cbae1f28ac6300600f2bc53e1c495e0410fcba4a30868f67d8370dfef9e52fc7328cac554e9861ca8e36e97e9eb
+  data.tar.gz: 86bf2e0a3f7b691256720b98a100e430a662f314e0fd2872cc1fac3c41d8d0baaf6c5ddb513a56e7027e88f785a062165afc8ee54a67d6f3d190e463a537735c

data/.yardopts

@@ -2,6 +2,7 @@
 --title=OpenTelemetry Sidekiq Instrumentation
 --markup=markdown
 --main=README.md
+--tag=instrumentation_option_default:"Default"
 ./lib/opentelemetry/instrumentation/**/*.rb
 ./lib/opentelemetry/instrumentation.rb
 -

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-sidekiq
 
+### v0.25.1 / 2024-02-08
+
+* DOCS: ✏️ Sidekiq instrumentation options
+
 ### v0.25.0 / 2023-09-07
 
 * FIXED: Align messaging instrumentation operation names

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

@@ -27,13 +27,59 @@ module OpenTelemetry
           gem_version >= MINIMUM_VERSION
         end
 
+        # @!group Instrumentation Options
+        # @!macro
+        #   @!method $1
+        #   @instrumentation_option_default `:$2`
+        #   @!scope class
+        #
+        #   Specify how the span names are set. Can be one of:
+        #
+        #   - `:queue` - the span names will be set to '<destination / queue name> <operation>'.
+        #   - `:job_class` - the span names will be set to '<job class name> <operation>'.
         option :span_naming,                 default: :queue, validate: %I[job_class queue]
+        #   Controls how the job's execution is traced and related
+        #   to the trace where the job was enqueued. Can be one of:
+        #
+        #   - `:link` - 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 :propagation_style,           default: :link,  validate: %i[link child none]
+        # @!macro
+        #   @!method $1
+        #   @instrumentation_option_default `:$2`
+        #   @!scope class
+        #   Allows tracing Sidekiq::Launcher#heartbeat.
         option :trace_launcher_heartbeat,    default: false, validate: :boolean
+        # @!macro
+        #   @!method $1
+        #   @instrumentation_option_default $2
+        #   @!scope class
+        #   Allows tracing Sidekiq::Scheduled#enqueue.
         option :trace_poller_enqueue,        default: false, validate: :boolean
+        # @!macro
+        #   @!method $1
+        #   @instrumentation_option_default $2
+        #   @!scope class
+        #   Allows trasing Sidekiq::Scheduled#wait
         option :trace_poller_wait,           default: false, validate: :boolean
+        # @!macro
+        #   @!method $1
+        #   @instrumentation_option_default $2
+        #   @!scope class
+        #   Allows tracing Sidekiq::Processor#process_one.
         option :trace_processor_process_one, default: false, validate: :boolean
+        # @!macro
+        #   @!method $1
+        #   @instrumentation_option_default $2
+        #   @!scope class
+        #   Sets service name of the remote service.
         option :peer_service,                default: nil,   validate: :string
+        # @!endgroup
 
         private
 

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Sidekiq
-      VERSION = '0.25.0'
+      VERSION = '0.25.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.25.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
@@ -156,28 +156,42 @@ 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: sidekiq
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -231,10 +245,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/0.25.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/0.25.1/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/sidekiq
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/0.25.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/0.25.1
 post_install_message: 
 rdoc_options: []
 require_paths: