opentelemetry-instrumentation-faraday 0.26.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c5efeefd5e82f8c908e902d93a843f819c1f305577374037b087b94157edc31
-  data.tar.gz: '099811f33339f13777cd9f96e9e76a93501265b155f6099a755a8b91c2b142cf'
+  metadata.gz: b79cd4f94a4533971dc6e87e0b7b385be4905ba2fd29ff28483184929c680c03
+  data.tar.gz: 5cf513bb53039de6901d33d7327c97b4b539cea350e557da09bafa74a5684af3
 SHA512:
-  metadata.gz: 3539521f62e688c20164ed762915bbd829e00182d277ebd13643176baf47ff633d7dc0a8d6046f9a77c433eeff0c13701d27c340ec46495a316c9693edac8879
-  data.tar.gz: d5d6891ca5c17764b116519df79c0a5542c5d15feba8353975600e8b8e2359ff1df9e86f3fcf9524ef80b67ef0c21ecd152a826e076538a7e235cee5d76d7cef
+  metadata.gz: 5598c9c8d064e90594e9ad8e4a299bfafe1acb51fb3b5ab23366bfbe6f9761d136b740019c6ad60d25ace28cc9021daac72f1be079f84f3bd4d7777701f87af2
+  data.tar.gz: 82180c8e8cf09fd3bcb3c37df9569fbf55cf951a39b560a74ca882d265e14946d2edde143893815fb1c71f8815a205cfed5bfd786fb1306846cac2c478582c41

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-faraday
 
+### v0.28.0 / 2025-08-12
+
+* ADDED: Add Faraday `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable [#1592](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/1592)
+
+### v0.27.0 / 2025-06-03
+
+* ADDED: Suppress internal spans with Faraday instrumentation
+
 ### v0.26.0 / 2025-01-16
 
 * BREAKING CHANGE: Set minimum supported version to Ruby 3.1

data/README.md

@@ -18,7 +18,9 @@ To install the instrumentation, call `use` with the name of the instrumentation.
 
 ```ruby
 OpenTelemetry::SDK.configure do |c|
-  c.use 'OpenTelemetry::Instrumentation::Faraday'
+  c.use 'OpenTelemetry::Instrumentation::Faraday', {
+    enable_internal_instrumentation: false
+  }
 end
 ```
 
@@ -30,9 +32,14 @@ OpenTelemetry::SDK.configure do |c|
 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.
+
 ## Examples
 
-Example usage of faraday can be seen in the `./example/faraday.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/faraday/example/faraday.rb)
+Example usage of faraday can be seen in the [`./example/faraday.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/faraday/example/faraday.rb)
 
 ## How can I get involved?
 
@@ -52,3 +59,19 @@ Apache 2.0 license. See [LICENSE][license-github] for more information.
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
 [slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
+
+## HTTP semantic convention stability
+
+In the OpenTelemetry ecosystem, HTTP semantic conventions have now reached a stable state. However, the initial Faraday instrumentation was introduced before this stability was achieved, which resulted in HTTP attributes being based on an older version of the semantic conventions.
+
+To facilitate the migration to stable semantic conventions, you can use the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable. This variable allows you to opt-in to the new stable conventions, ensuring compatibility and future-proofing your instrumentation.
+
+When setting the value for `OTEL_SEMCONV_STABILITY_OPT_IN`, you can specify which conventions you wish to adopt:
+
+- `http` - Emits the stable HTTP and networking conventions and ceases emitting the old conventions previously emitted by the instrumentation.
+- `http/dup` - Emits both the old and stable HTTP and networking conventions, enabling a phased rollout of the stable semantic conventions.
+- Default behavior (in the absence of either value) is to continue emitting the old HTTP and networking conventions the instrumentation previously emitted.
+
+During the transition from old to stable conventions, Faraday instrumentation code comes in three patch versions: `dup`, `old`, and `stable`. These versions are identical except for the attributes they send. Any changes to Faraday 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/).

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

@@ -13,9 +13,10 @@ module OpenTelemetry
         MINIMUM_VERSION = Gem::Version.new('1.0')
 
         install do |_config|
-          require_dependencies
-          register_tracer_middleware
-          use_middleware_by_default
+          patch_type = determine_semconv
+          send(:"require_dependencies_#{patch_type}")
+          send(:"register_tracer_middleware_#{patch_type}")
+          send(:"use_middleware_by_default_#{patch_type}")
         end
 
         compatible do
@@ -28,6 +29,7 @@ module OpenTelemetry
 
         option :span_kind, default: :client, validate: %i[client internal]
         option :peer_service, default: nil, validate: :string
+        option :enable_internal_instrumentation, default: false, validate: :boolean
 
         private
 
@@ -35,19 +37,62 @@ module OpenTelemetry
           Gem::Version.new(::Faraday::VERSION)
         end
 
-        def require_dependencies
-          require_relative 'middlewares/tracer_middleware'
-          require_relative 'patches/connection'
+        def determine_semconv
+          stability_opt_in = ENV.fetch('OTEL_SEMCONV_STABILITY_OPT_IN', '')
+          values = stability_opt_in.split(',').map(&:strip)
+
+          if values.include?('http/dup')
+            'dup'
+          elsif values.include?('http')
+            'stable'
+          else
+            'old'
+          end
+        end
+
+        def require_dependencies_dup
+          require_relative 'middlewares/dup/tracer_middleware'
+          require_relative 'patches/dup/connection'
+        end
+
+        def require_dependencies_old
+          require_relative 'middlewares/old/tracer_middleware'
+          require_relative 'patches/old/connection'
         end
 
-        def register_tracer_middleware
+        def require_dependencies_stable
+          require_relative 'middlewares/stable/tracer_middleware'
+          require_relative 'patches/stable/connection'
+        end
+
+        def register_tracer_middleware_dup
           ::Faraday::Middleware.register_middleware(
-            open_telemetry: Middlewares::TracerMiddleware
+            open_telemetry: Middlewares::Dup::TracerMiddleware
           )
         end
 
-        def use_middleware_by_default
-          ::Faraday::Connection.prepend(Patches::Connection)
+        def register_tracer_middleware_old
+          ::Faraday::Middleware.register_middleware(
+            open_telemetry: Middlewares::Old::TracerMiddleware
+          )
+        end
+
+        def register_tracer_middleware_stable
+          ::Faraday::Middleware.register_middleware(
+            open_telemetry: Middlewares::Stable::TracerMiddleware
+          )
+        end
+
+        def use_middleware_by_default_dup
+          ::Faraday::Connection.prepend(Patches::Dup::Connection)
+        end
+
+        def use_middleware_by_default_old
+          ::Faraday::Connection.prepend(Patches::Old::Connection)
+        end
+
+        def use_middleware_by_default_stable
+          ::Faraday::Connection.prepend(Patches::Stable::Connection)
         end
       end
     end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Faraday
+      module Middlewares
+        module Dup
+          # 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]
+              config = Faraday::Instrumentation.instance.config
+
+              attributes = span_creation_attributes(
+                http_method: http_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)
+                ) do |span|
+                  OpenTelemetry.propagation.inject(env.request_headers)
+
+                  if config[:enable_internal_instrumentation] == false
+                    OpenTelemetry::Common::Utilities.untraced do
+                      app.call(env).on_complete { |resp| trace_response(span, resp.status) }
+                    end
+                  else
+                    app.call(env).on_complete { |resp| trace_response(span, resp.status) }
+                  end
+                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:)
+              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
+              }
+              if url.host
+                attrs['net.peer.name'] = url.host
+                attrs['server.address'] = url.host
+              end
+              attrs['peer.service'] = config[:peer_service] if config[:peer_service]
+
+              attrs.merge!(
+                OpenTelemetry::Common::HTTP::ClientContext.attributes
+              )
+            end
+
+            # Versions prior to 1.0 do not define an accessor for app
+            attr_reader :app if Gem::Version.new(Faraday::VERSION) < Gem::Version.new('1.0.0')
+
+            def tracer
+              Faraday::Instrumentation.instance.tracer
+            end
+
+            def trace_response(span, status)
+              span.set_attribute('http.status_code', status)
+              span.set_attribute('http.response.status_code', status)
+              span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(status.to_i)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Faraday
+      module Middlewares
+        module Old
+          # 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]
+              config = Faraday::Instrumentation.instance.config
+
+              attributes = span_creation_attributes(
+                http_method: http_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)
+                ) do |span|
+                  OpenTelemetry.propagation.inject(env.request_headers)
+
+                  if config[:enable_internal_instrumentation] == false
+                    OpenTelemetry::Common::Utilities.untraced do
+                      app.call(env).on_complete { |resp| trace_response(span, resp.status) }
+                    end
+                  else
+                    app.call(env).on_complete { |resp| trace_response(span, resp.status) }
+                  end
+                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:)
+              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
+              )
+            end
+
+            # Versions prior to 1.0 do not define an accessor for app
+            attr_reader :app if Gem::Version.new(Faraday::VERSION) < Gem::Version.new('1.0.0')
+
+            def tracer
+              Faraday::Instrumentation.instance.tracer
+            end
+
+            def trace_response(span, status)
+              span.set_attribute('http.status_code', status)
+              span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(status.to_i)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Faraday
+      module Middlewares
+        module Stable
+          # 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]
+              config = Faraday::Instrumentation.instance.config
+
+              attributes = span_creation_attributes(
+                http_method: http_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)
+                ) do |span|
+                  OpenTelemetry.propagation.inject(env.request_headers)
+
+                  if config[:enable_internal_instrumentation] == false
+                    OpenTelemetry::Common::Utilities.untraced do
+                      app.call(env).on_complete { |resp| trace_response(span, resp.status) }
+                    end
+                  else
+                    app.call(env).on_complete { |resp| trace_response(span, resp.status) }
+                  end
+                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:)
+              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
+              )
+            end
+
+            # Versions prior to 1.0 do not define an accessor for app
+            attr_reader :app if Gem::Version.new(Faraday::VERSION) < Gem::Version.new('1.0.0')
+
+            def tracer
+              Faraday::Instrumentation.instance.tracer
+            end
+
+            def trace_response(span, status)
+              span.set_attribute('http.response.status_code', status)
+              span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(status.to_i)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Faraday
+      module Patches
+        module Dup
+          # 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 Connection
+            # Wraps Faraday::Connection#initialize:
+            # https://github.com/lostisland/faraday/blob/ff9dc1d1219a1bbdba95a9a4cf5d135b97247ee2/lib/faraday/connection.rb#L62-L92
+            def initialize(...)
+              super.tap do
+                use(:open_telemetry) unless builder.handlers.any? do |handler|
+                  handler.klass == Middlewares::Dup::TracerMiddleware
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Faraday
+      module Patches
+        module Old
+          # 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 Connection
+            # Wraps Faraday::Connection#initialize:
+            # https://github.com/lostisland/faraday/blob/ff9dc1d1219a1bbdba95a9a4cf5d135b97247ee2/lib/faraday/connection.rb#L62-L92
+            def initialize(...)
+              super.tap do
+                use(:open_telemetry) unless builder.handlers.any? do |handler|
+                  handler.klass == Middlewares::Old::TracerMiddleware
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Faraday
+      module Patches
+        module Stable
+          # 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 Connection
+            # Wraps Faraday::Connection#initialize:
+            # https://github.com/lostisland/faraday/blob/ff9dc1d1219a1bbdba95a9a4cf5d135b97247ee2/lib/faraday/connection.rb#L62-L92
+            def initialize(...)
+              super.tap do
+                use(:open_telemetry) unless builder.handlers.any? do |handler|
+                  handler.klass == Middlewares::Stable::TracerMiddleware
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Faraday
-      VERSION = '0.26.0'
+      VERSION = '0.28.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-faraday
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.28.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -38,146 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.23.0
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: opentelemetry-sdk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: opentelemetry-test-helpers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.69.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.69.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.23.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.23.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.24.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.24.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 description: Faraday instrumentation for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -193,17 +53,21 @@ files:
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/faraday.rb
 - 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/middlewares/dup/tracer_middleware.rb
+- lib/opentelemetry/instrumentation/faraday/middlewares/old/tracer_middleware.rb
+- lib/opentelemetry/instrumentation/faraday/middlewares/stable/tracer_middleware.rb
+- lib/opentelemetry/instrumentation/faraday/patches/dup/connection.rb
+- lib/opentelemetry/instrumentation/faraday/patches/old/connection.rb
+- lib/opentelemetry/instrumentation/faraday/patches/stable/connection.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.26.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-faraday/0.28.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.26.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-faraday/0.28.0
 post_install_message:
 rdoc_options: []
 require_paths:

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

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    module Faraday
-      module Middlewares
-        # 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]
-            config = Faraday::Instrumentation.instance.config
-
-            attributes = span_creation_attributes(
-              http_method: http_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)
-              ) 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
-
-                raise
-              end
-            end
-          end
-
-          private
-
-          def span_creation_attributes(http_method:, 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
-            )
-          end
-
-          # Versions prior to 1.0 do not define an accessor for app
-          attr_reader :app if Gem::Version.new(Faraday::VERSION) < Gem::Version.new('1.0.0')
-
-          def tracer
-            Faraday::Instrumentation.instance.tracer
-          end
-
-          def trace_response(span, status)
-            span.set_attribute('http.status_code', status)
-            span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(status.to_i)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +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 Connection
-          # Wraps Faraday::Connection#initialize:
-          # https://github.com/lostisland/faraday/blob/ff9dc1d1219a1bbdba95a9a4cf5d135b97247ee2/lib/faraday/connection.rb#L62-L92
-          def initialize(...)
-            super.tap do
-              use(:open_telemetry) unless builder.handlers.any? do |handler|
-                handler.klass == Middlewares::TracerMiddleware
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end