opentelemetry-instrumentation-que 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 466587fdebdd0ec7c9668c9e64871fcf7e6120b1c6b47b1dc6d985dae75ae744
-  data.tar.gz: b1e022751aead1dd7480b1e524fe39c3ab7f9930a749687663534ebaef9faf3d
+  metadata.gz: 5392323c2303a1644ba3c4e353b9155be0dd908d1c8cc1e1a9b801d36edbc6ac
+  data.tar.gz: 6b1b6922673b2ff95857cb684721ed0317301eddda802ff8b5d3bf96ac9375b5
 SHA512:
-  metadata.gz: acb40f4c6d8fb89410083bc783884da586b7a783ac75efb5d4efb32c62705196877b40b5ef7920210c32dccc830192ab1fe0a55e4089a37216da23c24614460f
-  data.tar.gz: 2f80d9206c6f357c278ce00aba40faa355867f1c89fbad252110e4849d78a8f124d26e95e20d2f6b7fb21133340290d5614f6e79ba3f8271b11e541343c7c5ed
+  metadata.gz: 6d609d39a8cf2cac0b6f85f8016c5023b895d009fd467e3dd118ed888ad7ac3edcbf7bec4e7b358bf01cd0d0967a38a7646ba1040e3f988ddfddc24afff352f8
+  data.tar.gz: d52489659bfc05db4386ffdee5186f96bea66e549166971daa54a941fcbef820aff16bb463f66439b400d24ecdbafbb9a00f72e7aac55af4b092e640b40378ad

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-que
 
+### v0.2.0 / 2021-12-01
+
+* ADDED: Instrument Que poller 
+
 ### v0.1.1 / 2021-09-29
 
 * (No significant changes)

data/lib/opentelemetry/instrumentation/que/instrumentation.rb

@@ -39,12 +39,14 @@ module OpenTelemetry
         #     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.
+        # trace_poller: controls whether Que Poller is traced or not.
         #
         # Note that in all cases, we will store Que's Job ID as the
         # `messaging.message_id` attribute, so out-of-band correlation may
         # still be possible depending on your backend system.
         #
         option :propagation_style, default: :link, validate: ->(opt) { %i[link child none].include?(opt) }
+        option :trace_poller,      default: false, validate: :boolean
 
         private
 
@@ -52,6 +54,7 @@ module OpenTelemetry
           require_relative 'tag_setter'
           require_relative 'middlewares/server_middleware'
           require_relative 'patches/que_job'
+          require_relative 'patches/poller'
         end
 
         def gem_version
@@ -60,6 +63,7 @@ module OpenTelemetry
 
         def patch
           ::Que::Job.prepend(Patches::QueJob)
+          ::Que::Poller.prepend(Patches::Poller)
         end
       end
     end

data/lib/opentelemetry/instrumentation/que/patches/poller.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Que
+      module Patches
+        # Instrumentation for the Que::Poller module
+        module Poller
+          def poll(*args, **kwargs)
+            # Avoid tracing when should_poll? returns true. This is also used
+            # in Poller#poll to decide if the actual poll should be executed or
+            # not. Without this we would generate a lot of unnecessary spans.
+            return unless should_poll?
+
+            if Que::Instrumentation.instance.config[:trace_poller]
+              Que::Instrumentation.instance.tracer.in_span('Que::Poller#poll') { super(*args, **kwargs) }
+            else
+              OpenTelemetry::Common::Utilities.untraced { super(*args, **kwargs) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Que
-      VERSION = '0.1.1'
+      VERSION = '0.2.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-que
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2021-12-01 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.18.3
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.3
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.2
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -222,6 +236,7 @@ files:
 - lib/opentelemetry/instrumentation/que.rb
 - lib/opentelemetry/instrumentation/que/instrumentation.rb
 - lib/opentelemetry/instrumentation/que/middlewares/server_middleware.rb
+- lib/opentelemetry/instrumentation/que/patches/poller.rb
 - lib/opentelemetry/instrumentation/que/patches/que_job.rb
 - lib/opentelemetry/instrumentation/que/tag_setter.rb
 - lib/opentelemetry/instrumentation/que/version.rb
@@ -229,10 +244,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-que/v0.1.1/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-que/v0.2.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/que
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-que/v0.1.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-que/v0.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: