opentelemetry-instrumentation-restclient 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7a7ea2fa5b32e2fd675d31c589c154b60c5a5802688e5ef5abbe48ba4ffce34
-  data.tar.gz: b3f697b57ce7dfc4c968d5b75ea7753bd3f403416de3b18c3f5843022121e9a6
+  metadata.gz: 77f13b11d744dff44b6318f31d9050257a8370795de144109f56920d758a9390
+  data.tar.gz: 11aac6fc8d85c10dd73363dd639e43db7036fffb768d6f65a2f05e99114f66b4
 SHA512:
-  metadata.gz: 217dda071c7a736e6edcbec050a57f9e2911ae3935146b569acd5bfe12907e2566eaffdd0aaf7599fc08ae7df7e39c9786e906ccd953c445c0fe9f56b9f54e58
-  data.tar.gz: ac6018b030a697e8291f12ab2d430eddbd3d88f24c1be774b3533a4e69908aeba7700fd8bf832fc9d150e0ac0a47fc36d4c329d9ea78bbcaa7306323adf6549d
+  metadata.gz: 870e801a2f6be4feabcff349b1847e4182412ab678b43ced933ce68d52dc5fd399dd415a931b2d25a948523110c6c7b85283ca4b540e84a90fb8868b7be05c35
+  data.tar.gz: 86f78f016494e2bd5d588e730056c44071fda4c37f775d4bcfafbc5d4a6c38b28293fc75f13f383cf2b69ef0e186bbf4119d00a51ad3cba458c03f20540ac432

data/CHANGELOG.md

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

data/README.md

@@ -48,3 +48,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, RestClient instrumentation code comes in three patch versions: `dup`, `old`, and `stable`. These versions are identical except for the attributes they send. Any changes to RestClient 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/restclient/instrumentation.rb

@@ -11,8 +11,9 @@ module OpenTelemetry
       # instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
         install do |_config|
-          require_dependencies
-          patch_request
+          patch_type = determine_semconv
+          send(:"require_dependencies_#{patch_type}")
+          send(:"patch_request_#{patch_type}")
         end
 
         present do
@@ -23,12 +24,41 @@ module OpenTelemetry
 
         private
 
-        def require_dependencies
-          require_relative 'patches/request'
+        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/request'
+        end
+
+        def require_dependencies_stable
+          require_relative 'patches/stable/request'
+        end
+
+        def require_dependencies_old
+          require_relative 'patches/old/request'
+        end
+
+        def patch_request_dup
+          ::RestClient::Request.prepend(Patches::Dup::Request)
+        end
+
+        def patch_request_stable
+          ::RestClient::Request.prepend(Patches::Stable::Request)
         end
 
-        def patch_request
-          ::RestClient::Request.prepend(Patches::Request)
+        def patch_request_old
+          ::RestClient::Request.prepend(Patches::Old::Request)
         end
       end
     end

data/lib/opentelemetry/instrumentation/restclient/patches/dup/request.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module RestClient
+      module Patches
+        module Dup
+          # Module to prepend to RestClient::Request for instrumentation
+          module Request
+            # Constant for the HTTP status range
+            HTTP_STATUS_SUCCESS_RANGE = (100..399)
+
+            def execute(&)
+              trace_request do |_span|
+                super
+              end
+            end
+
+            private
+
+            def create_request_span
+              http_method = method.upcase
+              instrumentation_attrs = {
+                'http.method' => http_method.to_s,
+                'http.request.method' => http_method.to_s,
+                'http.url' => OpenTelemetry::Common::Utilities.cleanse_url(url),
+                'url.full' => OpenTelemetry::Common::Utilities.cleanse_url(url)
+              }
+              instrumentation_config = RestClient::Instrumentation.instance.config
+              instrumentation_attrs['peer.service'] = instrumentation_config[:peer_service] if instrumentation_config[:peer_service]
+              span = tracer.start_span(
+                http_method.to_s,
+                attributes: instrumentation_attrs.merge(
+                  OpenTelemetry::Common::HTTP::ClientContext.attributes
+                ),
+                kind: :client
+              )
+
+              OpenTelemetry::Trace.with_span(span) do
+                OpenTelemetry.propagation.inject(processed_headers)
+              end
+
+              span
+            end
+
+            def trace_request
+              span = create_request_span
+
+              yield(span).tap do |response|
+                # Verify return value is a response.
+                # If so, add additional attributes.
+                if response.is_a?(::RestClient::Response)
+                  span.set_attribute('http.status_code', response.code)
+                  span.set_attribute('http.response.status_code', response.code)
+                  span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(response.code.to_i)
+                end
+              end
+            rescue ::RestClient::ExceptionWithResponse => e
+              span.set_attribute('http.status_code', e.http_code)
+              span.set_attribute('http.response.status_code', e.http_code)
+              span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(e.http_code.to_i)
+              raise e
+            ensure
+              span.finish
+            end
+
+            def tracer
+              RestClient::Instrumentation.instance.tracer
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/restclient/patches/old/request.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module RestClient
+      module Patches
+        module Old
+          # Module to prepend to RestClient::Request for instrumentation
+          module Request
+            # Constant for the HTTP status range
+            HTTP_STATUS_SUCCESS_RANGE = (100..399)
+
+            def execute(&)
+              trace_request do |_span|
+                super
+              end
+            end
+
+            private
+
+            def create_request_span
+              http_method = method.upcase
+              instrumentation_attrs = {
+                'http.method' => http_method.to_s,
+                'http.url' => OpenTelemetry::Common::Utilities.cleanse_url(url)
+              }
+              instrumentation_config = RestClient::Instrumentation.instance.config
+              instrumentation_attrs['peer.service'] = instrumentation_config[:peer_service] if instrumentation_config[:peer_service]
+              span = tracer.start_span(
+                "HTTP #{http_method}",
+                attributes: instrumentation_attrs.merge(
+                  OpenTelemetry::Common::HTTP::ClientContext.attributes
+                ),
+                kind: :client
+              )
+
+              OpenTelemetry::Trace.with_span(span) do
+                OpenTelemetry.propagation.inject(processed_headers)
+              end
+
+              span
+            end
+
+            def trace_request
+              span = create_request_span
+
+              yield(span).tap do |response|
+                # Verify return value is a response.
+                # If so, add additional attributes.
+                if response.is_a?(::RestClient::Response)
+                  span.set_attribute('http.status_code', response.code)
+                  span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(response.code.to_i)
+                end
+              end
+            rescue ::RestClient::ExceptionWithResponse => e
+              span.set_attribute('http.status_code', e.http_code)
+              span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(e.http_code.to_i)
+              raise e
+            ensure
+              span.finish
+            end
+
+            def tracer
+              RestClient::Instrumentation.instance.tracer
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/restclient/patches/stable/request.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module RestClient
+      module Patches
+        module Stable
+          # Module to prepend to RestClient::Request for instrumentation
+          module Request
+            # Constant for the HTTP status range
+            HTTP_STATUS_SUCCESS_RANGE = (100..399)
+
+            def execute(&)
+              trace_request do |_span|
+                super
+              end
+            end
+
+            private
+
+            def create_request_span
+              http_method = method.upcase
+              instrumentation_attrs = {
+                'http.request.method' => http_method.to_s,
+                'url.full' => OpenTelemetry::Common::Utilities.cleanse_url(url)
+              }
+              instrumentation_config = RestClient::Instrumentation.instance.config
+              instrumentation_attrs['peer.service'] = instrumentation_config[:peer_service] if instrumentation_config[:peer_service]
+              span = tracer.start_span(
+                http_method.to_s,
+                attributes: instrumentation_attrs.merge(
+                  OpenTelemetry::Common::HTTP::ClientContext.attributes
+                ),
+                kind: :client
+              )
+
+              OpenTelemetry::Trace.with_span(span) do
+                OpenTelemetry.propagation.inject(processed_headers)
+              end
+
+              span
+            end
+
+            def trace_request
+              span = create_request_span
+
+              yield(span).tap do |response|
+                # Verify return value is a response.
+                # If so, add additional attributes.
+                if response.is_a?(::RestClient::Response)
+                  span.set_attribute('http.response.status_code', response.code)
+                  span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(response.code.to_i)
+                end
+              end
+            rescue ::RestClient::ExceptionWithResponse => e
+              span.set_attribute('http.response.status_code', e.http_code)
+              span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(e.http_code.to_i)
+              raise e
+            ensure
+              span.finish
+            end
+
+            def tracer
+              RestClient::Instrumentation.instance.tracer
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module RestClient
-      VERSION = '0.23.0'
+      VERSION = '0.24.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-restclient
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.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,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: REST Client instrumentation for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -193,16 +53,18 @@ files:
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/restclient.rb
 - lib/opentelemetry/instrumentation/restclient/instrumentation.rb
-- lib/opentelemetry/instrumentation/restclient/patches/request.rb
+- lib/opentelemetry/instrumentation/restclient/patches/dup/request.rb
+- lib/opentelemetry/instrumentation/restclient/patches/old/request.rb
+- lib/opentelemetry/instrumentation/restclient/patches/stable/request.rb
 - lib/opentelemetry/instrumentation/restclient/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-restclient/0.23.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-restclient/0.24.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/restclient
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-restclient/0.23.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-restclient/0.24.0
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/opentelemetry/instrumentation/restclient/patches/request.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    module RestClient
-      module Patches
-        # Module to prepend to RestClient::Request for instrumentation
-        module Request
-          # Constant for the HTTP status range
-          HTTP_STATUS_SUCCESS_RANGE = (100..399)
-
-          def execute(&block)
-            trace_request do |_span|
-              super
-            end
-          end
-
-          private
-
-          def create_request_span
-            http_method = method.upcase
-            instrumentation_attrs = {
-              'http.method' => http_method.to_s,
-              'http.url' => OpenTelemetry::Common::Utilities.cleanse_url(url)
-            }
-            instrumentation_config = RestClient::Instrumentation.instance.config
-            instrumentation_attrs['peer.service'] = instrumentation_config[:peer_service] if instrumentation_config[:peer_service]
-            span = tracer.start_span(
-              "HTTP #{http_method}",
-              attributes: instrumentation_attrs.merge(
-                OpenTelemetry::Common::HTTP::ClientContext.attributes
-              ),
-              kind: :client
-            )
-
-            OpenTelemetry::Trace.with_span(span) do
-              OpenTelemetry.propagation.inject(processed_headers)
-            end
-
-            span
-          end
-
-          def trace_request
-            span = create_request_span
-
-            yield(span).tap do |response|
-              # Verify return value is a response.
-              # If so, add additional attributes.
-              if response.is_a?(::RestClient::Response)
-                span.set_attribute('http.status_code', response.code)
-                span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(response.code.to_i)
-              end
-            end
-          rescue ::RestClient::ExceptionWithResponse => e
-            span.set_attribute('http.status_code', e.http_code)
-            span.status = OpenTelemetry::Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(e.http_code.to_i)
-            raise e
-          ensure
-            span.finish
-          end
-
-          def tracer
-            RestClient::Instrumentation.instance.tracer
-          end
-        end
-      end
-    end
-  end
-end