opentelemetry-instrumentation-sidekiq 0.25.0 → 0.25.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4821c5cb6ee46e964a0050c474d971356103b3db4b16475afee181fc54e30e2f
-  data.tar.gz: 917279144fe2883f62094ff2e968e5254879d8f07c201c0604a9f0ec82e4cc56
+  metadata.gz: 643b9d07b7c13baf54e233a7632a9ed5d48bef886f348b98c28861bd0c750283
+  data.tar.gz: 285b0d852bb7d5fd09a71ab1eedc1ca07fe0a4079d780718c61c078489106786
 SHA512:
-  metadata.gz: 89e5de5de2299788004e6ec4917751aa6d6c08092be69892fafe3d0b731a86dd72672e89149a590996288023bbf8dd2a57344313d8303849d3c9f7891dd79258
-  data.tar.gz: 6f2a81ac8712100dc5761a79b67021cc4247929f4fe8807d45c1e9b52e2d494e3191373898c2b9ea7bea1983cfe23fc3e4f2bc12a96d1e055743958569d67d95
+  metadata.gz: 60978f2e9a2921e131ceda564fc3aea92b218964fb7f44b9626cd3b28143341bdc73c75077a03039acfcbd303327aaf4e3f353c92bb10bb5024f2c293eeaa8fb
+  data.tar.gz: 5834c8414812a44ff6680f54914aaad6e4cd917f996280c50b9eb293c5516023fb0a9289d931496de01ae79b25d0d38de69070bd5795c9f7aee86b76bde3399b

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,13 @@
 # Release History: opentelemetry-instrumentation-sidekiq
 
+### v0.25.2 / 2024-02-08
+
+* DOCS: Fix doc for sidekiq options.
+
+### 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

@@ -7,8 +7,81 @@
 module OpenTelemetry
   module Instrumentation
     module Sidekiq
-      # The Instrumentation class contains logic to detect and install the Sidekiq
-      # instrumentation
+      # The `OpenTelemetry::Instrumentation::Sidekiq::Instrumentation` class contains logic to detect and install the Sidekiq 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.
+      #
+      # ### `:trace_launcher_heartbeat`
+      #
+      # Allows tracing Sidekiq::Launcher#heartbeat.
+      #
+      # - `false` **(default)** - Sidekiq::Launcher#heartbeat will not be traced.
+      # - `true` - Sidekiq::Launcher#heartbeat will be traced.
+      #
+      # ### `:trace_poller_enqueue`
+      #
+      # Allows tracing Sidekiq::Scheduled#enqueue.
+      #
+      # - `false` **(default)** - Sidekiq::Scheduled#enqueue will not be traced.
+      # - `true` - Sidekiq::Scheduled#enqueue will be traced.
+      #
+      # ### `:trace_poller_wait`
+      #
+      # Allows tracing Sidekiq::Scheduled#wait.
+      #
+      # - `false` **(default)** - Sidekiq::Scheduled#wait will not be traced.
+      # - `true` - Sidekiq::Scheduled#wait will be traced.
+      #
+      # ### `:trace_processor_process_one`
+      #
+      # Allows tracing Sidekiq::Processor#process_one.
+      #
+      # - `false` **(default)** - Sidekiq::Processor#process_one will not be traced.
+      # - `true` - Sidekiq::Processor#process_one will be traced.
+      #
+      # ### `:peer_service`
+      #
+      # Sets service name of the remote service.
+      #
+      # - `nil` **(default)**
+      #
+      # @example An explicit default configuration
+      #   OpenTelemetry::SDK.configure do |c|
+      #     c.use_all({
+      #       'OpenTelemetry::Instrumentation::Sidekiq' => {
+      #         span_naming: :queue,
+      #         propagation_style: :link,
+      #         trace_launcher_heartbeat: true,
+      #       },
+      #     })
+      #   end
       class Instrumentation < OpenTelemetry::Instrumentation::Base
         MINIMUM_VERSION = Gem::Version.new('4.2.10')
 

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

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

data/lib/opentelemetry/instrumentation/sidekiq.rb

@@ -9,7 +9,7 @@ require 'opentelemetry-instrumentation-base'
 
 module OpenTelemetry
   module Instrumentation
-    # Contains the OpenTelemetry instrumentation for the Sidekiq gem
+    # (see {OpenTelemetry::Instrumentation::Sidekiq::Instrumentation})
     module Sidekiq
     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.2
 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.2/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.2
 post_install_message: 
 rdoc_options: []
 require_paths: