opentelemetry-instrumentation-http_client 0.26.1 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ebfac04300052a282f08d6ad26b6aea718d46973e89be8583b66e11ac598e06
-  data.tar.gz: 5f20e179aee50b6c64778d09ed1f0d8afcf0703bea09f1caf50eca3eeba71a7d
+  metadata.gz: a94b8067f84bca1dd487affdceb4cda269bc8af1c965ef7e76a951d1c4c04bac
+  data.tar.gz: 500a80d8f273638f42ac6b7ef6ecf6899a701fdb97b449c84012520949f6d41b
 SHA512:
-  metadata.gz: 76bfb9567d20b11bb08d8d1c040bdccbe59f643cb4c9001687a1c4dc8f7475824bb9c20e0d709fb4352170daf16cb34aff8c415cbf5e78c4a6d9147ca5d4d6ea
-  data.tar.gz: 5383ad9c9c9cdcc2bfa8d193c56fb4fc918c3785e961375c8396ebd09c3ae3a3b663eb5217e974ac920700de58a5c9e7658ef456723197c0dc1958a956ab492a
+  metadata.gz: 01c2ebc9d8c8110cfb4c0ddb4b2d64a0c28aeb492da75ee3ee39dffbb8ed2b7bbc44e9996b14a680a7592c5d38f97ca4f57aeaef50241d3d0fc1c980dd134e26
+  data.tar.gz: 11655cdc285e2a617339ff52752232eeba6cd844100ae4ed87f47a2155d0eddffdce51f547759f515b3f5f0ba531d8cebff9d286565d0358992aba4344938746

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release History: opentelemetry-instrumentation-http_client
 
+### v0.28.0 / 2026-03-17
+
+* BREAKING CHANGE: Default to stable HTTP semantic conventions (#2051)
+* ADDED: Default to stable HTTP semantic conventions (#2051)
+
+### v0.27.0 / 2026-01-13
+
+* ADDED: HTTP Client Semconv v1.17 Span Naming
+
 ### v0.26.1 / 2025-11-25
 
 * FIXED: Update support for unknown HTTP methods to match semantic conventions
@@ -7,7 +16,6 @@
 ### v0.26.0 / 2025-10-22
 
 * BREAKING CHANGE: Min Ruby Version 3.2
-
 * ADDED: Min Ruby Version 3.2
 
 ### v0.25.1 / 2025-09-30
@@ -25,7 +33,6 @@
 ### v0.23.0 / 2025-01-16
 
 * BREAKING CHANGE: Set minimum supported version to Ruby 3.1
-
 * ADDED: Set minimum supported version to Ruby 3.1
 
 ### v0.22.8 / 2024-11-26
@@ -63,7 +70,6 @@
 ### v0.22.0 / 2023-04-17
 
 * BREAKING CHANGE: Drop support for EoL Ruby 2.7
-
 * ADDED: Drop support for EoL Ruby 2.7
 
 ### v0.21.0 / 2023-01-14
@@ -100,7 +106,6 @@
 ### v0.19.0 / 2021-06-23
 
 * BREAKING CHANGE: Total order constraint on span.status=
-
 * FIXED: Total order constraint on span.status=
 
 ### v0.18.0 / 2021-05-21

data/README.md

@@ -55,16 +55,12 @@ The `opentelemetry-instrumentation-http_client` gem is distributed under the Apa
 
 ## HTTP semantic convention stability
 
-In the OpenTelemetry ecosystem, HTTP semantic conventions have now reached a stable state. However, the initial HttpClient 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, HttpClient instrumentation code comes in three patch versions: `dup`, `old`, and `stable`. These versions are identical except for the attributes they send. Any changes to HttpClient 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/).
+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_client/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_client/instrumentation.rb

@@ -28,14 +28,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_dup
           ::HTTPClient.prepend(Patches::Dup::Client)
           ::HTTPClient::Session.prepend(Patches::Dup::Session)

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

@@ -20,25 +20,22 @@ module OpenTelemetry
               uri = req.header.request_uri
               url = "#{uri.scheme}://#{uri.host}"
               request_method = req.header.request_method
-              span_data = HttpHelper.span_attrs_for(request_method)
+              span_data = HttpHelper.span_attrs_for_dup(request_method)
 
               attributes = {
-                'http.method' => span_data.normalized_method,
                 'http.scheme' => uri.scheme,
                 'http.target' => uri.path,
                 'http.url' => url,
                 'net.peer.name' => uri.host,
                 'net.peer.port' => uri.port,
                 # stable semantic conventions
-                'http.request.method' => span_data.normalized_method,
                 'url.scheme' => uri.scheme,
                 'url.path' => uri.path,
                 'url.full' => url,
                 'server.address' => uri.host,
                 'server.port' => uri.port
-              }.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+              }.merge!(span_data.attributes)
 
-              attributes['http.request.method_original'] = span_data.original_method if span_data.original_method
               attributes['url.query'] = uri.query unless uri.query.nil?
 
               tracer.in_span(span_data.span_name, attributes: attributes, kind: :client) do |span|

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

@@ -20,16 +20,16 @@ module OpenTelemetry
               uri = req.header.request_uri
               url = "#{uri.scheme}://#{uri.host}"
               request_method = req.header.request_method
-              span_data = HttpHelper.span_attrs_for(request_method, semconv: :old)
+
+              span_data = HttpHelper.span_attrs_for_old(request_method)
 
               attributes = {
-                'http.method' => span_data.normalized_method,
                 'http.scheme' => uri.scheme,
                 'http.target' => uri.path,
                 'http.url' => url,
                 'net.peer.name' => uri.host,
                 'net.peer.port' => uri.port
-              }.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+              }.merge!(span_data.attributes)
 
               tracer.in_span(span_data.span_name, attributes: attributes, kind: :client) do |span|
                 OpenTelemetry.propagation.inject(req.header)

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

@@ -20,18 +20,15 @@ module OpenTelemetry
               uri = req.header.request_uri
               url = "#{uri.scheme}://#{uri.host}"
               request_method = req.header.request_method
-              span_data = HttpHelper.span_attrs_for(request_method)
 
-              attributes = {
-                'http.request.method' => span_data.normalized_method,
-                'url.scheme' => uri.scheme,
-                'url.path' => uri.path,
-                'url.full' => url,
-                'server.address' => uri.host,
-                'server.port' => uri.port
-              }.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+              span_data = HttpHelper.span_attrs_for_stable(request_method)
+
+              attributes = { 'url.scheme' => uri.scheme,
+                             'url.path' => uri.path,
+                             'url.full' => url,
+                             'server.address' => uri.host,
+                             'server.port' => uri.port }.merge!(span_data.attributes)
 
-              attributes['http.request.method_original'] = span_data.original_method if span_data.original_method
               attributes['url.query'] = uri.query unless uri.query.nil?
 
               tracer.in_span(span_data.span_name, attributes: attributes, kind: :client) do |span|

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module HttpClient
-      VERSION = '0.26.1'
+      VERSION = '0.28.0'
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-http_client
 version: !ruby/object:Gem::Version
-  version: 0.26.1
+  version: 0.28.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_client/0.26.1/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http_client/0.28.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/http_client
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http_client/0.26.1
-post_install_message:
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http_client/0.28.0
 rdoc_options: []
 require_paths:
 - lib
@@ -70,8 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: HttpClient instrumentation for the OpenTelemetry framework
 test_files: []