opentelemetry-instrumentation-httpx 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6487fc4d89f7b954e2a4a7f3a12e1cea61742eac2d9043c34d3a93743024d363
-  data.tar.gz: 61dfba5ba4bbf2ff8950640ce4327ebdb27e2d0aa48c1aea4af599941e3c2006
+  metadata.gz: b345154080244595e374a9c5c73dc2bb6a3d3772c9e689aff17197d5d2745f00
+  data.tar.gz: b2b03b233c59c2291e429a95838f2e7bbbf23a28374784f9bd969e3ec201a589
 SHA512:
-  metadata.gz: 9f6c6dd2c2e2fdb41f96d214b3f14b54c28a4d2bce7c96541bfc0292602773b9714499cfc9b8b095d777c5baea8c6e010071197806b2b2c713fb20c391dceb92
-  data.tar.gz: 6958b119d19337ec8b8c38dd7a96a21c6ac72299f59983e0835e96e8ff4b047b07ed0264e3555af499a90a27dd7cd6291e837d6a8778d2ee55c1afb9cc7e37ba
+  metadata.gz: fe41c4e43b96bef2caaf39830ab4a7d14ffb0ec5955f96fd71d3bb6039c06d74d9bd7fb5b8a7c547bb692a47d0e1b011fa42ea46ab76e24f705f12fe2f212c58
+  data.tar.gz: ac11915108072d027abe9383e0eb4cccba42b9dd891772f4f93dd4dcfc87c261918c37447357c999bc49a80b0583dfacabd8ae404075a04b40c498032a2fd711

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-httpx
 
+### v0.6.0 / 2026-01-13
+
+* ADDED: HTTP Client Semconv v1.17 Span Naming
+
+### v0.5.1 / 2025-11-25
+
+* FIXED: Update support for unknown HTTP methods to match semantic conventions
+
 ### v0.5.0 / 2025-10-22
 
 * BREAKING CHANGE: Min Ruby Version 3.2

data/README.md

@@ -63,4 +63,4 @@ When setting the value for `OTEL_SEMCONV_STABILITY_OPT_IN`, you can specify whic
 
 During the transition from old to stable conventions, HTTPX instrumentation code comes in three patch versions: `dup`, `old`, and `stable`. These versions are identical except for the attributes they send. Any changes to HTTPX 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/httpx/dup/plugin.rb

@@ -72,17 +72,17 @@ module OpenTelemetry
               verb = request.verb
               uri = request.uri
 
+              span_data = HttpHelper.span_attrs_for_dup(verb)
+
               config = HTTPX::Instrumentation.instance.config
 
               attributes = {
                 OpenTelemetry::SemanticConventions::Trace::HTTP_HOST => uri.host,
-                OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => verb,
                 OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME => uri.scheme,
                 OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => uri.path,
                 OpenTelemetry::SemanticConventions::Trace::HTTP_URL => "#{uri.scheme}://#{uri.host}",
                 OpenTelemetry::SemanticConventions::Trace::NET_PEER_NAME => uri.host,
                 OpenTelemetry::SemanticConventions::Trace::NET_PEER_PORT => uri.port,
-                'http.request.method' => verb,
                 'url.scheme' => uri.scheme,
                 'url.path' => uri.path,
                 'url.full' => "#{uri.scheme}://#{uri.host}",
@@ -92,9 +92,9 @@ module OpenTelemetry
 
               attributes['url.query'] = uri.query unless uri.query.nil?
               attributes[OpenTelemetry::SemanticConventions::Trace::PEER_SERVICE] = config[:peer_service] if config[:peer_service]
-              attributes.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+              attributes.merge!(span_data.attributes)
 
-              span = tracer.start_span(verb, attributes: attributes, kind: :client, start_timestamp: start_time)
+              span = tracer.start_span(span_data.span_name, attributes: attributes, kind: :client, start_timestamp: start_time)
 
               OpenTelemetry::Trace.with_span(span) do
                 OpenTelemetry.propagation.inject(request.headers)

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

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module HTTPX
+      # Utility module for normalizing HTTP methods according to OpenTelemetry semantic conventions
+      # @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

data/lib/opentelemetry/instrumentation/httpx/old/plugin.rb

@@ -71,11 +71,12 @@ module OpenTelemetry
               verb = request.verb
               uri = request.uri
 
+              span_data = HttpHelper.span_attrs_for_old(verb)
+
               config = HTTPX::Instrumentation.instance.config
 
               attributes = {
                 OpenTelemetry::SemanticConventions::Trace::HTTP_HOST => uri.host,
-                OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => verb,
                 OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME => uri.scheme,
                 OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => uri.path,
                 OpenTelemetry::SemanticConventions::Trace::HTTP_URL => "#{uri.scheme}://#{uri.host}",
@@ -84,9 +85,9 @@ module OpenTelemetry
               }
 
               attributes[OpenTelemetry::SemanticConventions::Trace::PEER_SERVICE] = config[:peer_service] if config[:peer_service]
-              attributes.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+              attributes.merge!(span_data.attributes)
 
-              span = tracer.start_span("HTTP #{verb}", attributes: attributes, kind: :client, start_timestamp: start_time)
+              span = tracer.start_span(span_data.span_name, attributes: attributes, kind: :client, start_timestamp: start_time)
 
               OpenTelemetry::Trace.with_span(span) do
                 OpenTelemetry.propagation.inject(request.headers)

data/lib/opentelemetry/instrumentation/httpx/stable/plugin.rb

@@ -71,10 +71,11 @@ module OpenTelemetry
               verb = request.verb
               uri = request.uri
 
+              span_data = HttpHelper.span_attrs_for_stable(verb)
+
               config = HTTPX::Instrumentation.instance.config
 
               attributes = {
-                'http.request.method' => verb,
                 'url.scheme' => uri.scheme,
                 'url.path' => uri.path,
                 'url.full' => "#{uri.scheme}://#{uri.host}",
@@ -83,9 +84,9 @@ module OpenTelemetry
               }
               attributes['url.query'] = uri.query unless uri.query.nil?
               attributes[OpenTelemetry::SemanticConventions::Trace::PEER_SERVICE] = config[:peer_service] if config[:peer_service]
-              attributes.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
+              attributes.merge!(span_data.attributes)
 
-              span = tracer.start_span(verb, attributes: attributes, kind: :client, start_timestamp: start_time)
+              span = tracer.start_span(span_data.span_name, attributes: attributes, kind: :client, start_timestamp: start_time)
 
               OpenTelemetry::Trace.with_span(span) do
                 OpenTelemetry.propagation.inject(request.headers)

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module HTTPX
-      VERSION = '0.5.0'
+      VERSION = '0.6.0'
     end
   end
 end

data/lib/opentelemetry/instrumentation/httpx.rb

@@ -15,5 +15,6 @@ module OpenTelemetry
   end
 end
 
+require_relative 'httpx/http_helper'
 require_relative 'httpx/instrumentation'
 require_relative 'httpx/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-httpx
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.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
@@ -39,6 +39,7 @@ files:
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/httpx.rb
 - lib/opentelemetry/instrumentation/httpx/dup/plugin.rb
+- lib/opentelemetry/instrumentation/httpx/http_helper.rb
 - lib/opentelemetry/instrumentation/httpx/instrumentation.rb
 - lib/opentelemetry/instrumentation/httpx/old/plugin.rb
 - lib/opentelemetry/instrumentation/httpx/stable/plugin.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-httpx/0.5.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-httpx/0.6.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-httpx/0.5.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-httpx/0.6.0
 post_install_message:
 rdoc_options: []
 require_paths: