RubyGems - opentelemetry-instrumentation-http - Versions diffs - 0.26.1 → 0.27.1 - Mend

opentelemetry-instrumentation-http 0.26.1 → 0.27.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +10 -0
data/lib/opentelemetry/instrumentation/http/http_helper.rb +86 -0
data/lib/opentelemetry/instrumentation/http/patches/dup/client.rb +13 -9
data/lib/opentelemetry/instrumentation/http/patches/old/client.rb +11 -8
data/lib/opentelemetry/instrumentation/http/patches/stable/client.rb +12 -8
data/lib/opentelemetry/instrumentation/http/version.rb +1 -1
data/lib/opentelemetry/instrumentation/http.rb +1 -0
metadata +9 -8

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8fd6c8748e9cedb916f60eca92745adc4e5a5d5c05c5543cd90e08d148e22d4
-  data.tar.gz: 10adf837f0b138ddcaec5834289233dcc485b4e2aede461c07efff56e4a97da3
+  metadata.gz: 850cb2d0a9d8d18cf00cade03d86e379a2338f626a0f1468e32b37c186de0869
+  data.tar.gz: d89c15de55426a730fdaef82e1b8212fa20981b645b9985f66712ceff7cab2b3
 SHA512:
-  metadata.gz: bb23413aeb8be027f59457ec033699ef9c8d67ad8843934f590d441e80080a5e53570940c7700d12227e4df77ce4e336f95598eb5280d6046eae35c7f68120e9
-  data.tar.gz: e32a4d3431f9eccc65800e7e242c01f01d19450e7dc1ae1d9658991e86224415ec18d642c1aa3b216165322dc92963c5304375ea2db3e8f9db94d864e89f50fc
+  metadata.gz: 676dd8c1071ed0c9f0927c6def794f71637919a3303be4df314ebfe2cdb8037f04e64c5ccbdc649326f51c920437714cd504699a59e26dbfeb33569aed5172e0
+  data.tar.gz: a681dc2912300b21a16e1d7d069cf8e35eb3f9899917e87f89522f15e7b949de8f963bb894eb5efd887cc0a2cd8120077b25b3c29dc125dd0beffd7a150e3bb8

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,15 @@
 # Release History: opentelemetry-instrumentation-http
+### v0.27.1 / 2025-11-25
+* FIXED: Update support for unknown HTTP methods to match semantic conventions
+### v0.27.0 / 2025-10-22
+* BREAKING CHANGE: Min Ruby Version 3.2
+* ADDED: Min Ruby Version 3.2
 ### v0.26.1 / 2025-09-30
 * FIXED: Min OTel Ruby API 1.7

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+module OpenTelemetry
+  module Instrumentation
+    module HTTP
+      # Module for normalizing HTTP methods
+      # @api private
+      module HttpHelper
+        # Lightweight struct to hold span creation attributes
+        SpanCreationAttributes = Struct.new(:span_name, :normalized_method, :original_method, 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
+        # 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
+        # Prepares all span data for the specified semantic convention in a single call
+        # @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)
+          normalized = METHOD_CACHE[method]
+          if normalized
+            span_name = semconv == :old ? OLD_SPAN_NAMES[normalized] : normalized
+            SpanCreationAttributes.new(
+              span_name: span_name,
+              normalized_method: normalized,
+              original_method: nil
+            )
+          else
+            SpanCreationAttributes.new(
+              span_name: 'HTTP',
+              normalized_method: '_OTHER',
+              original_method: method.to_s
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,26 +16,28 @@ module OpenTelemetry
             HTTP_STATUS_SUCCESS_RANGE = (100..399)
             def perform(req, options)
+              span_data = HttpHelper.span_attrs_for(req.verb)
               uri = req.uri
-              request_method = req.verb.to_s.upcase
-              span_name = create_request_span_name(request_method, uri.path)
+              span_name = create_span_name(span_data, uri.path)
               attributes = {
                 # old semconv
-                'http.method' => request_method,
+                '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' => request_method,
+                '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)
@@ -62,15 +64,17 @@ module OpenTelemetry
               span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(status_code)
             end
-            def create_request_span_name(request_method, request_path)
+            def create_span_name(span_data, request_path)
+              default_span_name = span_data.span_name
               if (implementation = config[:span_name_formatter])
-                updated_span_name = implementation.call(request_method, request_path)
-                updated_span_name.is_a?(String) ? updated_span_name : request_method.to_s
+                updated_span_name = implementation.call(span_data.normalized_method, request_path)
+                updated_span_name.is_a?(String) ? updated_span_name : default_span_name
               else
-                request_method.to_s
+                default_span_name
               end
             rescue StandardError
-              request_method.to_s
+              default_span_name
             end
             def tracer

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

@@ -16,12 +16,13 @@ module OpenTelemetry
             HTTP_STATUS_SUCCESS_RANGE = (100..399)
             def perform(req, options)
+              span_data = HttpHelper.span_attrs_for(req.verb, semconv: :old)
               uri = req.uri
-              request_method = req.verb.to_s.upcase
-              span_name = create_request_span_name(request_method, uri.path)
+              span_name = create_span_name(span_data, uri.path)
               attributes = {
-                'http.method' => request_method,
+                'http.method' => span_data.normalized_method,
                 'http.scheme' => uri.scheme,
                 'http.target' => uri.path,
                 'http.url' => "#{uri.scheme}://#{uri.host}",
@@ -51,15 +52,17 @@ module OpenTelemetry
               span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(status_code)
             end
-            def create_request_span_name(request_method, request_path)
+            def create_span_name(span_data, request_path)
+              default_span_name = span_data.span_name
               if (implementation = config[:span_name_formatter])
-                updated_span_name = implementation.call(request_method, request_path)
-                updated_span_name.is_a?(String) ? updated_span_name : "HTTP #{request_method}"
+                updated_span_name = implementation.call(span_data.normalized_method, request_path)
+                updated_span_name.is_a?(String) ? updated_span_name : default_span_name
               else
-                "HTTP #{request_method}"
+                default_span_name
               end
             rescue StandardError
-              "HTTP #{request_method}"
+              default_span_name
             end
             def tracer

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

@@ -16,18 +16,20 @@ module OpenTelemetry
             HTTP_STATUS_SUCCESS_RANGE = (100..399)
             def perform(req, options)
+              span_data = HttpHelper.span_attrs_for(req.verb)
               uri = req.uri
-              request_method = req.verb.to_s.upcase
-              span_name = create_request_span_name(request_method, uri.path)
+              span_name = create_span_name(span_data, uri.path)
               attributes = {
-                'http.request.method' => request_method,
+                '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)
@@ -53,15 +55,17 @@ module OpenTelemetry
               span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(status_code)
             end
-            def create_request_span_name(request_method, request_path)
+            def create_span_name(span_data, request_path)
+              default_span_name = span_data.span_name
               if (implementation = config[:span_name_formatter])
-                updated_span_name = implementation.call(request_method, request_path)
-                updated_span_name.is_a?(String) ? updated_span_name : request_method.to_s
+                updated_span_name = implementation.call(span_data.normalized_method, request_path)
+                updated_span_name.is_a?(String) ? updated_span_name : default_span_name
               else
-                request_method.to_s
+                default_span_name
               end
             rescue StandardError
-              request_method.to_s
+              default_span_name
             end
             def tracer

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

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

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

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

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-http
 version: !ruby/object:Gem::Version
-  version: 0.26.1
+  version: 0.27.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-01 00:00:00.000000000 Z
+date: 2025-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: '0.25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: '0.25'
 description: HTTP instrumentation for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -38,6 +38,7 @@ files:
 - lib/opentelemetry-instrumentation-http.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/http.rb
+- lib/opentelemetry/instrumentation/http/http_helper.rb
 - lib/opentelemetry/instrumentation/http/instrumentation.rb
 - lib/opentelemetry/instrumentation/http/patches/dup/client.rb
 - lib/opentelemetry/instrumentation/http/patches/dup/connection.rb
@@ -50,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.26.1/file/CHANGELOG.md
+  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
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http/0.26.1
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-http/0.27.1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -62,14 +63,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: HTTP instrumentation for the OpenTelemetry framework