opentelemetry-instrumentation-net_http 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7b85c86b2df97588d8f9902ffe90cb25e68446771ad717b75fa8e0cf4ff9d9d
-  data.tar.gz: 7963d5477b9da9b1138cda55e2f2636b57ebe8fc585c694dc166eefa618dd2a1
+  metadata.gz: af57eff25e83e807b9fce58534f7354a8da730eeb796e37304e4fcfff10aacf8
+  data.tar.gz: e05dab69206fd8a7eadee713bbc057c423b3908f848abf336d52ca974aab119b
 SHA512:
-  metadata.gz: 1b1ab76a00762db70a983a28e5359efb6f261ea53cdfc8cf0dfa1c34299cf4cd8324352d6f3894b786c8d10928cb8c973db8dd7ed3cdfe3a651f606597995331
-  data.tar.gz: f380617ed4ca7a83b5f32646f2bbeadbcc94d2c477472afae88d4c7fd794aba74589bb1f7ffd9a1e218385fb03fda5bf6d5dc2778d3a9076b4bfc758eef53e80
+  metadata.gz: f28c788929d2d2b2330291598b1116586e0ae5f692592ccff42b212cc948c035bc65d639d72391e990881a5326987d74441efea816f64fc82fde1e1ca9ae5cba
+  data.tar.gz: 96ec477a7341ac52207adfd0a14b8bc20ebd64445f84b7cbb295d10a9b61be0af1e93a8983792e18cc8112c9b933151b25bc52f500abe01c320406c0384a29f1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-net_http
 
+### 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
+
 ### v0.26.0 / 2025-10-22
 
 * BREAKING CHANGE: Min Ruby Version 3.2
@@ -89,7 +97,7 @@
 
 ### v0.19.4 / 2022-02-02
 
-* FIXED: Clientcontext attrs overwrite in net::http
+* FIXED: Client Context attrs overwrite in net::http
 * FIXED: Excessive hash creation on context attr merging
 
 ### v0.19.3 / 2021-12-01

data/README.md

@@ -67,4 +67,4 @@ When setting the value for `OTEL_SEMCONV_STABILITY_OPT_IN`, you can specify whic
 
 During the transition from old to stable conventions, Net::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 Net::HTTP 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/).
+For additional information on migration, please refer to our [documentation](https://opentelemetry.io/docs/specs/semconv/non-normative/http-migration/).

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Net
+      module HTTP
+        # Utility module for HTTP-related helper methods
+        # @api private
+        module HttpHelper
+          # Lightweight struct to hold span creation attributes
+          SpanCreationAttributes = Struct.new(:span_name, :attributes, keyword_init: true)
+
+          # Pre-computed mapping to avoid string allocations during normalization
+          METHOD_CACHE = {
+            'CONNECT' => 'CONNECT',
+            'DELETE' => 'DELETE',
+            'GET' => 'GET',
+            'HEAD' => 'HEAD',
+            'OPTIONS' => 'OPTIONS',
+            'PATCH' => 'PATCH',
+            'POST' => 'POST',
+            'PUT' => 'PUT',
+            'TRACE' => 'TRACE',
+            'connect' => 'CONNECT',
+            'delete' => 'DELETE',
+            'get' => 'GET',
+            'head' => 'HEAD',
+            'options' => 'OPTIONS',
+            'patch' => 'PATCH',
+            'post' => 'POST',
+            'put' => 'PUT',
+            'trace' => 'TRACE',
+            :connect => 'CONNECT',
+            :delete => 'DELETE',
+            :get => 'GET',
+            :head => 'HEAD',
+            :options => 'OPTIONS',
+            :patch => 'PATCH',
+            :post => 'POST',
+            :put => 'PUT',
+            :trace => '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 :OLD_SPAN_NAMES_BY_METHOD
+
+          # Prepares span data using old semantic conventions
+          # @param method [String, Symbol] The HTTP method
+          # @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
+              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.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
+    end
+  end
+end

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

@@ -23,25 +23,22 @@ module OpenTelemetry
 
                 return super if untraced?
 
-                attributes = {
-                  OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => req.method,
-                  OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME => USE_SSL_TO_SCHEME[use_ssl?],
-                  OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => req.path,
-                  OpenTelemetry::SemanticConventions::Trace::NET_PEER_NAME => @address,
-                  OpenTelemetry::SemanticConventions::Trace::NET_PEER_PORT => @port,
-                  'http.request.method' => req.method,
-                  'url.scheme' => USE_SSL_TO_SCHEME[use_ssl?],
-                  'server.address' => @address,
-                  'server.port' => @port
-                }
+                span_data = HttpHelper.span_attrs_for_dup(req.method)
+
+                attributes = { OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME => USE_SSL_TO_SCHEME[use_ssl?],
+                               OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => req.path,
+                               OpenTelemetry::SemanticConventions::Trace::NET_PEER_NAME => @address,
+                               OpenTelemetry::SemanticConventions::Trace::NET_PEER_PORT => @port, 'url.scheme' => USE_SSL_TO_SCHEME[use_ssl?],
+                               'server.address' => @address,
+                               'server.port' => @port }
                 path, query = split_path_and_query(req.path)
                 attributes['url.path'] = path
                 attributes['url.query'] = query if query
 
-                attributes.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+                attributes.merge!(span_data.attributes)
 
                 tracer.in_span(
-                  req.method,
+                  span_data.span_name,
                   attributes: attributes,
                   kind: :client
                 ) do |span|

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

@@ -12,7 +12,6 @@ module OpenTelemetry
           module Old
             # Module to prepend to Net::HTTP for instrumentation
             module Instrumentation
-              HTTP_METHODS_TO_SPAN_NAMES = Hash.new { |h, k| h[k] = "HTTP #{k}" }
               USE_SSL_TO_SCHEME = { false => 'http', true => 'https' }.freeze
 
               # Constant for the HTTP status range
@@ -24,16 +23,15 @@ module OpenTelemetry
 
                 return super if untraced?
 
-                attributes = {
-                  OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => req.method,
-                  OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME => USE_SSL_TO_SCHEME[use_ssl?],
-                  OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => req.path,
-                  OpenTelemetry::SemanticConventions::Trace::NET_PEER_NAME => @address,
-                  OpenTelemetry::SemanticConventions::Trace::NET_PEER_PORT => @port
-                }.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+                span_data = HttpHelper.span_attrs_for_old(req.method)
+
+                attributes = { OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME => USE_SSL_TO_SCHEME[use_ssl?],
+                               OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => req.path,
+                               OpenTelemetry::SemanticConventions::Trace::NET_PEER_NAME => @address,
+                               OpenTelemetry::SemanticConventions::Trace::NET_PEER_PORT => @port }.merge!(span_data.attributes)
 
                 tracer.in_span(
-                  HTTP_METHODS_TO_SPAN_NAMES[req.method],
+                  span_data.span_name,
                   attributes: attributes,
                   kind: :client
                 ) do |span|

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

@@ -23,20 +23,19 @@ module OpenTelemetry
 
                 return super if untraced?
 
-                attributes = {
-                  'http.request.method' => req.method,
-                  'url.scheme' => USE_SSL_TO_SCHEME[use_ssl?],
-                  'server.address' => @address,
-                  'server.port' => @port
-                }
+                span_data = HttpHelper.span_attrs_for_stable(req.method)
+
+                attributes = { 'url.scheme' => USE_SSL_TO_SCHEME[use_ssl?],
+                               'server.address' => @address,
+                               'server.port' => @port }
                 path, query = split_path_and_query(req.path)
                 attributes['url.path'] = path
                 attributes['url.query'] = query if query
 
-                attributes.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+                attributes.merge!(span_data.attributes)
 
                 tracer.in_span(
-                  req.method.to_s,
+                  span_data.span_name,
                   attributes: attributes,
                   kind: :client
                 ) do |span|

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

@@ -8,7 +8,7 @@ module OpenTelemetry
   module Instrumentation
     module Net
       module HTTP
-        VERSION = '0.26.0'
+        VERSION = '0.27.0'
       end
     end
   end

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

@@ -18,5 +18,6 @@ module OpenTelemetry
   end
 end
 
+require_relative 'http/http_helper'
 require_relative 'http/instrumentation'
 require_relative 'http/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-net_http
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-22 00:00:00.000000000 Z
+date: 2026-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
@@ -38,6 +38,7 @@ files:
 - lib/opentelemetry-instrumentation-net_http.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/net/http.rb
+- lib/opentelemetry/instrumentation/net/http/http_helper.rb
 - lib/opentelemetry/instrumentation/net/http/instrumentation.rb
 - lib/opentelemetry/instrumentation/net/http/patches/dup/instrumentation.rb
 - lib/opentelemetry/instrumentation/net/http/patches/old/instrumentation.rb
@@ -47,10 +48,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-net_http/0.26.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-net_http/0.27.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/net_http
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-net_http/0.26.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-net_http/0.27.0
 post_install_message:
 rdoc_options: []
 require_paths: