opentelemetry-instrumentation-active_job 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc9b9452d0e3226d8180f46352d3b6fc0b7a9699744ade54f14cecf5d51e5890
-  data.tar.gz: '0787cee88e6161a88ed9fd99ec63e7386e396d3d0b48b0e716fdd397ade06c05'
+  metadata.gz: cf28c56776d6925a23e7a0dd65162cc217c7e5fd4e591b471cd77912241d5f89
+  data.tar.gz: 728c70ce03a1d03f28242dabcee397ce7bd7186f05fd747cd2e3451f6fdc7ab4
 SHA512:
-  metadata.gz: fb3d5ebd49519ea415b38a9704d7323f3213f54e70fff274656c6c325fcc212d26cc494960555d73854067ec0ee3c66850c8a023156a0b166b1fe71b246f17b4
-  data.tar.gz: 937f04c1f63a3fa6d819c330cf046ce1700433590859a88647c02c1ca83f5e391e84aadbae4e3b51df905d706f0a270dfbddee7c20113ecbb37c054d777ab681
+  metadata.gz: 35f01f133c73ff36562554d783b890c928f81e24256dbd4c9d91a4b024f4dff4e07e8a853b888d1542aa444f0505774d618b671462d598ab0e19f34169de4ae5
+  data.tar.gz: 9e23409ef225df507335da04b877bb9e82cb3d13569687577ca2f7e1d6e856f26278054740762d521a9e311228364d86a4b6351b740524424afe3c00fc0016d7

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Release History: opentelemetry-instrumentation-active_job
 
+### v0.2.0 / 2022-05-02
+
+* ADDED: Validate Using Enums 
+* ADDED: Make the context available in ActiveJob notifications 
+* FIXED: Fix deserialization of jobs that are missing metadata 
+* FIXED: RubyGems Fallback 
+
+### v0.1.5 / 2021-12-02
+
+* (No significant changes)
+
+### v0.1.4 / 2021-09-29
+
+* (No significant changes)
+
 ### v0.1.3 / 2021-08-12
 
 * (No significant changes)

data/lib/opentelemetry/instrumentation/active_job/instrumentation.rb

@@ -21,7 +21,7 @@ module OpenTelemetry
         end
 
         compatible do
-          Gem.loaded_specs['activejob'].version >= MINIMUM_VERSION
+          gem_version >= MINIMUM_VERSION
         end
 
         ## Supported configuration keys for the install config hash:
@@ -52,12 +52,16 @@ module OpenTelemetry
         # spans will always be children of the enqueueing spans. This is due to the way
         # ActiveJob immediately executes jobs during the process of "enqueueing" jobs when
         # using the `:inline` adapter.
-        option :propagation_style, default: :link, validate: ->(opt) { %i[link child none].include?(opt) }
+        option :propagation_style, default: :link, validate: %i[link child none]
         option :force_flush, default: false, validate: :boolean
-        option :span_naming, default: :queue, validate: ->(opt) { %i[job_class queue].include?(opt) }
+        option :span_naming, default: :queue, validate: %i[job_class queue]
 
         private
 
+        def gem_version
+          ::ActiveJob.version
+        end
+
         def require_dependencies
           require_relative 'patches/base'
           require_relative 'patches/active_job_callbacks'

data/lib/opentelemetry/instrumentation/active_job/patches/active_job_callbacks.rb

@@ -10,8 +10,8 @@ module OpenTelemetry
       module Patches
         # Module to prepend to ActiveJob::Base for instrumentation.
         module ActiveJobCallbacks
-          def self.prepended(base) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-            base.class_eval do # rubocop:disable Metrics/BlockLength
+          def self.prepended(base)
+            base.class_eval do
               around_enqueue do |job, block|
                 span_kind = job.class.queue_adapter_name == 'inline' ? :client : :producer
                 span_name = "#{otel_config[:span_naming] == :job_class ? job.class : job.queue_name} send"
@@ -21,45 +21,46 @@ module OpenTelemetry
                   block.call
                 end
               end
+            end
+          end
 
-              around_perform do |job, block| # rubocop:disable Metrics/BlockLength
-                span_kind = job.class.queue_adapter_name == 'inline' ? :server : :consumer
-                span_name = "#{otel_config[:span_naming] == :job_class ? job.class : job.queue_name} process"
-                span_attributes = job_attributes(job).merge('messaging.operation' => 'process')
+          def perform_now # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+            span_kind = self.class.queue_adapter_name == 'inline' ? :server : :consumer
+            span_name = "#{otel_config[:span_naming] == :job_class ? self.class : queue_name} process"
+            span_attributes = job_attributes(self).merge('messaging.operation' => 'process')
+            executions_count = (executions || 0) + 1 # because we run before the count is incremented in ActiveJob::Execution
 
-                extracted_context = OpenTelemetry.propagation.extract(job.metadata)
-                OpenTelemetry::Context.with_current(extracted_context) do
-                  if otel_config[:propagation_style] == :child
-                    otel_tracer.in_span(span_name, attributes: span_attributes, kind: span_kind) do |span|
-                      span.set_attribute('messaging.active_job.executions', job.executions)
-                      block.call
-                    end
-                  else
-                    span_links = []
-                    if otel_config[:propagation_style] == :link
-                      span_context = OpenTelemetry::Trace.current_span(extracted_context).context
-                      span_links << OpenTelemetry::Trace::Link.new(span_context) if span_context.valid?
-                    end
+            extracted_context = OpenTelemetry.propagation.extract(metadata)
+            OpenTelemetry::Context.with_current(extracted_context) do
+              if otel_config[:propagation_style] == :child
+                otel_tracer.in_span(span_name, attributes: span_attributes, kind: span_kind) do |span|
+                  span.set_attribute('messaging.active_job.executions', executions_count)
+                  super
+                end
+              else
+                span_links = []
+                if otel_config[:propagation_style] == :link
+                  span_context = OpenTelemetry::Trace.current_span(extracted_context).context
+                  span_links << OpenTelemetry::Trace::Link.new(span_context) if span_context.valid?
+                end
 
-                    root_span = otel_tracer.start_root_span(span_name, attributes: span_attributes, links: span_links, kind: span_kind)
-                    OpenTelemetry::Trace.with_span(root_span) do |span|
-                      span.set_attribute('messaging.active_job.executions', job.executions)
-                      block.call
-                    rescue Exception => e # rubocop:disable Lint/RescueException
-                      span.record_exception(e)
-                      span.status = OpenTelemetry::Trace::Status.error("Unhandled exception of type: #{e.class}")
-                      raise e
-                    ensure
-                      root_span.finish
-                    end
-                  end
+                root_span = otel_tracer.start_root_span(span_name, attributes: span_attributes, links: span_links, kind: span_kind)
+                OpenTelemetry::Trace.with_span(root_span) do |span|
+                  span.set_attribute('messaging.active_job.executions', executions_count)
+                  super
+                rescue Exception => e # rubocop:disable Lint/RescueException
+                  span.record_exception(e)
+                  span.status = OpenTelemetry::Trace::Status.error("Unhandled exception of type: #{e.class}")
+                  raise e
+                ensure
+                  root_span.finish
                 end
-              ensure
-                # We may be in a job system (eg: resque) that forks and kills worker processes often.
-                # We don't want to lose spans by not flushing any span processors, so we optionally force it here.
-                OpenTelemetry.tracer_provider.force_flush if otel_config[:force_flush]
               end
             end
+          ensure
+            # We may be in a job system (eg: resque) that forks and kills worker processes often.
+            # We don't want to lose spans by not flushing any span processors, so we optionally force it here.
+            OpenTelemetry.tracer_provider.force_flush if otel_config[:force_flush]
           end
 
           private

data/lib/opentelemetry/instrumentation/active_job/patches/base.rb

@@ -27,7 +27,7 @@ module OpenTelemetry
           end
 
           def deserialize(job_data)
-            self.metadata = (deserialize_arguments(job_data['metadata']) || []).to_h
+            self.metadata = deserialize_arguments(job_data['metadata'] || []).to_h
             super
           end
         end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActiveJob
-      VERSION = '0.1.3'
+      VERSION = '0.2.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-active_job
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +98,16 @@ dependencies:
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -228,10 +228,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-active_job/v0.1.3/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-active_job/v0.2.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/active_job
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-active_job/v0.1.3
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-active_job/v0.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: