opentelemetry-instrumentation-active_job 0.7.4 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1891d4bd1469e53cf227e6dd45ce33af844c7d993fbde60564d25189f00ae614
-  data.tar.gz: 847dca4d8748a754c1afb83260dbad467a3b9efc2d9a758297441551ad659c68
+  metadata.gz: 89f474f0e98fb6f3481f608845f526887cae95e7c4b809ba10730b16ab7fe7f7
+  data.tar.gz: d5ae960715ee73afbc0d2fc6b899efdce4ce8bd4cb89f05392e09a37e2e58145
 SHA512:
-  metadata.gz: b2523337eb8e3bb71900cc056e1976c63bb80f9ba19155167bccf153a83db4964e29b373dc96805ed8594dbf367acb3dd459307ef940794e0ff4194335f66652
-  data.tar.gz: 17ccc797815874557a36b8a20af8caa26ce918f5ba6f007b0131fe3fa3c2c537f7d25459ec6b49b55b29b4370587505d04ad82f98f5ed0a844e918d1c326dcec
+  metadata.gz: a8e5f53d8c11594d339f749fd9e67b1dc8b298f180c5c9a0d2c0c4bed8b9e15fc5fcb649b59c94080cb58b810ba4c3780caf28bfd61eaed0f57928fce9e81c7e
+  data.tar.gz: 2e85cf90a1c65db191f45d614e03a0f3fe29065537f4401c0da1143860e32a0314174a90dfc1a40b1202b943a0a9c7b7131054eafdbb57db076cbf6beb944abb

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-active_job
 
+### v0.7.6 / 2024-08-15
+
+* FIXED: Prefix ::ActiveSupport when installing the instrumentation
+
+### v0.7.5 / 2024-08-15
+
+* FIXED: Use Active Support Lazy Load Hooks to avoid prematurely initializing ActiveRecord::Base and ActiveJob::Base
+
 ### v0.7.4 / 2024-07-30
 
 * FIXED: Honour dynamic changes in configuration

data/README.md

@@ -6,7 +6,7 @@ The OpenTelemetry Active Job gem is a community maintained instrumentation for [
 
 Install the gem using:
 
-```
+```console
 gem install opentelemetry-instrumentation-active_job
 ```
 
@@ -96,7 +96,7 @@ Example usage can be seen in the `./example/active_job.rb` file [here](https://g
 
 The `opentelemetry-instrumentation-active_job` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
 ## License
 
@@ -108,4 +108,5 @@ The `opentelemetry-instrumentation-active_job` gem is distributed under the Apac
 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
+[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

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

@@ -40,7 +40,10 @@ module OpenTelemetry
           # @param payload [Hash] containing job run information
           # @return [Hash] with the span and generated context tokens
           def start_span(name, _id, payload)
-            span = tracer.start_span(name, attributes: @mapper.call(payload))
+            job = payload.fetch(:job)
+            event_name = name.delete_suffix(".#{EVENT_NAMESPACE}")
+            span_name = span_name(job, event_name)
+            span = tracer.start_span(span_name, attributes: @mapper.call(payload))
             token = OpenTelemetry::Context.attach(OpenTelemetry::Trace.context_with_span(span))
 
             { span: span, ctx_token: token }
@@ -106,6 +109,18 @@ module OpenTelemetry
           def tracer
             OpenTelemetry::Instrumentation::ActiveJob::Instrumentation.instance.tracer
           end
+
+          private
+
+          def span_name(job, event_name)
+            prefix = if @config[:span_naming] == :job_class
+                       job.class.name
+                     else
+                       job.queue_name
+                     end
+
+            "#{prefix} #{event_name}"
+          end
         end
       end
     end

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

@@ -10,6 +10,8 @@ module OpenTelemetry
       module Handlers
         # Handles `enqueue.active_job` and `enqueue_at.active_job` to generate egress spans
         class Enqueue < Default
+          EVENT_NAME = 'publish'
+
           # Overrides the `Default#start_span` method to create an egress span
           # and registers it with the current context
           #
@@ -19,22 +21,11 @@ module OpenTelemetry
           # @return [Hash] with the span and generated context tokens
           def start_span(name, _id, payload)
             job = payload.fetch(:job)
-            span = tracer.start_span(span_name(job), kind: :producer, attributes: @mapper.call(payload))
+            span_name = span_name(job, EVENT_NAME)
+            span = tracer.start_span(span_name, kind: :producer, attributes: @mapper.call(payload))
             OpenTelemetry.propagation.inject(job.__otel_headers) # This must be transmitted over the wire
             { span: span, ctx_token: OpenTelemetry::Context.attach(OpenTelemetry::Trace.context_with_span(span)) }
           end
-
-          private
-
-          def span_name(job)
-            prefix = if @config[:span_naming] == :job_class
-                       job.class.name
-                     else
-                       job.queue_name
-                     end
-
-            "#{prefix} publish"
-          end
         end
       end
     end

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

@@ -10,6 +10,8 @@ module OpenTelemetry
       module Handlers
         # Handles perform.active_job to generate ingress spans
         class Perform < Default
+          EVENT_NAME = 'process'
+
           # Overrides the `Default#start_span` method to create an ingress span
           # and registers it with the current context
           #
@@ -19,10 +21,9 @@ module OpenTelemetry
           # @return [Hash] with the span and generated context tokens
           def start_span(name, _id, payload)
             job = payload.fetch(:job)
+            span_name = span_name(job, EVENT_NAME)
             parent_context = OpenTelemetry.propagation.extract(job.__otel_headers)
 
-            span_name = span_name(job)
-
             # TODO: Refactor into a propagation strategy
             propagation_style = @config[:propagation_style]
             if propagation_style == :child
@@ -48,18 +49,6 @@ module OpenTelemetry
 
             OpenTelemetry::Context.attach(internal_context)
           end
-
-          private
-
-          def span_name(job)
-            prefix = if @config[:span_naming] == :job_class
-                       job.class.name
-                     else
-                       job.queue_name
-                     end
-
-            "#{prefix} process"
-          end
         end
       end
     end

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

@@ -14,6 +14,8 @@ module OpenTelemetry
     module ActiveJob
       # Module that contains custom event handlers, which are used to generate spans per event
       module Handlers
+        EVENT_NAMESPACE = 'active_job'
+
         module_function
 
         # Subscribes Event Handlers to relevant ActiveJob notifications
@@ -57,7 +59,7 @@ module OpenTelemetry
           }
 
           @subscriptions = handlers_by_pattern.map do |key, handler|
-            ::ActiveSupport::Notifications.subscribe("#{key}.active_job", handler)
+            ::ActiveSupport::Notifications.subscribe("#{key}.#{EVENT_NAMESPACE}", handler)
           end
         end
 

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

@@ -63,14 +63,17 @@ module OpenTelemetry
         end
 
         def require_dependencies
+          require 'active_support/lazy_load_hooks'
           require_relative 'patches/base'
           require_relative 'handlers'
         end
 
         def patch_activejob
-          ::ActiveJob::Base.prepend(Patches::Base) unless ::ActiveJob::Base <= Patches::Base
-
           Handlers.subscribe
+
+          ::ActiveSupport.on_load(:active_job) do
+            ::ActiveJob::Base.prepend(Patches::Base) unless ::ActiveJob::Base <= Patches::Base
+          end
         end
       end
     end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActiveJob
-      VERSION = '0.7.4'
+      VERSION = '0.7.6'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-active_job
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.6
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-30 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -232,10 +232,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_job/0.7.4/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_job/0.7.6/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/active_job
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_job/0.7.4
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_job/0.7.6
 post_install_message: 
 rdoc_options: []
 require_paths: