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

opentelemetry-instrumentation-faraday 0.30.0 → 0.31.0

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 (10) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bafda9fd097097c56f5eb2c496fcb13459545eac94ef35af88e75cfb60f4855
-  data.tar.gz: 551305837597a22d74899fb2b761c351ecd429ed71e655f1ba9100cc002ec6e4
+  metadata.gz: 46f7fa87e08e43feb21e52ad6cd99a410b0970f296f92b49c70a9b9d80780467
+  data.tar.gz: a0e21b9ba9a4e5e85cade98b944857e3d3849715712743acfe920da964d0d76b
 SHA512:
-  metadata.gz: a299a184c319f45a6a119d5243bf48e76c7b13795f570079d559e428de05bf9f47d9a34e3c37b9d3c6551f4169d1a800dbcbd25ebc9bfede2b0822edc62388f3
-  data.tar.gz: 7d80941dd09d0702597c45e72f2a86df677a8f845e458db0459706899dcca23069d594c738e6651e19d319ed8e992e46894f54236f0fa509664d1a7a204d6e01
+  metadata.gz: 0bc58f394b3a670801edb54a6e7e14680ce3eab49342a4d3019902fc2a909278db3f4d4c02179f44bc93b1b23308d05ed21f6dda0ccfd61b71864040ee0487fd
+  data.tar.gz: 3bceb71ba3361ccfd4260cb2631cf983977d3619444ace55d6f77725f10b70e3f918c01740612409fb0aa069a1b6011b7acf8336a6d9301b30b4aafc6bd9ac18

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-faraday
+### v0.31.0 / 2026-01-13
+* ADDED: HTTP Client Semconv v1.17 Span Naming
+### 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/README.md CHANGED Viewed

@@ -33,9 +33,11 @@ end
 ```
 ### Configuration options
-This instrumentation offers the following configuration options:
-* `enable_internal_instrumentation` (default: `false`): When set to `true`, any spans with
- span kind of `internal` are included in traces.
+This instrumentation offers the following configuration options:
+- `enable_internal_instrumentation` (default: `false`): When set to `true`, any spans with
+  span kind of `internal` are included in traces.
 ## Examples

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

@@ -0,0 +1,136 @@
+# 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, :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
+        module_function
+        # Prepares span data using old semantic conventions
+        # @param method [String, Symbol] The HTTP method
+        # @return [SpanCreationAttributes] struct containing span_name and attributes hash
+        def 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 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 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/faraday/middlewares/dup/tracer_middleware.rb CHANGED Viewed

@@ -12,32 +12,20 @@ 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_dup(env.method)
               config = Faraday::Instrumentation.instance.config
-              attributes = span_creation_attributes(
-                http_method: http_method, url: env.url, config: config
-              )
+              attributes = span_creation_attributes(url: env.url, config: config)
+              attributes.merge!(span_data.attributes)
               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,11 +46,9 @@ module OpenTelemetry
             private
-            def span_creation_attributes(http_method:, url:, config:)
+            def span_creation_attributes(url:, config:)
               cleansed_url = OpenTelemetry::Common::Utilities.cleanse_url(url.to_s)
               attrs = {
-                'http.method' => http_method,
-                'http.request.method' => http_method,
                 'http.url' => cleansed_url,
                 'url.full' => cleansed_url,
                 'faraday.adapter.name' => app.class.name
@@ -73,9 +59,7 @@ module OpenTelemetry
               end
               attrs['peer.service'] = config[:peer_service] if config[:peer_service]
-              attrs.merge!(
-                OpenTelemetry::Common::HTTP::ClientContext.attributes
-              )
+              attrs
             end
             # Versions prior to 1.0 do not define an accessor for app

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

@@ -12,32 +12,20 @@ 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_old(env.method)
               config = Faraday::Instrumentation.instance.config
-              attributes = span_creation_attributes(
-                http_method: http_method, url: env.url, config: config
-              )
+              attributes = span_creation_attributes(url: env.url, config: config)
+              attributes.merge!(span_data.attributes)
               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)
@@ -58,18 +46,15 @@ module OpenTelemetry
             private
-            def span_creation_attributes(http_method:, url:, config:)
+            def span_creation_attributes(url:, config:)
               attrs = {
-                'http.method' => http_method,
                 'http.url' => OpenTelemetry::Common::Utilities.cleanse_url(url.to_s),
                 'faraday.adapter.name' => app.class.name
               }
               attrs['net.peer.name'] = url.host if url.host
               attrs['peer.service'] = config[:peer_service] if config[:peer_service]
-              attrs.merge!(
-                OpenTelemetry::Common::HTTP::ClientContext.attributes
-              )
+              attrs
             end
             # Versions prior to 1.0 do not define an accessor for app

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

@@ -12,32 +12,20 @@ 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_stable(env.method)
               config = Faraday::Instrumentation.instance.config
-              attributes = span_creation_attributes(
-                http_method: http_method, url: env.url, config: config
-              )
+              attributes = span_creation_attributes(url: env.url, config: config)
+              attributes.merge!(span_data.attributes)
               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,18 +46,15 @@ module OpenTelemetry
             private
-            def span_creation_attributes(http_method:, url:, config:)
+            def span_creation_attributes(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['server.address'] = url.host if url.host
               attrs['peer.service'] = config[:peer_service] if config[:peer_service]
-              attrs.merge!(
-                OpenTelemetry::Common::HTTP::ClientContext.attributes
-              )
+              attrs
             end
             # Versions prior to 1.0 do not define an accessor for app

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.31.0'
     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.31.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-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.31.0/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.31.0
 post_install_message:
 rdoc_options: []
 require_paths: