RubyGems - opentelemetry-instrumentation-faraday - Versions diffs - 0.30.0 → 0.30.1 - Mend

opentelemetry-instrumentation-faraday 0.30.0 → 0.30.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 CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bafda9fd097097c56f5eb2c496fcb13459545eac94ef35af88e75cfb60f4855
-  data.tar.gz: 551305837597a22d74899fb2b761c351ecd429ed71e655f1ba9100cc002ec6e4
+  metadata.gz: b877acc5ff0551faa19a4d1a09eb5c95b63e497259369edbe20dc211ef8b3964
+  data.tar.gz: 7860cb972bcf7747c4d3e97d8b45635beb6c67242bca36afa71ee3b663b4ede2
 SHA512:
-  metadata.gz: a299a184c319f45a6a119d5243bf48e76c7b13795f570079d559e428de05bf9f47d9a34e3c37b9d3c6551f4169d1a800dbcbd25ebc9bfede2b0822edc62388f3
-  data.tar.gz: 7d80941dd09d0702597c45e72f2a86df677a8f845e458db0459706899dcca23069d594c738e6651e19d319ed8e992e46894f54236f0fa509664d1a7a204d6e01
+  metadata.gz: 6660d12e648798d2eb55e8c11eb557d1d7c07a8fe593cb69cd025ae02b0be6a41d6d4a35c19f5a7126bfa5ab4a1b79e239cdea5c35d70f065ecff9865af5feb3
+  data.tar.gz: d486ff5275318c336dede3e3bd5088a0d7445add80ac4c508735e2a218b8dbdcae5fbca1acf4171411012da56c662056c7e2e2ebd5750f323cecfc7ad82b2fa6

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-faraday
+### v0.30.1 / 2025-11-25
+* FIXED: Update support for unknown HTTP methods to match semantic conventions
 ### v0.30.0 / 2025-10-22
 * BREAKING CHANGE: Min Ruby Version 3.2

data/lib/opentelemetry/instrumentation/faraday/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 Faraday
+      # Utility module for HTTP-related helper 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/faraday/middlewares/dup/tracer_middleware.rb CHANGED Viewed

@@ -12,32 +12,24 @@ module OpenTelemetry
           # TracerMiddleware propagates context and instruments Faraday requests
           # by way of its middleware system
           class TracerMiddleware < ::Faraday::Middleware
-            HTTP_METHODS_SYMBOL_TO_STRING = {
-              connect: 'CONNECT',
-              delete: 'DELETE',
-              get: 'GET',
-              head: 'HEAD',
-              options: 'OPTIONS',
-              patch: 'PATCH',
-              post: 'POST',
-              put: 'PUT',
-              trace: 'TRACE'
-            }.freeze
             # Constant for the HTTP status range
             HTTP_STATUS_SUCCESS_RANGE = (100..399)
             def call(env)
-              http_method = HTTP_METHODS_SYMBOL_TO_STRING[env.method]
+              span_data = HttpHelper.span_attrs_for(env.method)
               config = Faraday::Instrumentation.instance.config
               attributes = span_creation_attributes(
-                http_method: http_method, url: env.url, config: config
+                http_method: span_data.normalized_method,
+                original_method: span_data.original_method,
+                url: env.url,
+                config: config
               )
               OpenTelemetry::Common::HTTP::ClientContext.with_attributes(attributes) do |attrs, _|
                 tracer.in_span(
-                  http_method, attributes: attrs, kind: config.fetch(:span_kind)
+                  span_data.span_name, attributes: attrs, kind: config.fetch(:span_kind)
                 ) do |span|
                   OpenTelemetry.propagation.inject(env.request_headers)
@@ -58,7 +50,7 @@ module OpenTelemetry
             private
-            def span_creation_attributes(http_method:, url:, config:)
+            def span_creation_attributes(http_method:, original_method:, url:, config:)
               cleansed_url = OpenTelemetry::Common::Utilities.cleanse_url(url.to_s)
               attrs = {
                 'http.method' => http_method,
@@ -67,6 +59,7 @@ module OpenTelemetry
                 'url.full' => cleansed_url,
                 'faraday.adapter.name' => app.class.name
               }
+              attrs['http.request.method_original'] = original_method if original_method
               if url.host
                 attrs['net.peer.name'] = url.host
                 attrs['server.address'] = url.host

data/lib/opentelemetry/instrumentation/faraday/middlewares/old/tracer_middleware.rb CHANGED Viewed

@@ -12,32 +12,21 @@ module OpenTelemetry
           # TracerMiddleware propagates context and instruments Faraday requests
           # by way of its middleware system
           class TracerMiddleware < ::Faraday::Middleware
-            HTTP_METHODS_SYMBOL_TO_STRING = {
-              connect: 'CONNECT',
-              delete: 'DELETE',
-              get: 'GET',
-              head: 'HEAD',
-              options: 'OPTIONS',
-              patch: 'PATCH',
-              post: 'POST',
-              put: 'PUT',
-              trace: 'TRACE'
-            }.freeze
             # Constant for the HTTP status range
             HTTP_STATUS_SUCCESS_RANGE = (100..399)
             def call(env)
-              http_method = HTTP_METHODS_SYMBOL_TO_STRING[env.method]
+              span_data = HttpHelper.span_attrs_for(env.method, semconv: :old)
               config = Faraday::Instrumentation.instance.config
               attributes = span_creation_attributes(
-                http_method: http_method, url: env.url, config: config
+                http_method: span_data.normalized_method, url: env.url, config: config
               )
               OpenTelemetry::Common::HTTP::ClientContext.with_attributes(attributes) do |attrs, _|
                 tracer.in_span(
-                  "HTTP #{http_method}", attributes: attrs, kind: config.fetch(:span_kind)
+                  span_data.span_name, attributes: attrs, kind: config.fetch(:span_kind)
                 ) do |span|
                   OpenTelemetry.propagation.inject(env.request_headers)

data/lib/opentelemetry/instrumentation/faraday/middlewares/stable/tracer_middleware.rb CHANGED Viewed

@@ -12,32 +12,24 @@ module OpenTelemetry
           # TracerMiddleware propagates context and instruments Faraday requests
           # by way of its middleware system
           class TracerMiddleware < ::Faraday::Middleware
-            HTTP_METHODS_SYMBOL_TO_STRING = {
-              connect: 'CONNECT',
-              delete: 'DELETE',
-              get: 'GET',
-              head: 'HEAD',
-              options: 'OPTIONS',
-              patch: 'PATCH',
-              post: 'POST',
-              put: 'PUT',
-              trace: 'TRACE'
-            }.freeze
             # Constant for the HTTP status range
             HTTP_STATUS_SUCCESS_RANGE = (100..399)
             def call(env)
-              http_method = HTTP_METHODS_SYMBOL_TO_STRING[env.method]
+              span_data = HttpHelper.span_attrs_for(env.method)
               config = Faraday::Instrumentation.instance.config
               attributes = span_creation_attributes(
-                http_method: http_method, url: env.url, config: config
+                http_method: span_data.normalized_method,
+                original_method: span_data.original_method,
+                url: env.url,
+                config: config
               )
               OpenTelemetry::Common::HTTP::ClientContext.with_attributes(attributes) do |attrs, _|
                 tracer.in_span(
-                  http_method, attributes: attrs, kind: config.fetch(:span_kind)
+                  span_data.span_name, attributes: attrs, kind: config.fetch(:span_kind)
                 ) do |span|
                   OpenTelemetry.propagation.inject(env.request_headers)
@@ -58,12 +50,13 @@ module OpenTelemetry
             private
-            def span_creation_attributes(http_method:, url:, config:)
+            def span_creation_attributes(http_method:, original_method:, url:, config:)
               attrs = {
                 'http.request.method' => http_method,
                 'url.full' => OpenTelemetry::Common::Utilities.cleanse_url(url.to_s),
                 'faraday.adapter.name' => app.class.name
               }
+              attrs['http.request.method_original'] = original_method if original_method
               attrs['server.address'] = url.host if url.host
               attrs['peer.service'] = config[:peer_service] if config[:peer_service]

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Faraday
-      VERSION = '0.30.0'
+      VERSION = '0.30.1'
     end
   end
 end

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

@@ -16,5 +16,6 @@ module OpenTelemetry
   end
 end
+require_relative 'faraday/http_helper'
 require_relative 'faraday/instrumentation'
 require_relative 'faraday/version'

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-faraday
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.30.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-22 00:00:00.000000000 Z
+date: 2025-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
@@ -38,6 +38,7 @@ files:
 - lib/opentelemetry-instrumentation-faraday.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/faraday.rb
+- lib/opentelemetry/instrumentation/faraday/http_helper.rb
 - lib/opentelemetry/instrumentation/faraday/instrumentation.rb
 - lib/opentelemetry/instrumentation/faraday/middlewares/dup/tracer_middleware.rb
 - lib/opentelemetry/instrumentation/faraday/middlewares/old/tracer_middleware.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-faraday/0.30.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-faraday/0.30.1/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/faraday
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-faraday/0.30.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-faraday/0.30.1
 post_install_message:
 rdoc_options: []
 require_paths: