opentelemetry-instrumentation-http 0.27.1 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 850cb2d0a9d8d18cf00cade03d86e379a2338f626a0f1468e32b37c186de0869
-  data.tar.gz: d89c15de55426a730fdaef82e1b8212fa20981b645b9985f66712ceff7cab2b3
+  metadata.gz: feb5b23c7a36a0ea90576209babda48b3bc6c9df66e40c520576513f4ce1fe76
+  data.tar.gz: d15b180dbb268b10ba557deb9c5b5805dfb9f3046a240f8a729e12f07a78f642
 SHA512:
-  metadata.gz: 676dd8c1071ed0c9f0927c6def794f71637919a3303be4df314ebfe2cdb8037f04e64c5ccbdc649326f51c920437714cd504699a59e26dbfeb33569aed5172e0
-  data.tar.gz: a681dc2912300b21a16e1d7d069cf8e35eb3f9899917e87f89522f15e7b949de8f963bb894eb5efd887cc0a2cd8120077b25b3c29dc125dd0beffd7a150e3bb8
+  metadata.gz: 6304c10c4524e6864305b8b4eaa5d0a00d0517d677d58fe2bcb5a0319828165c0d574c8b6c8d7551896369298ecb1ce028967d7e93558b9b68a8c55622c7a98e
+  data.tar.gz: 99361f4657967d1b60c6e3c4a77b5f6a115f852d1573d79f57e0e24e37370d8507b64e57f815aa90d610e968f60ad0e68a2527041d0fd822caf347881bad3ac3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-http
 
+### v0.28.0 / 2026-01-13
+
+* ADDED: HTTP Client Semconv v1.17 Span Naming
+
 ### v0.27.1 / 2025-11-25
 
 * FIXED: Update support for unknown HTTP methods to match semantic conventions
@@ -113,7 +117,7 @@
 
 ### v0.16.2 / 2021-03-29
 
-* FIXED: HTTP instrumenter should check for gem presence
+* FIXED: HTTP Instrumentation should check for gem presence
 
 ### v0.16.1 / 2021-03-25
 

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, keyword_init: true)
 
         # 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.each_with_object({}) do |method, hash|
+          hash[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/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.28.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-http
 version: !ruby/object:Gem::Version
-  version: 0.27.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: 2026-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
@@ -51,10 +51,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
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http/0.28.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/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
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http/0.28.0
 post_install_message:
 rdoc_options: []
 require_paths: