opentelemetry-instrumentation-active_job 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a04b76f7877cff9dfe855ad8c0700adc29e187ef1c7a3870836fc10970b5731a
-  data.tar.gz: d38d9c18d14fc4d5a1a0e9cee92bf39e8c59e95ec5379a031d121666a1fe3f7d
+  metadata.gz: c2e9236d8c64df8e2ea878722f318bdaf1e01089bc3e74f88cf304de94adba0b
+  data.tar.gz: ba1166e899d9c8ed206f32ba124f96a7cf74e6262cab75a1061d5e7985c38a3b
 SHA512:
-  metadata.gz: b394d81fe3d7f8e3f8204cb2ae2ed5b51dbfe7cbdd6d032af3dc1fc844e6d50cf3416858e1a330cd13ff56788b808382341728252d41b736db198d048e211cb0
-  data.tar.gz: d0e8e50b922c93da87d366e94010c291fc23318c9064d56a79203a0e499e9c6102ed29194049dee84234d15ce0078a3153c4d8202d8a75c24de7a1a2e113da67
+  metadata.gz: c759ce3906d212b3fe8aa052ba9b31ce7fd7c096bafb5802b5c379db8b7fcfcb18dd0c0ed26dd559dc96dd93eb6ad99b26e97fa7b3a22af57000a104f86ec04d
+  data.tar.gz: 341e276950ce03997a2626f83e8264f4b2f4dd2fc5ce4f76c1f676688c2559cb803c1370a1208f3c263e7a518a6c9793fb4435004937c6385654adb7c1b224fd

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History: opentelemetry-instrumentation-active_job
 
+## v0.13.0 / 2026-06-16
+
+- ADDED: Add spans for Continuation (#2361)
+- ADDED: Add step.active_job span handler for Continuation
+
 ## v0.12.0 / 2026-04-28
 
 - BREAKING CHANGE: Min Rails 7.1 (enforced this time) (#2283)

data/README.md

@@ -69,6 +69,7 @@ See the table below for details of what [Rails Framework Hook Events](https://gu
 | `perform.active_job` | :white_check_mark: | Creates an ingress span with kind `consumer` |
 | `retry_stopped.active_job` | :white_check_mark: | Creates and `internal` span with an `exception` event |
 | `discard.active_job` | :white_check_mark: | Creates and `internal` span with an `exception` event |
+| `step.active_job` | :white_check_mark: | Creates an `internal` span |
 
 ## Semantic Conventions
 
@@ -88,6 +89,13 @@ Attributes that are specific to this instrumentation are recorded under `messagi
 | `messaging.active_job.message.priority` | String | Present when set by the client from `ActiveJob#priority` |
 | `messaging.active_job.message.provider_job_id` | String | Present if the underlying adapter has backend specific message ids |
 
+For jobs including the `ActiveJob::Continuable` module, the following attributes are added to spans created for a `step`:
+
+| `messaging.active_job.step.name` | String | Step name |
+| `messaging.active_job.step.state` | String | Either `started` or `resumed` |
+| `messaging.active_job.step.result` | String | Static value set to `interrupted` if the job was interrupted |
+| `messaging.active_job.step.cursor` | String | The persisted value after calling `step.set!` or `step.advance!` |
+
 ## Differences between ActiveJob versions
 
 ### ActiveJob 6.1

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module ActiveJob
+      module Handlers
+        # Handles step.active_job to generate child spans for continuable job steps
+        class Step < Default
+          # Overrides the `Default#start_span` method to create a child span
+          # for a continuable job step
+          #
+          # @param name [String] of the Event
+          # @param id [String] of the event
+          # @param payload [Hash] containing job run information
+          # @return [Hash] with the span and generated context tokens
+          def start_span(name, _id, payload)
+            job = payload.fetch(:job)
+            job_name = job.class.name
+            step = payload.fetch(:step)
+            step_name = step.name.to_s
+
+            attributes = @mapper.call(payload).merge(
+              'messaging.active_job.step.name' => step_name,
+              'messaging.active_job.step.state' => step.resumed? ? 'resumed' : 'started'
+            )
+
+            span = tracer.start_span("#{step_name} #{job_name}", attributes: attributes)
+            token = OpenTelemetry::Context.attach(OpenTelemetry::Trace.context_with_span(span))
+
+            { span: span, ctx_token: token }
+          end
+
+          # Overrides the `Default#finish` method to record step-specific
+          # attributes before closing the span
+          #
+          # @param _name [String] of the Event (unused)
+          # @param _id [String] of the event (unused)
+          # @param payload [Hash] containing job run information
+          def finish(_name, _id, payload)
+            otel = payload.delete(:__otel)
+            span = otel&.fetch(:span)
+            token = otel&.fetch(:ctx_token)
+
+            step = payload.fetch(:step)
+            span&.set_attribute('messaging.active_job.step.result', 'interrupted') if payload[:interrupted]
+            span&.set_attribute('messaging.active_job.step.cursor', step.cursor.to_s) if step.cursor
+
+            # Continuation::Interrupt is control flow, not a real error — skip recording it
+            on_exception(payload[:error] || payload[:exception_object], span) unless payload[:interrupted]
+          rescue StandardError => e
+            OpenTelemetry.handle_error(exception: e)
+          ensure
+            finish_span(span, token)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ require_relative 'mappers/attribute'
 require_relative 'handlers/default'
 require_relative 'handlers/enqueue'
 require_relative 'handlers/perform'
+require_relative 'handlers/step'
 
 module OpenTelemetry
   module Instrumentation
@@ -27,6 +28,7 @@ module OpenTelemetry
         # - perform
         # - retry_stopped
         # - discard
+        # - step (Continuations, Rails 8.1+)
         #
         # Ingress and Egress spans (perform, enqueue, enqueue_at) use Messaging semantic conventions for naming the span,
         # while internal spans keep their ActiveSupport event name.
@@ -48,6 +50,7 @@ module OpenTelemetry
           default_handler = Handlers::Default.new(parent_span_provider, mapper, config)
           enqueue_handler = Handlers::Enqueue.new(parent_span_provider, mapper, config)
           perform_handler = Handlers::Perform.new(parent_span_provider, mapper, config)
+          step_handler = Handlers::Step.new(parent_span_provider, mapper, config)
 
           handlers_by_pattern = {
             'enqueue' => enqueue_handler,
@@ -55,7 +58,8 @@ module OpenTelemetry
             'enqueue_retry' => default_handler,
             'perform' => perform_handler,
             'retry_stopped' => default_handler,
-            'discard' => default_handler
+            'discard' => default_handler,
+            'step' => step_handler
           }
 
           @subscriptions = handlers_by_pattern.map do |key, handler|

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActiveJob
-      VERSION = '0.12.0'
+      VERSION = '0.13.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-active_job
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
@@ -41,6 +41,7 @@ files:
 - lib/opentelemetry/instrumentation/active_job/handlers/default.rb
 - lib/opentelemetry/instrumentation/active_job/handlers/enqueue.rb
 - lib/opentelemetry/instrumentation/active_job/handlers/perform.rb
+- lib/opentelemetry/instrumentation/active_job/handlers/step.rb
 - lib/opentelemetry/instrumentation/active_job/instrumentation.rb
 - lib/opentelemetry/instrumentation/active_job/mappers/attribute.rb
 - lib/opentelemetry/instrumentation/active_job/patches/base.rb
@@ -49,10 +50,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.12.0/file/CHANGELOG.md
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-active_job/v0.12.0/instrumentation/active_job
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_job/0.13.0/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-active_job/v0.13.0/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.12.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_job/0.13.0
 rdoc_options: []
 require_paths:
 - lib
@@ -67,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: ActiveJob instrumentation for the OpenTelemetry framework
 test_files: []