opentelemetry-instrumentation-faraday 0.26.0 → 0.27.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 (7) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/README.md +9 -2
  4. data/lib/opentelemetry/instrumentation/faraday/instrumentation.rb +1 -0
  5. data/lib/opentelemetry/instrumentation/faraday/middlewares/tracer_middleware.rb +7 -1
  6. data/lib/opentelemetry/instrumentation/faraday/version.rb +1 -1
  7. metadata +4 -144
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3c5efeefd5e82f8c908e902d93a843f819c1f305577374037b087b94157edc31
4
- data.tar.gz: '099811f33339f13777cd9f96e9e76a93501265b155f6099a755a8b91c2b142cf'
3
+ metadata.gz: 9277b3989aec5b86a371febc29f4e311be7f9b8f875766b87cb95a36f34e3ac1
4
+ data.tar.gz: 8214e43a5609615156bd124b19132e62d8432ae46545266e10160eb50026810e
5
5
  SHA512:
6
- metadata.gz: 3539521f62e688c20164ed762915bbd829e00182d277ebd13643176baf47ff633d7dc0a8d6046f9a77c433eeff0c13701d27c340ec46495a316c9693edac8879
7
- data.tar.gz: d5d6891ca5c17764b116519df79c0a5542c5d15feba8353975600e8b8e2359ff1df9e86f3fcf9524ef80b67ef0c21ecd152a826e076538a7e235cee5d76d7cef
6
+ metadata.gz: 338344d347896039ca70ca71930758193e90eef6ba21c32892c7089e2b046d67239fc251e23bfb696d239b30bdea3d8f81a40d28e75c5c608f4f6756f36dd1b3
7
+ data.tar.gz: 69689f9129b606d4a387aa94c5632c043bfe91717625fbada5455e4a1353ae8a7eb077415c5232044bc260bde17753df548d1f15a3ab5fcdd8c6b11ec96504b6
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release History: opentelemetry-instrumentation-faraday
2
2
 
3
+ ### v0.27.0 / 2025-06-03
4
+
5
+ * ADDED: Suppress internal spans with Faraday instrumentation
6
+
3
7
  ### v0.26.0 / 2025-01-16
4
8
 
5
9
  * BREAKING CHANGE: Set minimum supported version to Ruby 3.1
data/README.md CHANGED
@@ -18,7 +18,9 @@ To install the instrumentation, call `use` with the name of the instrumentation.
18
18
 
19
19
  ```ruby
20
20
  OpenTelemetry::SDK.configure do |c|
21
- c.use 'OpenTelemetry::Instrumentation::Faraday'
21
+ c.use 'OpenTelemetry::Instrumentation::Faraday', {
22
+ enable_internal_instrumentation: false
23
+ }
22
24
  end
23
25
  ```
24
26
 
@@ -30,9 +32,14 @@ OpenTelemetry::SDK.configure do |c|
30
32
  end
31
33
  ```
32
34
 
35
+ ### Configuration options
36
+ This instrumentation offers the following configuration options:
37
+ * `enable_internal_instrumentation` (default: `false`): When set to `true`, any spans with
38
+ span kind of `internal` are included in traces.
39
+
33
40
  ## Examples
34
41
 
35
- 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)
42
+ 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)
36
43
 
37
44
  ## How can I get involved?
38
45
 
data/lib/opentelemetry/instrumentation/faraday/instrumentation.rb CHANGED
@@ -28,6 +28,7 @@ module OpenTelemetry
28
28
 
29
29
  option :span_kind, default: :client, validate: %i[client internal]
30
30
  option :peer_service, default: nil, validate: :string
31
+ option :enable_internal_instrumentation, default: false, validate: :boolean
31
32
 
32
33
  private
33
34
 
data/lib/opentelemetry/instrumentation/faraday/middlewares/tracer_middleware.rb CHANGED
@@ -40,7 +40,13 @@ module OpenTelemetry
40
40
  ) do |span|
41
41
  OpenTelemetry.propagation.inject(env.request_headers)
42
42
 
43
- app.call(env).on_complete { |resp| trace_response(span, resp.status) }
43
+ if config[:enable_internal_instrumentation] == false
44
+ OpenTelemetry::Common::Utilities.untraced do
45
+ app.call(env).on_complete { |resp| trace_response(span, resp.status) }
46
+ end
47
+ else
48
+ app.call(env).on_complete { |resp| trace_response(span, resp.status) }
49
+ end
44
50
  rescue ::Faraday::Error => e
45
51
  trace_response(span, e.response[:status]) if e.response
46
52
 
data/lib/opentelemetry/instrumentation/faraday/version.rb CHANGED
@@ -7,7 +7,7 @@
7
7
  module OpenTelemetry
8
8
  module Instrumentation
9
9
  module Faraday
10
- VERSION = '0.26.0'
10
+ VERSION = '0.27.0'
11
11
  end
12
12
  end
13
13
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: opentelemetry-instrumentation-faraday
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.26.0
4
+ version: 0.27.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenTelemetry Authors
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-01-16 00:00:00.000000000 Z
11
+ date: 2025-06-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: opentelemetry-api
@@ -38,146 +38,6 @@ dependencies:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
40
  version: 0.23.0
41
- - !ruby/object:Gem::Dependency
42
- name: appraisal
43
- requirement: !ruby/object:Gem::Requirement
44
- requirements:
45
- - - "~>"
46
- - !ruby/object:Gem::Version
47
- version: '2.5'
48
- type: :development
49
- prerelease: false
50
- version_requirements: !ruby/object:Gem::Requirement
51
- requirements:
52
- - - "~>"
53
- - !ruby/object:Gem::Version
54
- version: '2.5'
55
- - !ruby/object:Gem::Dependency
56
- name: bundler
57
- requirement: !ruby/object:Gem::Requirement
58
- requirements:
59
- - - "~>"
60
- - !ruby/object:Gem::Version
61
- version: '2.4'
62
- type: :development
63
- prerelease: false
64
- version_requirements: !ruby/object:Gem::Requirement
65
- requirements:
66
- - - "~>"
67
- - !ruby/object:Gem::Version
68
- version: '2.4'
69
- - !ruby/object:Gem::Dependency
70
- name: minitest
71
- requirement: !ruby/object:Gem::Requirement
72
- requirements:
73
- - - "~>"
74
- - !ruby/object:Gem::Version
75
- version: '5.0'
76
- type: :development
77
- prerelease: false
78
- version_requirements: !ruby/object:Gem::Requirement
79
- requirements:
80
- - - "~>"
81
- - !ruby/object:Gem::Version
82
- version: '5.0'
83
- - !ruby/object:Gem::Dependency
84
- name: opentelemetry-sdk
85
- requirement: !ruby/object:Gem::Requirement
86
- requirements:
87
- - - "~>"
88
- - !ruby/object:Gem::Version
89
- version: '1.1'
90
- type: :development
91
- prerelease: false
92
- version_requirements: !ruby/object:Gem::Requirement
93
- requirements:
94
- - - "~>"
95
- - !ruby/object:Gem::Version
96
- version: '1.1'
97
- - !ruby/object:Gem::Dependency
98
- name: opentelemetry-test-helpers
99
- requirement: !ruby/object:Gem::Requirement
100
- requirements:
101
- - - "~>"
102
- - !ruby/object:Gem::Version
103
- version: '0.3'
104
- type: :development
105
- prerelease: false
106
- version_requirements: !ruby/object:Gem::Requirement
107
- requirements:
108
- - - "~>"
109
- - !ruby/object:Gem::Version
110
- version: '0.3'
111
- - !ruby/object:Gem::Dependency
112
- name: rubocop
113
- requirement: !ruby/object:Gem::Requirement
114
- requirements:
115
- - - "~>"
116
- - !ruby/object:Gem::Version
117
- version: 1.69.1
118
- type: :development
119
- prerelease: false
120
- version_requirements: !ruby/object:Gem::Requirement
121
- requirements:
122
- - - "~>"
123
- - !ruby/object:Gem::Version
124
- version: 1.69.1
125
- - !ruby/object:Gem::Dependency
126
- name: rubocop-performance
127
- requirement: !ruby/object:Gem::Requirement
128
- requirements:
129
- - - "~>"
130
- - !ruby/object:Gem::Version
131
- version: 1.23.0
132
- type: :development
133
- prerelease: false
134
- version_requirements: !ruby/object:Gem::Requirement
135
- requirements:
136
- - - "~>"
137
- - !ruby/object:Gem::Version
138
- version: 1.23.0
139
- - !ruby/object:Gem::Dependency
140
- name: simplecov
141
- requirement: !ruby/object:Gem::Requirement
142
- requirements:
143
- - - "~>"
144
- - !ruby/object:Gem::Version
145
- version: 0.17.1
146
- type: :development
147
- prerelease: false
148
- version_requirements: !ruby/object:Gem::Requirement
149
- requirements:
150
- - - "~>"
151
- - !ruby/object:Gem::Version
152
- version: 0.17.1
153
- - !ruby/object:Gem::Dependency
154
- name: webmock
155
- requirement: !ruby/object:Gem::Requirement
156
- requirements:
157
- - - "~>"
158
- - !ruby/object:Gem::Version
159
- version: 3.24.0
160
- type: :development
161
- prerelease: false
162
- version_requirements: !ruby/object:Gem::Requirement
163
- requirements:
164
- - - "~>"
165
- - !ruby/object:Gem::Version
166
- version: 3.24.0
167
- - !ruby/object:Gem::Dependency
168
- name: yard
169
- requirement: !ruby/object:Gem::Requirement
170
- requirements:
171
- - - "~>"
172
- - !ruby/object:Gem::Version
173
- version: '0.9'
174
- type: :development
175
- prerelease: false
176
- version_requirements: !ruby/object:Gem::Requirement
177
- requirements:
178
- - - "~>"
179
- - !ruby/object:Gem::Version
180
- version: '0.9'
181
41
  description: Faraday instrumentation for the OpenTelemetry framework
182
42
  email:
183
43
  - cncf-opentelemetry-contributors@lists.cncf.io
@@ -200,10 +60,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
200
60
  licenses:
201
61
  - Apache-2.0
202
62
  metadata:
203
- changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-faraday/0.26.0/file/CHANGELOG.md
63
+ changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-faraday/0.27.0/file/CHANGELOG.md
204
64
  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/faraday
205
65
  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
206
- documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-faraday/0.26.0
66
+ documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-faraday/0.27.0
207
67
  post_install_message:
208
68
  rdoc_options: []
209
69
  require_paths: