opentelemetry-instrumentation-active_support 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b0004400d17e9923e785054261455afc8a606e90e2c94a6acd192a9962208c5
-  data.tar.gz: f9f9338abb36d19818ed07778bb9c991de6c440fb13c12c6f1bf422a291e08b2
+  metadata.gz: 21b7f28f097eb1e09ec11100267b5c37ea8b76d8cd059e25848ebb934280d464
+  data.tar.gz: 31c3e8851e7094bd5ffaecb9d21abfb82baa01b224d9ef46c410072b3dad3ca1
 SHA512:
-  metadata.gz: cbf35c5553ec4d8458a9e5a773d8306eaeb01167ea083e8231c29e8ab90f7658664ba1a2321d2c5cbe341a3a675369e6b0df3349d258618611ea9431b265d87d
-  data.tar.gz: 37754e32b995e39d6961151de6c97eff935a5af8c80b63dfefae8a4c758e3656a7f007978f7741c66a0625842817f79ad07f9e982f051ef7c1d07824a23c6cac
+  metadata.gz: 715e78cd7b732276f4ca04f19d1b772f65f1006dd73e98c2419ba29b7542fae794b1bf488130a1dd49b2b18f5edf3b187ad41cf4a500b50f6ade84281130db37
+  data.tar.gz: 49558e4d3ffd8f32b39896c8c3db45591cef670a4c5ab6f3dcdf300294a44194fa184472f3f556a9f70a3ae493c5ba839bd9ac1df552e11828f30e2f7ceef1c9

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-active_support
 
+## v0.12.1 / 2026-07-21
+
+- DOCS: Document active support payload options (#2437)
+
 ## v0.12.0 / 2026-04-28
 
 - BREAKING CHANGE: Min Rails 7.1 (enforced this time) (#2283)

data/README.md

@@ -40,6 +40,29 @@ end
 
 ```
 
+### Subscribe options
+
+The `subscribe` method accepts optional payload-related arguments:
+
+- **`notification_payload_transform`:** Custom `proc` used to extract span
+  attributes from the notification payload. The proc receives the notification
+  payload and must return a `Hash`. Use this to rename keys, extract nested
+  values, or perform any other custom logic.
+- **`disallowed_notification_payload_keys`:** Array of string notification
+  payload keys that should not be recorded as span attributes. Keys are matched
+  before the remaining payload keys are converted to strings.
+
+```ruby
+
+::OpenTelemetry::Instrumentation::ActiveSupport.subscribe(
+  tracer, # tracer
+  'bar.foo', # pattern
+  ->(payload) { payload.merge('tenant' => payload['account_id']) }, # notification_payload_transform
+  ['account_id'] # disallowed_notification_payload_keys
+)
+
+```
+
 ## Examples
 
 Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_support/example/trace_demonstration.rb)

data/lib/opentelemetry/instrumentation/active_support/span_subscriber.rb

@@ -14,6 +14,17 @@ module OpenTelemetry
       # The SpanSubscriber is a special ActiveSupport::Notification subscription
       # handler which turns notifications into generic spans, taking care to handle
       # context appropriately.
+      #
+      # @param tracer [OpenTelemetry::Trace::Tracer] tracer used to create spans
+      # @param pattern [String, Regexp] ActiveSupport notification pattern
+      # @param notification_payload_transform [Callable, nil] optional callable
+      #   that receives the notification payload and returns a Hash of span
+      #   attributes
+      # @param disallowed_notification_payload_keys [Array<String>, nil] notification
+      #   payload keys that should not be recorded as span attributes
+      # @param kind [Symbol, nil] span kind to use for generated spans
+      # @param span_name_formatter [Callable, nil] optional callable that receives
+      #   the notification name and returns the span name
 
       # A very hacky way to make sure that OpenTelemetry::Instrumentation::ActiveSupport::SpanSubscriber
       # gets invoked first

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActiveSupport
-      VERSION = '0.12.0'
+      VERSION = '0.12.1'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-active_support
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
@@ -44,10 +44,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_support/0.12.0/file/CHANGELOG.md
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-active_support/v0.12.0/instrumentation/active_support
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_support/0.12.1/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-active_support/v0.12.1/instrumentation/active_support
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_support/0.12.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_support/0.12.1
 rdoc_options: []
 require_paths:
 - lib
@@ -62,7 +62,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: ActiveSupport instrumentation for the OpenTelemetry framework
 test_files: []