opentelemetry-instrumentation-action_pack 0.12.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d469bead142d9682483795b636de7c9d46fc8d410651f3409ab8e106a9d28f48
-  data.tar.gz: 3e5fbfaa2a26ea52fa01f58077f8420e92b4a7a3561a4b6547ecbeecfcea07c7
+  metadata.gz: a2e35cfc783e7301603c7b5189e07c08e127cb755d1a6f77daa7988a7bb6542d
+  data.tar.gz: 3157efc05752b466b84d43972fa18864b40e8e7d9dab289a316d8bd21d602206
 SHA512:
-  metadata.gz: 98b81892126505b05311b3ca67feb6e530e7543742fa36895e301312e737ed8e5804f8c840aaf8e743ac29e00cec79d81be9908313888311f958225ba7a38d65
-  data.tar.gz: 1207dcac466eb75ba81f1b2ce75e8be3136f26d22e997fdb4acace9b84fbadba18aac959f181f29c8a2a0b091a9e9c7b5a3c2e37d86ec108080391c888bd8266
+  metadata.gz: 9857686cc8650d91d023e212fa85118ab40cc885d823ebd401516ab8db1216cdd47ea3b2e28199dfebb89e54268264dedf5710d9cb5afea1dc0205c41ee3f0a8
+  data.tar.gz: 424a3b7dd8d9a4df5aa72f6d89a4c4b4e036c0159964b37b217bd451b55b7652312853cd1244fc24a0c9dfa248befd57064765078b33cb8b45622ae7275c3fb6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-action_pack
 
+### v0.13.0 / 2025-08-19
+
+* ADDED: Add `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable compatibility for Rack integration [#1594](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/1594)
+
+### v0.12.3 / 2025-06-16
+
+* FIXED: Action_pack always assuming sdk spans
+
 ### v0.12.2 / 2025-06-04
 
 * FIXED: Rack span class naming
@@ -26,7 +34,7 @@
 
 ### v0.9.0 / 2024-01-09
 
-* BREAKING CHANGE: Use ActiveSupport instead of patches #703 
+* BREAKING CHANGE: Use ActiveSupport instead of patches #703
 
 ### v0.8.0 / 2023-11-22
 
@@ -41,32 +49,32 @@
 ### v0.7.0 / 2023-06-05
 
 * ADDED: Use Rack Middleware Helper
-* FIXED: Base config options 
+* FIXED: Base config options
 
 ### v0.6.0 / 2023-04-17
 
 * BREAKING CHANGE: Drop support for EoL Ruby 2.7
 
-* ADDED: Drop support for EoL Ruby 2.7 
+* ADDED: Drop support for EoL Ruby 2.7
 
 ### v0.5.0 / 2023-02-01
 
-* BREAKING CHANGE: Drop Rails 5 Support 
+* BREAKING CHANGE: Drop Rails 5 Support
 
-* ADDED: Drop Rails 5 Support 
-* FIXED: Drop Rails dependency for ActiveSupport Instrumentation 
+* ADDED: Drop Rails 5 Support
+* FIXED: Drop Rails dependency for ActiveSupport Instrumentation
 
 ### v0.4.1 / 2023-01-14
 
 * FIXED: String-ify code.function Span attribute
-* DOCS: Fix gem homepage 
-* DOCS: More gem documentation fixes 
+* DOCS: Fix gem homepage
+* DOCS: More gem documentation fixes
 
 ### v0.4.0 / 2022-12-06
 
-* BREAKING CHANGE: Remove enable_recognize_route and span_naming options 
+* BREAKING CHANGE: Remove enable_recognize_route and span_naming options
 
-* FIXED: Remove enable_recognize_route and span_naming options 
+* FIXED: Remove enable_recognize_route and span_naming options
 
 ### v0.3.2 / 2022-11-16
 
@@ -78,29 +86,29 @@
 
 ### v0.3.0 / 2022-10-14
 
-* ADDED: Name ActionPack spans with the HTTP method and route 
+* ADDED: Name ActionPack spans with the HTTP method and route
 
 ### v0.2.1 / 2022-10-04
 
-* FIXED: Ensures the correct route is add to http.route span attribute 
+* FIXED: Ensures the correct route is add to http.route span attribute
 
 ### v0.2.0 / 2022-06-09
 
 * Upgrading Base dependency version
-* FIXED: Broken test file requirements 
+* FIXED: Broken test file requirements
 
 ### v0.1.4 / 2022-05-02
 
-* FIXED: Use rails request's filtered path as http.target attribute 
-* FIXED: RubyGems Fallback 
+* FIXED: Use rails request's filtered path as http.target attribute
+* FIXED: RubyGems Fallback
 
 ### v0.1.3 / 2021-12-01
 
-* FIXED: Instrumentation of Rails 7 
+* FIXED: Instrumentation of Rails 7
 
 ### v0.1.2 / 2021-10-06
 
-* FIXED: Prevent high cardinality rack span name as a default 
+* FIXED: Prevent high cardinality rack span name as a default
 
 ### v0.1.1 / 2021-09-29
 

data/README.md

@@ -89,3 +89,21 @@ The `opentelemetry-instrumentation-action_pack` gem is distributed under the Apa
 [slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
 [rails-home]: https://rubyonrails.org/
+
+## HTTP semantic convention stability
+
+In the OpenTelemetry ecosystem, HTTP semantic conventions have now reached a stable state. However, the initial Rack instrumentation, which Action Pack relies on, was introduced before this stability was achieved, which resulted in HTTP attributes being based on an older version of the semantic conventions.
+
+To facilitate the migration to stable semantic conventions, you can use the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable. This variable allows you to opt-in to the new stable conventions, ensuring compatibility and future-proofing your instrumentation.
+
+Sinatra instrumentation installs Rack middleware, but the middleware version it installs depends on which `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable is set.
+
+When setting the value for `OTEL_SEMCONV_STABILITY_OPT_IN`, you can specify which conventions you wish to adopt:
+
+- `http` - Emits the stable HTTP and networking conventions and ceases emitting the old conventions previously emitted by the instrumentation.
+- `http/dup` - Emits both the old and stable HTTP and networking conventions, enabling a phased rollout of the stable semantic conventions.
+- Default behavior (in the absence of either value) is to continue emitting the old HTTP and networking conventions the instrumentation previously emitted.
+
+During the transition from old to stable conventions, Rack instrumentation code comes in three patch versions: `dup`, `old`, and `stable`. These versions are identical except for the attributes they send. Any changes to Rack instrumentation should consider all three patches.
+
+For additional information on migration, please refer to our [documentation](https://opentelemetry.io/docs/specs/semconv/non-normative/http-migration/).

data/lib/opentelemetry/instrumentation/action_pack/handlers/action_controller.rb

@@ -23,6 +23,9 @@ module OpenTelemetry
           # @param payload [Hash] the payload passed as a method argument
           # @return [Hash] the payload passed as a method argument
           def start(_name, _id, payload)
+            span = OpenTelemetry::Instrumentation::Rack.current_span
+            return unless span.recording?
+
             request = payload[:request]
             # It seems that there are cases in Rails functional tests where it bypasses the routing system and the `action_dispatch.route_uri_pattern` header not being set.
             # Our Test suite executes the routing system so we are unable to recreate this error case.
@@ -36,22 +39,18 @@ module OpenTelemetry
             attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE] = http_route if http_route
             attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] = request.filtered_path if request.filtered_path != request.fullpath
 
-            span = OpenTelemetry::Instrumentation::Rack.current_span
-            span_name = if @span_naming == :semconv
-                          if http_route
+            if @span_naming == :semconv
+              span.name = if http_route
                             "#{request.method} #{http_route}"
                           else
                             "#{request.method} /#{payload.dig(:params, :controller)}/#{payload.dig(:params, :action)}"
                           end
-                        # If there is an exception we want to keep the original span name
-                        # so it is easier to see where the request was routed to.
-                        elsif request.env['action_dispatch.exception']
-                          span.name
-                        else
-                          "#{payload[:controller]}##{payload[:action]}"
-                        end
+            # If there is an exception we want to keep the original span name
+            # so it is easier to see where the request was routed to.
+            elsif !request.env['action_dispatch.exception']
+              span.name = "#{payload[:controller]}##{payload[:action]}"
+            end
 
-            span.name = span_name
             span.add_attributes(attributes)
           rescue StandardError => e
             OpenTelemetry.handle_error(exception: e)

data/lib/opentelemetry/instrumentation/action_pack/railtie.rb

@@ -12,9 +12,20 @@ module OpenTelemetry
         config.before_initialize do |app|
           OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.install({})
 
+          stability_opt_in = ENV.fetch('OTEL_SEMCONV_STABILITY_OPT_IN', '')
+          values = stability_opt_in.split(',').map(&:strip)
+
+          rack_middleware_args = if values.include?('http/dup')
+                                   OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.middleware_args_dup
+                                 elsif values.include?('http')
+                                   OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.middleware_args_stable
+                                 else
+                                   OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.middleware_args
+                                 end
+
           app.middleware.insert_before(
             0,
-            *OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.middleware_args
+            *rack_middleware_args
           )
         end
       end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActionPack
-      VERSION = '0.12.2'
+      VERSION = '0.13.0'
     end
   end
 end

metadata

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