opentelemetry-instrumentation-restclient 0.26.0 → 0.28.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 (6) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +87 -85
  3. data/README.md +10 -9
  4. data/lib/opentelemetry/instrumentation/restclient/instrumentation.rb +9 -3
  5. data/lib/opentelemetry/instrumentation/restclient/version.rb +1 -1
  6. metadata +6 -9
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '0299312a2ce5258067ef26683ace0fa28c2d71f3e9cc68a6133f837212d84c4d'
4
- data.tar.gz: e0b6404a61b2d734111da82bd6b04153e1efd2143f7813a7be66f9ca95b7b015
3
+ metadata.gz: c1c81a7e3e9d6f28690391b7b626ff84fe67c310517c198da60f79ee4d0b2929
4
+ data.tar.gz: 1e11fc12addb20b35c081ea1606c67411b7bee030f8a9f48666c71d9d34c5b5b
5
5
  SHA512:
6
- metadata.gz: 87c1273bcc1eb38c0907e018ee649ec0a87209aaa4e03ad8639a9d51e57e6b29a29766b3e8bbaa0b510295723ec6f3bf35ea56c48689a97b19f2f6ba1542d323
7
- data.tar.gz: bb8608ce92b42886992abb0e28b2c9734030986a74fb7f11e3af4ab9ac175dad2f802899bc89d410848f55194b59755cc4ae9a36da01459e7bb00eaad7e64e87
6
+ metadata.gz: e7395e7dbeae3434c1d4d5ba156e2468e838df565e09335de949a2d6476fc2dc43b2b551d6587674b4bec255b1dc884ccaa4ce60ed7cce751d21af841a17c45e
7
+ data.tar.gz: 9e1fca969575842676bf925ce5c7628cde9204f8feeef6c8472629d761d93f6561fcf171779173a1dce959a5baa2da7cd8e91c2811a11a864f6ee241732dce81
data/CHANGELOG.md CHANGED
@@ -1,158 +1,160 @@
1
1
  # Release History: opentelemetry-instrumentation-restclient
2
2
 
3
- ### v0.26.0 / 2025-10-22
3
+ ## v0.28.0 / 2026-04-14
4
4
 
5
- * BREAKING CHANGE: Min Ruby Version 3.2
5
+ - ADDED: Add release tag into source code url of gem metadata (#1984)
6
6
 
7
- * ADDED: Min Ruby Version 3.2
7
+ ## v0.27.0 / 2026-03-17
8
8
 
9
- ### v0.25.1 / 2025-09-30
9
+ - BREAKING CHANGE: Default to stable HTTP semantic conventions (#2051)
10
+ - ADDED: Default to stable HTTP semantic conventions (#2051)
10
11
 
11
- * FIXED: Min OTel Ruby API 1.7
12
+ ## v0.26.0 / 2025-10-22
12
13
 
13
- ### v0.25.0 / 2025-09-30
14
+ - BREAKING CHANGE: Min Ruby Version 3.2
15
+ - ADDED: Min Ruby Version 3.2
14
16
 
15
- * ADDED: Bump minimum API Version to 1.7
17
+ ## v0.25.1 / 2025-09-30
16
18
 
17
- ### v0.24.0 / 2025-08-13
19
+ - FIXED: Min OTel Ruby API 1.7
18
20
 
19
- * ADDED: Add REST Client `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable [#1568](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/1568)
21
+ ## v0.25.0 / 2025-09-30
20
22
 
21
- ### v0.23.0 / 2025-01-16
23
+ - ADDED: Bump minimum API Version to 1.7
22
24
 
23
- * BREAKING CHANGE: Set minimum supported version to Ruby 3.1
25
+ ## v0.24.0 / 2025-08-13
24
26
 
25
- * ADDED: Set minimum supported version to Ruby 3.1
27
+ - ADDED: Add REST Client `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable [#1568](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/1568)
26
28
 
27
- ### v0.22.8 / 2024-11-26
29
+ ## v0.23.0 / 2025-01-16
28
30
 
29
- * CHANGED: Performance Freeze all range objects #1222
31
+ - BREAKING CHANGE: Set minimum supported version to Ruby 3.1
32
+ - ADDED: Set minimum supported version to Ruby 3.1
30
33
 
31
- ### v0.22.7 / 2024-07-23
34
+ ## v0.22.8 / 2024-11-26
32
35
 
33
- * DOCS: Add cspell to CI
36
+ - CHANGED: Performance Freeze all range objects #1222
34
37
 
35
- ### v0.22.6 / 2024-06-18
38
+ ## v0.22.7 / 2024-07-23
36
39
 
37
- * FIXED: Relax otel common gem constraints
40
+ - DOCS: Add cspell to CI
38
41
 
39
- ### v0.22.5 / 2024-05-09
42
+ ## v0.22.6 / 2024-06-18
40
43
 
41
- * FIXED: Untrace entire request
44
+ - FIXED: Relax otel common gem constraints
42
45
 
43
- ### v0.22.4 / 2024-04-30
46
+ ## v0.22.5 / 2024-05-09
44
47
 
45
- * FIXED: Bundler conflict warnings
48
+ - FIXED: Untrace entire request
46
49
 
47
- ### v0.22.3 / 2023-11-23
50
+ ## v0.22.4 / 2024-04-30
48
51
 
49
- * CHANGED: Applied Rubocop Performance Recommendations [#727](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/727)
52
+ - FIXED: Bundler conflict warnings
50
53
 
51
- ### v0.22.2 / 2023-07-21
54
+ ## v0.22.3 / 2023-11-23
52
55
 
53
- * ADDED: Update `opentelemetry-common` from [0.19.3 to 0.20.0](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/537)
56
+ - CHANGED: Applied Rubocop Performance Recommendations [#727](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/727)
54
57
 
55
- ### v0.22.1 / 2023-06-05
58
+ ## v0.22.2 / 2023-07-21
56
59
 
57
- * FIXED: Base config options
60
+ - ADDED: Update `opentelemetry-common` from [0.19.3 to 0.20.0](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/537)
58
61
 
59
- ### v0.22.0 / 2023-04-17
62
+ ## v0.22.1 / 2023-06-05
60
63
 
61
- * BREAKING CHANGE: Drop support for EoL Ruby 2.7
64
+ - FIXED: Base config options
62
65
 
63
- * ADDED: Drop support for EoL Ruby 2.7
66
+ ## v0.22.0 / 2023-04-17
64
67
 
65
- ### v0.21.0 / 2023-01-14
68
+ - BREAKING CHANGE: Drop support for EoL Ruby 2.7
69
+ - ADDED: Drop support for EoL Ruby 2.7
66
70
 
67
- * ADDED: Add request/response hooks to more http clients
68
- * DOCS: Fix gem homepage
69
- * DOCS: More gem documentation fixes
71
+ ## v0.21.0 / 2023-01-14
70
72
 
71
- ### v0.20.0 / 2022-06-09
73
+ - ADDED: Add request/response hooks to more http clients
74
+ - DOCS: Fix gem homepage
75
+ - DOCS: More gem documentation fixes
72
76
 
73
- * Upgrading Base dependency version
74
- * FIXED: Broken test file requirements
77
+ ## v0.20.0 / 2022-06-09
75
78
 
76
- ### v0.19.4 / 2022-05-02
79
+ - Upgrading Base dependency version
80
+ - FIXED: Broken test file requirements
77
81
 
78
- * FIXED: Restclient invalid span attribute type Symbol
82
+ ## v0.19.4 / 2022-05-02
79
83
 
80
- ### v0.19.3 / 2021-12-02
84
+ - FIXED: Restclient invalid span attribute type Symbol
81
85
 
82
- * (No significant changes)
86
+ ## v0.19.3 / 2021-12-02
83
87
 
84
- ### v0.19.2 / 2021-09-29
88
+ - (No significant changes)
85
89
 
86
- * (No significant changes)
90
+ ## v0.19.2 / 2021-09-29
87
91
 
88
- ### v0.19.1 / 2021-08-12
92
+ - (No significant changes)
89
93
 
90
- * DOCS: Update docs to rely more on environment variable configuration
94
+ ## v0.19.1 / 2021-08-12
91
95
 
92
- ### v0.19.0 / 2021-06-23
96
+ - DOCS: Update docs to rely more on environment variable configuration
93
97
 
94
- * BREAKING CHANGE: Total order constraint on span.status=
98
+ ## v0.19.0 / 2021-06-23
95
99
 
96
- * FIXED: Total order constraint on span.status=
100
+ - BREAKING CHANGE: Total order constraint on span.status=
101
+ - FIXED: Total order constraint on span.status=
97
102
 
98
- ### v0.18.0 / 2021-05-21
103
+ ## v0.18.0 / 2021-05-21
99
104
 
100
- * ADDED: Updated API dependency for 1.0.0.rc1
101
- * FIXED: Removed http.status_text attribute #750
105
+ - ADDED: Updated API dependency for 1.0.0.rc1
106
+ - FIXED: Removed http.status_text attribute #750
102
107
 
103
- ### v0.17.0 / 2021-04-22
108
+ ## v0.17.0 / 2021-04-22
104
109
 
105
- * ADDED: RestClient instrumentation accepts peer service config attribute.
106
- * FIXED: Refactor propagators to add #fields
110
+ - ADDED: RestClient instrumentation accepts peer service config attribute.
111
+ - FIXED: Refactor propagators to add #fields
107
112
 
108
- ### v0.16.0 / 2021-03-17
113
+ ## v0.16.0 / 2021-03-17
109
114
 
110
- * FIXED: Remove passwords from http.url
111
- * FIXED: Example scripts now reference local common lib
112
- * DOCS: Replace Gitter with GitHub Discussions
115
+ - FIXED: Remove passwords from http.url
116
+ - FIXED: Example scripts now reference local common lib
117
+ - DOCS: Replace Gitter with GitHub Discussions
113
118
 
114
- ### v0.15.0 / 2021-02-18
119
+ ## v0.15.0 / 2021-02-18
115
120
 
116
- * (No significant changes)
121
+ - (No significant changes)
117
122
 
118
- ### v0.14.0 / 2021-02-03
123
+ ## v0.14.0 / 2021-02-03
119
124
 
120
- * BREAKING CHANGE: Replace getter and setter callables and remove rack specific propagators
125
+ - BREAKING CHANGE: Replace getter and setter callables and remove rack specific propagators
126
+ - ADDED: Replace getter and setter callables and remove rack specific propagators
121
127
 
122
- * ADDED: Replace getter and setter callables and remove rack specific propagators
128
+ ## v0.13.0 / 2021-01-29
123
129
 
124
- ### v0.13.0 / 2021-01-29
130
+ - (No significant changes)
125
131
 
126
- * (No significant changes)
132
+ ## v0.12.0 / 2020-12-24
127
133
 
128
- ### v0.12.0 / 2020-12-24
134
+ - (No significant changes)
129
135
 
130
- * (No significant changes)
136
+ ## v0.11.0 / 2020-12-11
131
137
 
132
- ### v0.11.0 / 2020-12-11
138
+ - FIXED: Copyright comments to not reference year
133
139
 
134
- * FIXED: Copyright comments to not reference year
140
+ ## v0.10.0 / 2020-12-03
135
141
 
136
- ### v0.10.0 / 2020-12-03
142
+ - (No significant changes)
137
143
 
138
- * (No significant changes)
144
+ ## v0.9.0 / 2020-11-27
139
145
 
140
- ### v0.9.0 / 2020-11-27
146
+ - BREAKING CHANGE: Add timeout for force_flush and shutdown
147
+ - ADDED: Add timeout for force_flush and shutdown
141
148
 
142
- * BREAKING CHANGE: Add timeout for force_flush and shutdown
149
+ ## v0.8.0 / 2020-10-27
143
150
 
144
- * ADDED: Add timeout for force_flush and shutdown
151
+ - BREAKING CHANGE: Move context/span methods to Trace module
152
+ - FIXED: Move context/span methods to Trace module
145
153
 
146
- ### v0.8.0 / 2020-10-27
154
+ ## v0.7.0 / 2020-10-07
147
155
 
148
- * BREAKING CHANGE: Move context/span methods to Trace module
156
+ - DOCS: Standardize top-level docs structure and readme
149
157
 
150
- * FIXED: Move context/span methods to Trace module
158
+ ## v0.6.0 / 2020-09-10
151
159
 
152
- ### v0.7.0 / 2020-10-07
153
-
154
- * DOCS: Standardize top-level docs structure and readme
155
-
156
- ### v0.6.0 / 2020-09-10
157
-
158
- * (No significant changes)
160
+ - (No significant changes)
data/README.md CHANGED
@@ -2,6 +2,11 @@
2
2
 
3
3
  The OpenTelemetry RestClient gem is a community maintained instrumentation for the [RestClient][restclient-home] library.
4
4
 
5
+ > [!IMPORTANT]
6
+ >
7
+ > **Deprecation Notice:**
8
+ > This gem is deprecated due to the upstream dependency it relies on no longer being maintained. The code remains available for reference, but no further updates or fixes will be provided. Users should consider migrating to actively supported alternatives.
9
+
5
10
  ## How do I get started?
6
11
 
7
12
  Install the gem using:
@@ -51,16 +56,12 @@ Apache 2.0 license. See [LICENSE][license-github] for more information.
51
56
 
52
57
  ## HTTP semantic convention stability
53
58
 
54
- 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.
55
-
56
- 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.
59
+ This instrumentation by default emits the stable HTTP semantic conventions. The `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable can be used to opt-in to the old or duplicate (both old and stable) semantic conventions.
57
60
 
58
61
  When setting the value for `OTEL_SEMCONV_STABILITY_OPT_IN`, you can specify which conventions you wish to adopt:
59
62
 
60
- - `http` - Emits the stable HTTP and networking conventions and ceases emitting the old conventions previously emitted by the instrumentation.
61
- - `http/dup` - Emits both the old and stable HTTP and networking conventions, enabling a phased rollout of the stable semantic conventions.
62
- - Default behavior (in the absence of either value) is to continue emitting the old HTTP and networking conventions the instrumentation previously emitted.
63
-
64
- 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.
63
+ - `http` - Emits the stable HTTP and networking conventions.
64
+ - `http/dup` - **DEPRECATED: Will be removed on April 15, 2026.** Emits both the old and stable HTTP and networking conventions.
65
+ - `old` - **DEPRECATED: Will be removed on April 15, 2026.** Emits the old HTTP and networking conventions.
65
66
 
66
- For additional information on migration, please refer to our [documentation](https://opentelemetry.io/docs/specs/semconv/non-normative/http-migration/).
67
+ 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 CHANGED
@@ -29,14 +29,20 @@ module OpenTelemetry
29
29
  values = stability_opt_in.split(',').map(&:strip)
30
30
 
31
31
  if values.include?('http/dup')
32
+ emit_old_semconv_deprecation_warning('http/dup')
32
33
  'dup'
33
- elsif values.include?('http')
34
- 'stable'
35
- else
34
+ elsif values.include?('old')
35
+ emit_old_semconv_deprecation_warning('old')
36
36
  'old'
37
+ else
38
+ 'stable'
37
39
  end
38
40
  end
39
41
 
42
+ def emit_old_semconv_deprecation_warning(option)
43
+ OpenTelemetry.logger.warn("The `#{option}` option for OTEL_SEMCONV_STABILITY_OPT_IN is deprecated and will be removed on April 15, 2026. Please migrate to the stable HTTP semantic conventions.")
44
+ end
45
+
40
46
  def require_dependencies_dup
41
47
  require_relative 'patches/dup/request'
42
48
  end
data/lib/opentelemetry/instrumentation/restclient/version.rb CHANGED
@@ -7,7 +7,7 @@
7
7
  module OpenTelemetry
8
8
  module Instrumentation
9
9
  module RestClient
10
- VERSION = '0.26.0'
10
+ VERSION = '0.28.0'
11
11
  end
12
12
  end
13
13
  end
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: opentelemetry-instrumentation-restclient
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.26.0
4
+ version: 0.28.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenTelemetry Authors
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2025-10-22 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: opentelemetry-instrumentation-base
@@ -47,11 +46,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
47
46
  licenses:
48
47
  - Apache-2.0
49
48
  metadata:
50
- changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-restclient/0.26.0/file/CHANGELOG.md
51
- source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/restclient
49
+ changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-restclient/0.28.0/file/CHANGELOG.md
50
+ source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-restclient/v0.28.0/instrumentation/restclient
52
51
  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
53
- documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-restclient/0.26.0
54
- post_install_message:
52
+ documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-restclient/0.28.0
55
53
  rdoc_options: []
56
54
  require_paths:
57
55
  - lib
@@ -66,8 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
66
64
  - !ruby/object:Gem::Version
67
65
  version: '0'
68
66
  requirements: []
69
- rubygems_version: 3.4.19
70
- signing_key:
67
+ rubygems_version: 4.0.6
71
68
  specification_version: 4
72
69
  summary: REST Client instrumentation for the OpenTelemetry framework
73
70
  test_files: []