opentelemetry-instrumentation-faraday 0.24.7 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20a6c27bd32e03816e148c6050bd99b8d74afadb2f124bb10803713a64da2898
-  data.tar.gz: 4e3527bd8c32cefdf46884a33d890d8adaa1924e393debecc36b373d745cc01f
+  metadata.gz: ef531ecfdcc07ba765a21743d3787b8d6de244b2b371241cd5121d775c7c679b
+  data.tar.gz: 33df6f2dd61589ffdf001c3577679f944b52ff2d287fcf6cfc456f3de3f28cae
 SHA512:
-  metadata.gz: 76751c9103de72eb650e63304db6f65ea671ad01f13e9e0d82274409567ed6590563dbaab3ef472e538ca79cc44885aceb0f8358e85a5eaca00fb0df10206aee
-  data.tar.gz: a44df86fd9da95d6e34f441d901fa9a8e33165f33af528eacd9a1627f19b3c648383edae731fa2a4b0e860e56d49d04934dd814f947d52797ca418c34bee073f
+  metadata.gz: 287d1fd9d8468da07f37b2ba1c2af2292a88f0fc34bd581111c4dbd7d5e375d9f72260de1b10ec74ff690bf2913d73c2e4da829c047df05472e12aa2bc2cc858
+  data.tar.gz: 657f53bae563c8f50ae349e30e56411292f2e5be8a7bc910eb4506aa8eff8c6f3df6f8e46be085de9032869439ed68d3ff203180ae101addb4840a4800e2b6fe

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-faraday
 
+### v0.25.0 / 2025-01-07
+
+* ADDED: Faraday Minimum v1.0
+
+### v0.24.8 / 2024-12-17
+
+* FIXED: Share Faraday Attrs with Adapter Spans
+
 ### v0.24.7 / 2024-11-26
 
 * CHANGED: Performance Freeze all range objects #1222

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

@@ -10,12 +10,18 @@ module OpenTelemetry
       # The Instrumentation class contains logic to detect and install the Faraday
       # instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
+        MINIMUM_VERSION = Gem::Version.new('1.0')
+
         install do |_config|
           require_dependencies
           register_tracer_middleware
           use_middleware_by_default
         end
 
+        compatible do
+          gem_version >= MINIMUM_VERSION
+        end
+
         present do
           defined?(::Faraday)
         end
@@ -25,10 +31,13 @@ module OpenTelemetry
 
         private
 
+        def gem_version
+          Gem::Version.new(::Faraday::VERSION)
+        end
+
         def require_dependencies
           require_relative 'middlewares/tracer_middleware'
           require_relative 'patches/connection'
-          require_relative 'patches/rack_builder'
         end
 
         def register_tracer_middleware
@@ -38,11 +47,7 @@ module OpenTelemetry
         end
 
         def use_middleware_by_default
-          if Gem::Version.new(::Faraday::VERSION) >= Gem::Version.new('1')
-            ::Faraday::Connection.prepend(Patches::Connection)
-          else
-            ::Faraday::RackBuilder.prepend(Patches::RackBuilder)
-          end
+          ::Faraday::Connection.prepend(Patches::Connection)
         end
       end
     end

data/lib/opentelemetry/instrumentation/faraday/middlewares/tracer_middleware.rb

@@ -33,31 +33,34 @@ module OpenTelemetry
             attributes = span_creation_attributes(
               http_method: http_method, url: env.url, config: config
             )
-            tracer.in_span(
-              "HTTP #{http_method}", attributes: attributes, kind: config.fetch(:span_kind)
-            ) do |span|
-              OpenTelemetry.propagation.inject(env.request_headers)
 
-              app.call(env).on_complete { |resp| trace_response(span, resp.status) }
-            rescue ::Faraday::Error => e
-              trace_response(span, e.response[:status]) if e.response
+            OpenTelemetry::Common::HTTP::ClientContext.with_attributes(attributes) do |attrs, _|
+              tracer.in_span(
+                "HTTP #{http_method}", attributes: attrs, kind: config.fetch(:span_kind)
+              ) do |span|
+                OpenTelemetry.propagation.inject(env.request_headers)
 
-              raise
+                app.call(env).on_complete { |resp| trace_response(span, resp.status) }
+              rescue ::Faraday::Error => e
+                trace_response(span, e.response[:status]) if e.response
+
+                raise
+              end
             end
           end
 
           private
 
           def span_creation_attributes(http_method:, url:, config:)
-            instrumentation_attrs = {
+            attrs = {
               'http.method' => http_method,
               'http.url' => OpenTelemetry::Common::Utilities.cleanse_url(url.to_s),
               'faraday.adapter.name' => app.class.name
             }
-            instrumentation_attrs['net.peer.name'] = url.host if url.host
-            instrumentation_attrs['peer.service'] = config[:peer_service] if config[:peer_service]
+            attrs['net.peer.name'] = url.host if url.host
+            attrs['peer.service'] = config[:peer_service] if config[:peer_service]
 
-            instrumentation_attrs.merge!(
+            attrs.merge!(
               OpenTelemetry::Common::HTTP::ClientContext.attributes
             )
           end

data/lib/opentelemetry/instrumentation/faraday/patches/connection.rb

@@ -13,7 +13,7 @@ module OpenTelemetry
         module Connection
           # Wraps Faraday::Connection#initialize:
           # https://github.com/lostisland/faraday/blob/ff9dc1d1219a1bbdba95a9a4cf5d135b97247ee2/lib/faraday/connection.rb#L62-L92
-          def initialize(*args)
+          def initialize(...)
             super.tap do
               use(:open_telemetry) unless builder.handlers.any? do |handler|
                 handler.klass == Middlewares::TracerMiddleware

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Faraday
-      VERSION = '0.24.7'
+      VERSION = '0.25.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-faraday
 version: !ruby/object:Gem::Version
-  version: 0.24.7
+  version: 0.25.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2025-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.68.0
+        version: 1.69.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.68.0
+        version: 1.69.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -195,17 +195,16 @@ files:
 - lib/opentelemetry/instrumentation/faraday/instrumentation.rb
 - lib/opentelemetry/instrumentation/faraday/middlewares/tracer_middleware.rb
 - lib/opentelemetry/instrumentation/faraday/patches/connection.rb
-- lib/opentelemetry/instrumentation/faraday/patches/rack_builder.rb
 - lib/opentelemetry/instrumentation/faraday/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-faraday/0.24.7/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-faraday/0.25.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.24.7
-post_install_message: 
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-faraday/0.25.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -221,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.33
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Faraday instrumentation for the OpenTelemetry framework
 test_files: []

data/lib/opentelemetry/instrumentation/faraday/patches/rack_builder.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    module Faraday
-      module Patches
-        # Module to be prepended to force Faraday to use the middleware by
-        # default so the user doesn't have to call `use` for every connection.
-        module RackBuilder
-          def adapter(*args)
-            use(:open_telemetry) unless @handlers.any? do |handler|
-              handler.klass == Faraday::Middlewares::TracerMiddleware
-            end
-
-            super
-          end
-        end
-      end
-    end
-  end
-end