opentelemetry-instrumentation-ethon 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5da94e8bf071f770f1bed046b0a7766e14380162d72a6d5e5ed2d32d386aaea2
-  data.tar.gz: 974c11a490e18fbe95826cd9cb2929d253c7d217baf25d9bc627a9444b51c5f6
+  metadata.gz: 8bbbe66773c8fce6953073cbd3abc9ed960cedc72dab5d23b58681f2970b6d1f
+  data.tar.gz: 1decc400420cc2a26de71704e789a91dbd1db8a264fb105f1f6cb62bb3f26be6
 SHA512:
-  metadata.gz: 0e31a35b06cbb27f95f0a6f07a7198244b6513e640f009ec66a190cae0a4413e2f38219c187cd9ee99675d26a4b329f10f7e91212f90c08d6db3e3b03ac6fc99
-  data.tar.gz: b3d37196e2a1774e90f50050df1be49966fff0b43cbd2db2513ea0a955c122793a591dc08151fea1e6a95f8f662afe57677a3532c71aa0354376ac8390b57d45
+  metadata.gz: 4977551e5520240c119eca62427f21e493b35f48e3033e370517679ad21050187a4352468944f590ee62cc25aaa7e5d55ee51eb239fd457ce5408dcdd0de7493
+  data.tar.gz: 6c35ebff6e824bbc848db16c7094906fe2b36d3756583d899164c809b91fe6951c1b74b1095169b96a347b245933e4b6bf8a9fae3507d29d7093111c45d64116

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-ethon
 
+### v0.23.0 / 2025-07-29
+
+* ADDED: Add Ethon `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable [#1561](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/1561)
+
 ### v0.22.0 / 2025-01-16
 
 * BREAKING CHANGE: Set minimum supported version to Ruby 3.1

data/README.md

@@ -32,7 +32,7 @@ end
 
 ## Examples
 
-Example usage of faraday can be seen in the `./example/ethon.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/ethon/example/ethon.rb)
+Example usage of faraday can be seen in the [`./example/ethon.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/ethon/example/ethon.rb)
 
 ## How can I get involved?
 
@@ -52,3 +52,19 @@ The `opentelemetry-instrumentation-all` gem is distributed under the Apache 2.0
 [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 Ethon 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, Ethon instrumentation code comes in three patch versions: `dup`, `old`, and `stable`. These versions are identical except for the attributes they send. Any changes to Ethon 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/ethon/instrumentation.rb

@@ -11,8 +11,9 @@ module OpenTelemetry
       # instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
         install do |_config|
-          require_dependencies
-          add_patches
+          patch_type = determine_semconv
+          send(:"require_dependencies_#{patch_type}")
+          send(:"add_patches_#{patch_type}")
         end
 
         present do
@@ -23,13 +24,46 @@ module OpenTelemetry
 
         private
 
-        def require_dependencies
-          require_relative 'patches/easy'
+        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 'patches/dup/easy'
+          require_relative 'patches/multi'
+        end
+
+        def require_dependencies_stable
+          require_relative 'patches/stable/easy'
           require_relative 'patches/multi'
         end
 
-        def add_patches
-          ::Ethon::Easy.prepend(Patches::Easy)
+        def require_dependencies_old
+          require_relative 'patches/old/easy'
+          require_relative 'patches/multi'
+        end
+
+        def add_patches_dup
+          ::Ethon::Easy.prepend(Patches::Dup::Easy)
+          ::Ethon::Multi.prepend(Patches::Multi)
+        end
+
+        def add_patches_stable
+          ::Ethon::Easy.prepend(Patches::Stable::Easy)
+          ::Ethon::Multi.prepend(Patches::Multi)
+        end
+
+        def add_patches_old
+          ::Ethon::Easy.prepend(Patches::Old::Easy)
           ::Ethon::Multi.prepend(Patches::Multi)
         end
       end

data/lib/opentelemetry/instrumentation/ethon/patches/dup/easy.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Ethon
+      module Patches
+        # Module using old and stable HTTP semantic conventions
+        module Dup
+          # Ethon::Easy patch for instrumentation
+          module Easy
+            ACTION_NAMES_TO_HTTP_METHODS = Hash.new do |h, k|
+              # #to_s is required because user input could be symbol or string
+              h[k] = k.to_s.upcase
+            end
+            HTTP_METHODS_TO_SPAN_NAMES = Hash.new do |h, k|
+              h[k] = k.to_s
+              h[k] = 'HTTP' if k == '_OTHER'
+            end
+
+            # Constant for the HTTP status range
+            HTTP_STATUS_SUCCESS_RANGE = (100..399)
+
+            def http_request(url, action_name, options = {})
+              @otel_method = ACTION_NAMES_TO_HTTP_METHODS[action_name]
+              super
+            end
+
+            def headers=(headers)
+              # Store headers to call this method again when span is ready
+              @otel_original_headers = headers
+              super
+            end
+
+            def perform
+              otel_before_request
+              super
+            end
+
+            def complete
+              begin
+                response_options = mirror.options
+                response_code = (response_options[:response_code] || response_options[:code]).to_i
+                if response_code.zero?
+                  return_code = response_options[:return_code]
+                  message = return_code ? ::Ethon::Curl.easy_strerror(return_code) : 'unknown reason'
+                  @otel_span.status = OpenTelemetry::Trace::Status.error("Request has failed: #{message}")
+                else
+                  @otel_span.set_attribute('http.status_code', response_code)
+                  @otel_span.set_attribute('http.response.status_code', response_code)
+                  @otel_span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(response_code.to_i)
+                end
+              ensure
+                @otel_span&.finish
+                @otel_span = nil
+              end
+              super
+            end
+
+            def reset
+              super
+            ensure
+              @otel_span = nil
+              @otel_method = nil
+              @otel_original_headers = nil
+            end
+
+            def otel_before_request
+              method = '_OTHER' # Could be GET or not HTTP at all
+              method = @otel_method if instance_variable_defined?(:@otel_method) && !@otel_method.nil?
+
+              @otel_span = tracer.start_span(
+                HTTP_METHODS_TO_SPAN_NAMES[method],
+                attributes: span_creation_attributes(method),
+                kind: :client
+              )
+
+              @otel_original_headers ||= {}
+              OpenTelemetry::Trace.with_span(@otel_span) do
+                OpenTelemetry.propagation.inject(@otel_original_headers)
+              end
+              self.headers = @otel_original_headers
+            end
+
+            def otel_span_started?
+              instance_variable_defined?(:@otel_span) && !@otel_span.nil?
+            end
+
+            private
+
+            def span_creation_attributes(method)
+              http_method = (method == '_OTHER' ? 'N/A' : method)
+              instrumentation_attrs = {
+                'http.method' => http_method,
+                'http.request.method' => method
+              }
+
+              uri = _otel_cleanse_uri(url)
+              if uri
+                instrumentation_attrs['http.url'] = uri.to_s
+                instrumentation_attrs['url.full'] = uri.to_s
+                instrumentation_attrs['net.peer.name'] = uri.host if uri.host
+                instrumentation_attrs['server.address'] = uri.host if uri.host
+              end
+
+              config = Ethon::Instrumentation.instance.config
+              instrumentation_attrs['peer.service'] = config[:peer_service] if config[:peer_service]
+              instrumentation_attrs.merge!(
+                OpenTelemetry::Common::HTTP::ClientContext.attributes
+              )
+            end
+
+            # Returns a URL string with userinfo removed.
+            #
+            # @param [String] url The URL string to cleanse.
+            #
+            # @return [String] the cleansed URL.
+            def _otel_cleanse_uri(url)
+              cleansed_url = URI.parse(url)
+              cleansed_url.password = nil
+              cleansed_url.user = nil
+              cleansed_url
+            rescue URI::Error
+              nil
+            end
+
+            def tracer
+              Ethon::Instrumentation.instance.tracer
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/ethon/patches/old/easy.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Ethon
+      module Patches
+        # Module using old HTTP semantic conventions
+        module Old
+          # Ethon::Easy patch for instrumentation
+          module Easy
+            ACTION_NAMES_TO_HTTP_METHODS = Hash.new do |h, k|
+              # #to_s is required because user input could be symbol or string
+              h[k] = k.to_s.upcase
+            end
+            HTTP_METHODS_TO_SPAN_NAMES = Hash.new { |h, k| h[k] = "HTTP #{k}" }
+
+            # Constant for the HTTP status range
+            HTTP_STATUS_SUCCESS_RANGE = (100..399)
+
+            def http_request(url, action_name, options = {})
+              @otel_method = ACTION_NAMES_TO_HTTP_METHODS[action_name]
+              super
+            end
+
+            def headers=(headers)
+              # Store headers to call this method again when span is ready
+              @otel_original_headers = headers
+              super
+            end
+
+            def perform
+              otel_before_request
+              super
+            end
+
+            def complete
+              begin
+                response_options = mirror.options
+                response_code = (response_options[:response_code] || response_options[:code]).to_i
+                if response_code.zero?
+                  return_code = response_options[:return_code]
+                  message = return_code ? ::Ethon::Curl.easy_strerror(return_code) : 'unknown reason'
+                  @otel_span.status = OpenTelemetry::Trace::Status.error("Request has failed: #{message}")
+                else
+                  @otel_span.set_attribute('http.status_code', response_code)
+                  @otel_span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(response_code.to_i)
+                end
+              ensure
+                @otel_span&.finish
+                @otel_span = nil
+              end
+              super
+            end
+
+            def reset
+              super
+            ensure
+              @otel_span = nil
+              @otel_method = nil
+              @otel_original_headers = nil
+            end
+
+            def otel_before_request
+              method = 'N/A' # Could be GET or not HTTP at all
+              method = @otel_method if instance_variable_defined?(:@otel_method) && !@otel_method.nil?
+
+              @otel_span = tracer.start_span(
+                HTTP_METHODS_TO_SPAN_NAMES[method],
+                attributes: span_creation_attributes(method),
+                kind: :client
+              )
+
+              @otel_original_headers ||= {}
+              OpenTelemetry::Trace.with_span(@otel_span) do
+                OpenTelemetry.propagation.inject(@otel_original_headers)
+              end
+              self.headers = @otel_original_headers
+            end
+
+            def otel_span_started?
+              instance_variable_defined?(:@otel_span) && !@otel_span.nil?
+            end
+
+            private
+
+            def span_creation_attributes(method)
+              instrumentation_attrs = {
+                'http.method' => method
+              }
+
+              uri = _otel_cleanse_uri(url)
+              if uri
+                instrumentation_attrs['http.url'] = uri.to_s
+                instrumentation_attrs['net.peer.name'] = uri.host if uri.host
+              end
+
+              config = Ethon::Instrumentation.instance.config
+              instrumentation_attrs['peer.service'] = config[:peer_service] if config[:peer_service]
+              instrumentation_attrs.merge!(
+                OpenTelemetry::Common::HTTP::ClientContext.attributes
+              )
+            end
+
+            # Returns a URL string with userinfo removed.
+            #
+            # @param [String] url The URL string to cleanse.
+            #
+            # @return [String] the cleansed URL.
+            def _otel_cleanse_uri(url)
+              cleansed_url = URI.parse(url)
+              cleansed_url.password = nil
+              cleansed_url.user = nil
+              cleansed_url
+            rescue URI::Error
+              nil
+            end
+
+            def tracer
+              Ethon::Instrumentation.instance.tracer
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/ethon/patches/stable/easy.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module Ethon
+      module Patches
+        # Module using stable HTTP semantic conventions
+        module Stable
+          # Ethon::Easy patch for instrumentation
+          module Easy
+            ACTION_NAMES_TO_HTTP_METHODS = Hash.new do |h, k|
+              # #to_s is required because user input could be symbol or string
+              h[k] = k.to_s.upcase
+            end
+            HTTP_METHODS_TO_SPAN_NAMES = Hash.new do |h, k|
+              h[k] = k.to_s
+              h[k] = 'HTTP' if k == '_OTHER'
+            end
+
+            # Constant for the HTTP status range
+            HTTP_STATUS_SUCCESS_RANGE = (100..399)
+
+            def http_request(url, action_name, options = {})
+              @otel_method = ACTION_NAMES_TO_HTTP_METHODS[action_name]
+              super
+            end
+
+            def headers=(headers)
+              # Store headers to call this method again when span is ready
+              @otel_original_headers = headers
+              super
+            end
+
+            def perform
+              otel_before_request
+              super
+            end
+
+            def complete
+              begin
+                response_options = mirror.options
+                response_code = (response_options[:response_code] || response_options[:code]).to_i
+                if response_code.zero?
+                  return_code = response_options[:return_code]
+                  message = return_code ? ::Ethon::Curl.easy_strerror(return_code) : 'unknown reason'
+                  @otel_span.status = OpenTelemetry::Trace::Status.error("Request has failed: #{message}")
+                else
+                  @otel_span.set_attribute('http.response.status_code', response_code)
+                  @otel_span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(response_code.to_i)
+                end
+              ensure
+                @otel_span&.finish
+                @otel_span = nil
+              end
+              super
+            end
+
+            def reset
+              super
+            ensure
+              @otel_span = nil
+              @otel_method = nil
+              @otel_original_headers = nil
+            end
+
+            def otel_before_request
+              method = '_OTHER' # Could be GET or not HTTP at all
+              method = @otel_method if instance_variable_defined?(:@otel_method) && !@otel_method.nil?
+
+              @otel_span = tracer.start_span(
+                HTTP_METHODS_TO_SPAN_NAMES[method],
+                attributes: span_creation_attributes(method),
+                kind: :client
+              )
+
+              @otel_original_headers ||= {}
+              OpenTelemetry::Trace.with_span(@otel_span) do
+                OpenTelemetry.propagation.inject(@otel_original_headers)
+              end
+              self.headers = @otel_original_headers
+            end
+
+            def otel_span_started?
+              instance_variable_defined?(:@otel_span) && !@otel_span.nil?
+            end
+
+            private
+
+            def span_creation_attributes(method)
+              instrumentation_attrs = {
+                'http.request.method' => method
+              }
+
+              uri = _otel_cleanse_uri(url)
+              if uri
+                instrumentation_attrs['url.full'] = uri.to_s
+                instrumentation_attrs['server.address'] = uri.host if uri.host
+              end
+
+              config = Ethon::Instrumentation.instance.config
+              instrumentation_attrs['peer.service'] = config[:peer_service] if config[:peer_service]
+              instrumentation_attrs.merge!(
+                OpenTelemetry::Common::HTTP::ClientContext.attributes
+              )
+            end
+
+            # Returns a URL string with userinfo removed.
+            #
+            # @param [String] url The URL string to cleanse.
+            #
+            # @return [String] the cleansed URL.
+            def _otel_cleanse_uri(url)
+              cleansed_url = URI.parse(url)
+              cleansed_url.password = nil
+              cleansed_url.user = nil
+              cleansed_url
+            rescue URI::Error
+              nil
+            end
+
+            def tracer
+              Ethon::Instrumentation.instance.tracer
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Ethon
-      VERSION = '0.22.0'
+      VERSION = '0.23.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-ethon
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -38,132 +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: 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: Ethon instrumentation for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -179,17 +53,19 @@ files:
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/ethon.rb
 - lib/opentelemetry/instrumentation/ethon/instrumentation.rb
-- lib/opentelemetry/instrumentation/ethon/patches/easy.rb
+- lib/opentelemetry/instrumentation/ethon/patches/dup/easy.rb
 - lib/opentelemetry/instrumentation/ethon/patches/multi.rb
+- lib/opentelemetry/instrumentation/ethon/patches/old/easy.rb
+- lib/opentelemetry/instrumentation/ethon/patches/stable/easy.rb
 - lib/opentelemetry/instrumentation/ethon/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-ethon/0.22.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-ethon/0.23.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/ethon
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-ethon/0.22.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-ethon/0.23.0
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/opentelemetry/instrumentation/ethon/patches/easy.rb

@@ -1,127 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    module Ethon
-      module Patches
-        # Ethon::Easy patch for instrumentation
-        module Easy
-          ACTION_NAMES_TO_HTTP_METHODS = Hash.new do |h, k|
-            # #to_s is required because user input could be symbol or string
-            h[k] = k.to_s.upcase
-          end
-          HTTP_METHODS_TO_SPAN_NAMES = Hash.new { |h, k| h[k] = "HTTP #{k}" }
-
-          # Constant for the HTTP status range
-          HTTP_STATUS_SUCCESS_RANGE = (100..399)
-
-          def http_request(url, action_name, options = {})
-            @otel_method = ACTION_NAMES_TO_HTTP_METHODS[action_name]
-            super
-          end
-
-          def headers=(headers)
-            # Store headers to call this method again when span is ready
-            @otel_original_headers = headers
-            super
-          end
-
-          def perform
-            otel_before_request
-            super
-          end
-
-          def complete
-            begin
-              response_options = mirror.options
-              response_code = (response_options[:response_code] || response_options[:code]).to_i
-              if response_code.zero?
-                return_code = response_options[:return_code]
-                message = return_code ? ::Ethon::Curl.easy_strerror(return_code) : 'unknown reason'
-                @otel_span.status = OpenTelemetry::Trace::Status.error("Request has failed: #{message}")
-              else
-                @otel_span.set_attribute('http.status_code', response_code)
-                @otel_span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(response_code.to_i)
-              end
-            ensure
-              @otel_span&.finish
-              @otel_span = nil
-            end
-            super
-          end
-
-          def reset
-            super
-          ensure
-            @otel_span = nil
-            @otel_method = nil
-            @otel_original_headers = nil
-          end
-
-          def otel_before_request
-            method = 'N/A' # Could be GET or not HTTP at all
-            method = @otel_method if instance_variable_defined?(:@otel_method) && !@otel_method.nil?
-
-            @otel_span = tracer.start_span(
-              HTTP_METHODS_TO_SPAN_NAMES[method],
-              attributes: span_creation_attributes(method),
-              kind: :client
-            )
-
-            @otel_original_headers ||= {}
-            OpenTelemetry::Trace.with_span(@otel_span) do
-              OpenTelemetry.propagation.inject(@otel_original_headers)
-            end
-            self.headers = @otel_original_headers
-          end
-
-          def otel_span_started?
-            instance_variable_defined?(:@otel_span) && !@otel_span.nil?
-          end
-
-          private
-
-          def span_creation_attributes(method)
-            instrumentation_attrs = {
-              'http.method' => method
-            }
-
-            uri = _otel_cleanse_uri(url)
-            if uri
-              instrumentation_attrs['http.url'] = uri.to_s
-              instrumentation_attrs['net.peer.name'] = uri.host if uri.host
-            end
-
-            config = Ethon::Instrumentation.instance.config
-            instrumentation_attrs['peer.service'] = config[:peer_service] if config[:peer_service]
-            instrumentation_attrs.merge!(
-              OpenTelemetry::Common::HTTP::ClientContext.attributes
-            )
-          end
-
-          # Returns a URL string with userinfo removed.
-          #
-          # @param [String] url The URL string to cleanse.
-          #
-          # @return [String] the cleansed URL.
-          def _otel_cleanse_uri(url)
-            cleansed_url = URI.parse(url)
-            cleansed_url.password = nil
-            cleansed_url.user = nil
-            cleansed_url
-          rescue URI::Error
-            nil
-          end
-
-          def tracer
-            Ethon::Instrumentation.instance.tracer
-          end
-        end
-      end
-    end
-  end
-end