opentelemetry-instrumentation-http 0.27.1 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 850cb2d0a9d8d18cf00cade03d86e379a2338f626a0f1468e32b37c186de0869
-  data.tar.gz: d89c15de55426a730fdaef82e1b8212fa20981b645b9985f66712ceff7cab2b3
+  metadata.gz: 4543fe83a9f11f078468ed896e6c97b902600b8ca1e6f2851cb5fc074b87f992
+  data.tar.gz: f9cfa712de1fcb7dbdf013dcc396087ec4c1d7368a5aee1885aee28a3d79bad1
 SHA512:
-  metadata.gz: 676dd8c1071ed0c9f0927c6def794f71637919a3303be4df314ebfe2cdb8037f04e64c5ccbdc649326f51c920437714cd504699a59e26dbfeb33569aed5172e0
-  data.tar.gz: a681dc2912300b21a16e1d7d069cf8e35eb3f9899917e87f89522f15e7b949de8f963bb894eb5efd887cc0a2cd8120077b25b3c29dc125dd0beffd7a150e3bb8
+  metadata.gz: 308dad930e78f6c0d4a6c1054a87155f7da8262bf8ca8385d5a2b518ec78a2120e5b5497c71907f82bbf794a41e4a21c30fd2569ce9a164f6a80cbaa6f8bd7f8
+  data.tar.gz: ed2bbff794c2c357a4cf468a045be0f1f678ef5722e751e6dbe9ea642b926e760ff6917879546f0c6204e37c7e3384276fc1bbc2636a213997de87dd7f9d1197

data/CHANGELOG.md

@@ -1,124 +1,135 @@
 # Release History: opentelemetry-instrumentation-http
 
-### v0.27.1 / 2025-11-25
+## v0.30.0 / 2026-04-14
 
-* FIXED: Update support for unknown HTTP methods to match semantic conventions
+- BREAKING CHANGE: Min Ruby Version 3.3 (#2125)
+- ADDED: Min Ruby Version 3.3 (#2125)
+- ADDED: Add release tag into source code url of gem metadata (#1984)
 
-### v0.27.0 / 2025-10-22
+## v0.29.0 / 2026-03-17
 
-* BREAKING CHANGE: Min Ruby Version 3.2
+- BREAKING CHANGE: Default to stable HTTP semantic conventions (#2051)
+- ADDED: Default to stable HTTP semantic conventions (#2051)
 
-* ADDED: Min Ruby Version 3.2
+## v0.28.0 / 2026-01-13
 
-### v0.26.1 / 2025-09-30
+- ADDED: HTTP Client Semconv v1.17 Span Naming
 
-* FIXED: Min OTel Ruby API 1.7
+## v0.27.1 / 2025-11-25
 
-### v0.26.0 / 2025-09-30
+- FIXED: Update support for unknown HTTP methods to match semantic conventions
 
-* ADDED: Bump minimum API Version to 1.7
+## v0.27.0 / 2025-10-22
 
-### v0.25.1 / 2025-07-01
+- BREAKING CHANGE: Min Ruby Version 3.2
+- ADDED: Min Ruby Version 3.2
 
-* FIXED: Update span name when semconv stability is enabled
+## v0.26.1 / 2025-09-30
 
-### v0.25.0 / 2025-06-17
+- FIXED: Min OTel Ruby API 1.7
 
-* ADDED: Add `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable [#1547](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/1547)
+## v0.26.0 / 2025-09-30
 
-### v0.24.0 / 2025-01-16
+- ADDED: Bump minimum API Version to 1.7
 
-* BREAKING CHANGE: Set minimum supported version to Ruby 3.1
+## v0.25.1 / 2025-07-01
 
-* ADDED: Set minimum supported version to Ruby 3.1
+- FIXED: Update span name when semconv stability is enabled
 
-### v0.23.5 / 2024-11-26
+## v0.25.0 / 2025-06-17
 
-* CHANGED: Performance Freeze all range objects #1222
+- ADDED: Add `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable [#1547](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/1547)
 
-### v0.23.4 / 2024-07-23
+## v0.24.0 / 2025-01-16
 
-* DOCS: Add cspell to CI
+- BREAKING CHANGE: Set minimum supported version to Ruby 3.1
+- ADDED: Set minimum supported version to Ruby 3.1
 
-### v0.23.3 / 2024-04-30
+## v0.23.5 / 2024-11-26
 
-* FIXED: Bundler conflict warnings
+- CHANGED: Performance Freeze all range objects #1222
 
-### v0.23.2 / 2023-11-23
+## v0.23.4 / 2024-07-23
 
-* CHANGED: Applied Rubocop Performance Recommendations [#727](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/727)
+- DOCS: Add cspell to CI
 
-### v0.23.1 / 2023-06-05
+## v0.23.3 / 2024-04-30
 
-* FIXED: Base config options
+- FIXED: Bundler conflict warnings
 
-### v0.23.0 / 2023-05-15
+## v0.23.2 / 2023-11-23
 
-* ADDED: Add span_preprocessor hook
+- CHANGED: Applied Rubocop Performance Recommendations [#727](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/727)
 
-### v0.22.0 / 2023-04-17
+## v0.23.1 / 2023-06-05
 
-* BREAKING CHANGE: Drop support for EoL Ruby 2.7
+- FIXED: Base config options
 
-* ADDED: Drop support for EoL Ruby 2.7
+## v0.23.0 / 2023-05-15
 
-### v0.21.0 / 2023-01-14
+- ADDED: Add span_preprocessor hook
 
-* ADDED: Add request/response hooks to more http clients
-* DOCS: Fix gem homepage
-* DOCS: More gem documentation fixes
+## v0.22.0 / 2023-04-17
 
-### v0.20.0 / 2022-06-09
+- BREAKING CHANGE: Drop support for EoL Ruby 2.7
+- ADDED: Drop support for EoL Ruby 2.7
 
-* Upgrading Base dependency version
-* FIXED: Broken test file requirements
+## v0.21.0 / 2023-01-14
 
-### v0.19.6 / 2022-05-05
+- ADDED: Add request/response hooks to more http clients
+- DOCS: Fix gem homepage
+- DOCS: More gem documentation fixes
 
-* (No significant changes)
+## v0.20.0 / 2022-06-09
 
-### v0.19.5 / 2022-05-02
+- Upgrading Base dependency version
+- FIXED: Broken test file requirements
 
-* FIXED: RubyGems Fallback
+## v0.19.6 / 2022-05-05
 
-### v0.19.4 / 2022-02-02
+- (No significant changes)
 
-* FIXED: Excessive hash creation on context attr merging
+## v0.19.5 / 2022-05-02
 
-### v0.19.3 / 2021-12-01
+- FIXED: RubyGems Fallback
 
-* FIXED: Change net attribute names to match the semantic conventions spec for http
+## v0.19.4 / 2022-02-02
 
-### v0.19.2 / 2021-09-29
+- FIXED: Excessive hash creation on context attr merging
 
-* (No significant changes)
+## v0.19.3 / 2021-12-01
 
-### v0.19.1 / 2021-08-12
+- FIXED: Change net attribute names to match the semantic conventions spec for http
 
-* (No significant changes)
+## v0.19.2 / 2021-09-29
 
-### v0.19.0 / 2021-06-23
+- (No significant changes)
 
-* BREAKING CHANGE: Total order constraint on span.status=
+## v0.19.1 / 2021-08-12
 
-* FIXED: Total order constraint on span.status=
+- (No significant changes)
 
-### v0.18.0 / 2021-05-21
+## v0.19.0 / 2021-06-23
 
-* ADDED: Updated API dependency for 1.0.0.rc1
+- BREAKING CHANGE: Total order constraint on span.status=
+- FIXED: Total order constraint on span.status=
 
-### v0.17.0 / 2021-04-22
+## v0.18.0 / 2021-05-21
 
-* FIXED: Refactor propagators to add #fields
+- ADDED: Updated API dependency for 1.0.0.rc1
 
-### v0.16.2 / 2021-03-29
+## v0.17.0 / 2021-04-22
 
-* FIXED: HTTP instrumenter should check for gem presence
+- FIXED: Refactor propagators to add #fields
 
-### v0.16.1 / 2021-03-25
+## v0.16.2 / 2021-03-29
 
-* FIXED: HTTP instrumentation missing require
+- FIXED: HTTP Instrumentation should check for gem presence
 
-### v0.16.0 / 2021-03-17
+## v0.16.1 / 2021-03-25
 
-* Initial release.
+- FIXED: HTTP instrumentation missing require
+
+## v0.16.0 / 2021-03-17
+
+- Initial release.

data/README.md

@@ -67,16 +67,12 @@ The `opentelemetry-instrumentation-http` gem is distributed under the Apache 2.0
 
 ## HTTP semantic convention stability
 
-In the OpenTelemetry ecosystem, HTTP semantic conventions have now reached a stable state. However, the initial HTTP instrumentation 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.
+This instrumentation by default emits the stable HTTP semantic conventions. The `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable can be used to opt-in to the old or duplicate (both old and stable) semantic conventions.
 
 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, HTTP instrumentation code comes in three patch versions: `dup`, `old`, and `stable`. These versions are identical except for the attributes they send. Any changes to HTTP instrumentation should consider all three patches.
+- `http` - Emits the stable HTTP and networking conventions.
+- `http/dup` - **DEPRECATED: Will be removed on April 15, 2026.** Emits both the old and stable HTTP and networking conventions.
+- `old` - **DEPRECATED: Will be removed on April 15, 2026.** Emits the old HTTP and networking conventions.
 
 For additional information on migration, please refer to our [documentation](https://opentelemetry.io/docs/specs/semconv/non-normative/http-migration/).

data/lib/opentelemetry/instrumentation/http/http_helper.rb

@@ -11,7 +11,7 @@ module OpenTelemetry
       # @api private
       module HttpHelper
         # Lightweight struct to hold span creation attributes
-        SpanCreationAttributes = Struct.new(:span_name, :normalized_method, :original_method, keyword_init: true)
+        SpanCreationAttributes = Struct.new(:span_name, :attributes)
 
         # Pre-computed mapping to avoid string allocations during normalization
         METHOD_CACHE = {
@@ -44,41 +44,89 @@ module OpenTelemetry
           :trace => 'TRACE'
         }.freeze
 
-        # Pre-computed span names for old semantic conventions to avoid allocations
-        OLD_SPAN_NAMES = {
-          'CONNECT' => 'HTTP CONNECT',
-          'DELETE' => 'HTTP DELETE',
-          'GET' => 'HTTP GET',
-          'HEAD' => 'HTTP HEAD',
-          'OPTIONS' => 'HTTP OPTIONS',
-          'PATCH' => 'HTTP PATCH',
-          'POST' => 'HTTP POST',
-          'PUT' => 'HTTP PUT',
-          'TRACE' => 'HTTP TRACE'
-        }.freeze
+        private_constant :METHOD_CACHE
+
+        OLD_SPAN_NAMES_BY_METHOD = METHOD_CACHE.values.uniq.to_h do |method|
+          [method, "HTTP #{method}"]
+        end.freeze
 
-        private_constant :METHOD_CACHE, :OLD_SPAN_NAMES
+        private_constant :OLD_SPAN_NAMES_BY_METHOD
 
-        # Prepares all span data for the specified semantic convention in a single call
+        # Prepares span data using old semantic conventions
         # @param method [String, Symbol] The HTTP method
-        # @param semconv [Symbol] The semantic convention to use (:stable or :old)
-        # @return [SpanCreationAttributes] struct containing span_name, normalized_method, and original_method
-        def self.span_attrs_for(method, semconv: :stable)
+        # @return [SpanCreationAttributes] struct containing span_name and attributes hash
+        def self.span_attrs_for_old(method)
+          client_context_attrs = OpenTelemetry::Common::HTTP::ClientContext.attributes
           normalized = METHOD_CACHE[method]
+          attributes = client_context_attrs.dup
+
+          # Determine base span name and method value
+          if normalized
+            span_name = OLD_SPAN_NAMES_BY_METHOD[normalized]
+            method_value = normalized
+          else
+            span_name = 'HTTP'
+            method_value = '_OTHER'
+          end
+
+          attributes['http.method'] ||= method_value
+
+          SpanCreationAttributes.new(span_name: span_name, attributes: attributes)
+        end
+
+        # Prepares span data using stable semantic conventions
+        # @param method [String, Symbol] The HTTP method
+        # @return [SpanCreationAttributes] struct containing span_name and attributes hash
+        def self.span_attrs_for_stable(method)
+          client_context_attrs = OpenTelemetry::Common::HTTP::ClientContext.attributes
+          url_template = client_context_attrs['url.template']
+          normalized = METHOD_CACHE[method]
+          attributes = client_context_attrs.dup
+
+          # Determine base span name and method value
           if normalized
-            span_name = semconv == :old ? OLD_SPAN_NAMES[normalized] : normalized
-            SpanCreationAttributes.new(
-              span_name: span_name,
-              normalized_method: normalized,
-              original_method: nil
-            )
+            base_name = normalized
+            method_value = normalized
+            original = nil
           else
-            SpanCreationAttributes.new(
-              span_name: 'HTTP',
-              normalized_method: '_OTHER',
-              original_method: method.to_s
-            )
+            base_name = 'HTTP'
+            method_value = '_OTHER'
+            original = method.to_s
           end
+
+          span_name = url_template ? "#{base_name} #{url_template}" : base_name
+          attributes['http.request.method'] ||= method_value
+          attributes['http.request.method_original'] ||= original if original
+
+          SpanCreationAttributes.new(span_name: span_name, attributes: attributes)
+        end
+
+        # Prepares span data using both old and stable semantic conventions
+        # @param method [String, Symbol] The HTTP method
+        # @return [SpanCreationAttributes] struct containing span_name and attributes hash
+        def self.span_attrs_for_dup(method)
+          client_context_attrs = OpenTelemetry::Common::HTTP::ClientContext.attributes
+          url_template = client_context_attrs['url.template']
+          normalized = METHOD_CACHE[method]
+          attributes = client_context_attrs.dup
+
+          # Determine base span name and method value
+          if normalized
+            base_name = normalized
+            method_value = normalized
+            original = nil
+          else
+            base_name = 'HTTP'
+            method_value = '_OTHER'
+            original = method.to_s
+          end
+
+          span_name = url_template ? "#{base_name} #{url_template}" : base_name
+          attributes['http.method'] ||= method_value
+          attributes['http.request.method'] ||= method_value
+          attributes['http.request.method_original'] ||= original if original
+
+          SpanCreationAttributes.new(span_name: span_name, attributes: attributes)
         end
       end
     end

data/lib/opentelemetry/instrumentation/http/instrumentation.rb

@@ -26,14 +26,20 @@ module OpenTelemetry
           values = stability_opt_in.split(',').map(&:strip)
 
           if values.include?('http/dup')
+            emit_old_semconv_deprecation_warning('http/dup')
             'dup'
-          elsif values.include?('http')
-            'stable'
-          else
+          elsif values.include?('old')
+            emit_old_semconv_deprecation_warning('old')
             'old'
+          else
+            'stable'
           end
         end
 
+        def emit_old_semconv_deprecation_warning(option)
+          OpenTelemetry.logger.warn("The `#{option}` option for OTEL_SEMCONV_STABILITY_OPT_IN is deprecated and will be removed on April 15, 2026. Please migrate to the stable HTTP semantic conventions.")
+        end
+
         def patch_old
           ::HTTP::Client.prepend(Patches::Old::Client)
           ::HTTP::Connection.prepend(Patches::Old::Connection)

data/lib/opentelemetry/instrumentation/http/patches/dup/client.rb

@@ -16,30 +16,27 @@ module OpenTelemetry
             HTTP_STATUS_SUCCESS_RANGE = (100..399)
 
             def perform(req, options)
-              span_data = HttpHelper.span_attrs_for(req.verb)
+              span_data = HttpHelper.span_attrs_for_dup(req.verb)
 
               uri = req.uri
               span_name = create_span_name(span_data, uri.path)
 
               attributes = {
                 # old semconv
-                'http.method' => span_data.normalized_method,
                 'http.scheme' => uri.scheme,
                 'http.target' => uri.path,
                 'http.url' => "#{uri.scheme}://#{uri.host}",
                 'net.peer.name' => uri.host,
                 'net.peer.port' => uri.port,
                 # stable semconv
-                'http.request.method' => span_data.normalized_method,
                 'url.scheme' => uri.scheme,
                 'url.path' => uri.path,
                 'url.full' => "#{uri.scheme}://#{uri.host}",
                 'server.address' => uri.host,
                 'server.port' => uri.port
               }
-              attributes['http.request.method_original'] = span_data.original_method if span_data.original_method
               attributes['url.query'] = uri.query unless uri.query.nil?
-              attributes.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+              attributes.merge!(span_data.attributes)
 
               tracer.in_span(span_name, attributes: attributes, kind: :client) do |span|
                 OpenTelemetry.propagation.inject(req.headers)
@@ -68,7 +65,9 @@ module OpenTelemetry
               default_span_name = span_data.span_name
 
               if (implementation = config[:span_name_formatter])
-                updated_span_name = implementation.call(span_data.normalized_method, request_path)
+                # Extract the HTTP method from attributes (old semconv key)
+                http_method = span_data.attributes['http.method'] || span_data.attributes['http.request.method']
+                updated_span_name = implementation.call(http_method, request_path)
                 updated_span_name.is_a?(String) ? updated_span_name : default_span_name
               else
                 default_span_name

data/lib/opentelemetry/instrumentation/http/patches/old/client.rb

@@ -16,19 +16,18 @@ module OpenTelemetry
             HTTP_STATUS_SUCCESS_RANGE = (100..399)
 
             def perform(req, options)
-              span_data = HttpHelper.span_attrs_for(req.verb, semconv: :old)
+              span_data = HttpHelper.span_attrs_for_old(req.verb)
 
               uri = req.uri
               span_name = create_span_name(span_data, uri.path)
 
               attributes = {
-                'http.method' => span_data.normalized_method,
                 'http.scheme' => uri.scheme,
                 'http.target' => uri.path,
                 'http.url' => "#{uri.scheme}://#{uri.host}",
                 'net.peer.name' => uri.host,
                 'net.peer.port' => uri.port
-              }.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+              }.merge!(span_data.attributes)
 
               tracer.in_span(span_name, attributes: attributes, kind: :client) do |span|
                 OpenTelemetry.propagation.inject(req.headers)
@@ -56,7 +55,9 @@ module OpenTelemetry
               default_span_name = span_data.span_name
 
               if (implementation = config[:span_name_formatter])
-                updated_span_name = implementation.call(span_data.normalized_method, request_path)
+                # Extract the HTTP method from attributes
+                http_method = span_data.attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD]
+                updated_span_name = implementation.call(http_method, request_path)
                 updated_span_name.is_a?(String) ? updated_span_name : default_span_name
               else
                 default_span_name

data/lib/opentelemetry/instrumentation/http/patches/stable/client.rb

@@ -16,22 +16,18 @@ module OpenTelemetry
             HTTP_STATUS_SUCCESS_RANGE = (100..399)
 
             def perform(req, options)
-              span_data = HttpHelper.span_attrs_for(req.verb)
+              span_data = HttpHelper.span_attrs_for_stable(req.verb)
 
               uri = req.uri
               span_name = create_span_name(span_data, uri.path)
 
-              attributes = {
-                'http.request.method' => span_data.normalized_method,
-                'url.scheme' => uri.scheme,
-                'url.path' => uri.path,
-                'url.full' => "#{uri.scheme}://#{uri.host}",
-                'server.address' => uri.host,
-                'server.port' => uri.port
-              }
-              attributes['http.request.method_original'] = span_data.original_method if span_data.original_method
+              attributes = { 'url.scheme' => uri.scheme,
+                             'url.path' => uri.path,
+                             'url.full' => "#{uri.scheme}://#{uri.host}",
+                             'server.address' => uri.host,
+                             'server.port' => uri.port }
               attributes['url.query'] = uri.query unless uri.query.nil?
-              attributes.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+              attributes.merge!(span_data.attributes)
 
               tracer.in_span(span_name, attributes: attributes, kind: :client) do |span|
                 OpenTelemetry.propagation.inject(req.headers)
@@ -59,7 +55,9 @@ module OpenTelemetry
               default_span_name = span_data.span_name
 
               if (implementation = config[:span_name_formatter])
-                updated_span_name = implementation.call(span_data.normalized_method, request_path)
+                # Extract the HTTP method from attributes
+                http_method = span_data.attributes['http.request.method']
+                updated_span_name = implementation.call(http_method, request_path)
                 updated_span_name.is_a?(String) ? updated_span_name : default_span_name
               else
                 default_span_name

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module HTTP
-      VERSION = '0.27.1'
+      VERSION = '0.30.0'
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-http
 version: !ruby/object:Gem::Version
-  version: 0.27.1
+  version: 0.30.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
@@ -51,11 +50,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http/0.27.1/file/CHANGELOG.md
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/http
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http/0.30.0/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-http/v0.30.0/instrumentation/http
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http/0.27.1
-post_install_message:
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http/0.30.0
 rdoc_options: []
 require_paths:
 - lib
@@ -63,15 +61,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: HTTP instrumentation for the OpenTelemetry framework
 test_files: []