splunk-otel 0.1.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 (51) hide show
  1. checksums.yaml +7 -0
  2. data/.github/CODEOWNERS +14 -0
  3. data/.github/workflows/main.yml +48 -0
  4. data/.gitignore +13 -0
  5. data/.gitlab-ci.yml +23 -0
  6. data/.rubocop.yml +27 -0
  7. data/CHANGELOG.md +10 -0
  8. data/CODE_OF_CONDUCT.md +90 -0
  9. data/CONTRIBUTING.md +88 -0
  10. data/Gemfile +6 -0
  11. data/LICENSE +177 -0
  12. data/MIGRATING.md +61 -0
  13. data/README.md +190 -0
  14. data/Rakefile +15 -0
  15. data/SECURITY.md +7 -0
  16. data/conf/otel-collector-config.yaml +21 -0
  17. data/docker-compose.yml +11 -0
  18. data/docs/README.md +3 -0
  19. data/docs/advanced-config.md +52 -0
  20. data/docs/correlating-traces-and-logs.md +23 -0
  21. data/docs/instrumenting-rails.md +7 -0
  22. data/docs/troubleshooting.md +14 -0
  23. data/examples/basic/README.md +94 -0
  24. data/examples/basic/collector_trace.png +0 -0
  25. data/examples/basic/console.rb +63 -0
  26. data/examples/basic/direct_trace.png +0 -0
  27. data/examples/basic/docker-compose.yml +9 -0
  28. data/examples/rails-7-barebones/.bundle/config +2 -0
  29. data/examples/rails-7-barebones/.gitignore +1 -0
  30. data/examples/rails-7-barebones/Dockerfile +16 -0
  31. data/examples/rails-7-barebones/Gemfile +17 -0
  32. data/examples/rails-7-barebones/README.md +24 -0
  33. data/examples/rails-7-barebones/app.ru +34 -0
  34. data/examples/rails-7-barebones/config/initializers/splunk_otel.rb +4 -0
  35. data/examples/rails-7-barebones/docker-compose.yml +34 -0
  36. data/examples/rails-7-barebones/tests-e2e/rails_7_barebones_test.rb +27 -0
  37. data/examples/rails-7-barebones/wait-for.sh +191 -0
  38. data/lib/splunk/otel/common.rb +47 -0
  39. data/lib/splunk/otel/instrumentation/action_pack/instrumentation.rb +41 -0
  40. data/lib/splunk/otel/instrumentation/action_pack/railtie.rb +28 -0
  41. data/lib/splunk/otel/instrumentation/action_pack/version.rb +11 -0
  42. data/lib/splunk/otel/instrumentation/action_pack.rb +14 -0
  43. data/lib/splunk/otel/instrumentation/rack/middleware.rb +25 -0
  44. data/lib/splunk/otel/instrumentation/rack.rb +3 -0
  45. data/lib/splunk/otel/logging.rb +24 -0
  46. data/lib/splunk/otel/version.rb +7 -0
  47. data/lib/splunk/otel.rb +170 -0
  48. data/scripts/install-release-deps.sh +10 -0
  49. data/scripts/release.sh +38 -0
  50. data/splunk-otel.gemspec +51 -0
  51. metadata +316 -0
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "lib/splunk/otel/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "splunk-otel"
7
+ spec.version = Splunk::Otel::VERSION
8
+ spec.authors = ["Splunk"]
9
+ spec.email = ["splunk-oss@splunk.com"]
10
+
11
+ spec.summary = "Splunk OpenTelemetry Ruby distribution"
12
+ spec.homepage = "https://github.com/signalfx/splunk-otel-ruby"
13
+ spec.required_ruby_version = ">= 2.6.0"
14
+
15
+ spec.metadata["homepage_uri"] = spec.homepage
16
+ spec.metadata["source_code_uri"] = "https://github.com/signalfx/splunk-otel-ruby"
17
+ spec.metadata["changelog_uri"] = "https://github.com/signalfx/splunk-otel-ruby/blob/main/CHANGELOG.md"
18
+
19
+ # Specify which files should be added to the gem when it is released.
20
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
21
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
22
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
23
+ end
24
+ spec.bindir = "exe"
25
+ spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
26
+ spec.require_paths = ["lib"]
27
+
28
+ spec.add_dependency "opentelemetry-api", "~> 1.0"
29
+ spec.add_dependency "opentelemetry-exporter-jaeger", "~> 0.20.1"
30
+ spec.add_dependency "opentelemetry-exporter-otlp", "~> 0.21.0"
31
+ spec.add_dependency "opentelemetry-instrumentation-base", "~> 0.21.0"
32
+ spec.add_dependency "opentelemetry-propagator-b3", "~> 0.19.2"
33
+ spec.add_dependency "opentelemetry-sdk", "~> 1.0"
34
+
35
+ # development dependencies
36
+ spec.add_development_dependency "rails"
37
+ spec.add_development_dependency "rake", "~> 13.0"
38
+ spec.add_development_dependency "rubocop", "~> 1.25"
39
+ spec.add_development_dependency "rubocop-rake", "~> 0.6.0"
40
+ spec.add_development_dependency "simplecov", "~> 0.21.2"
41
+ spec.add_development_dependency "test-unit", "~> 3.0"
42
+
43
+ spec.add_development_dependency "opentelemetry-instrumentation-action_pack", "~> 0.2.0"
44
+ spec.add_development_dependency "opentelemetry-instrumentation-rack", "~> 0.21"
45
+ spec.add_development_dependency "rack", "~> 2.2"
46
+ spec.add_development_dependency "rack-test", "~> 1.1"
47
+
48
+ spec.metadata = {
49
+ "rubygems_mfa_required" => "true"
50
+ }
51
+ end
metadata ADDED
@@ -0,0 +1,316 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: splunk-otel
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Splunk
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2022-07-27 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: opentelemetry-api
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: opentelemetry-exporter-jaeger
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 0.20.1
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 0.20.1
41
+ - !ruby/object:Gem::Dependency
42
+ name: opentelemetry-exporter-otlp
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 0.21.0
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 0.21.0
55
+ - !ruby/object:Gem::Dependency
56
+ name: opentelemetry-instrumentation-base
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 0.21.0
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 0.21.0
69
+ - !ruby/object:Gem::Dependency
70
+ name: opentelemetry-propagator-b3
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 0.19.2
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 0.19.2
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.0'
90
+ type: :runtime
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '1.0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rails
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: rake
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '13.0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '13.0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: rubocop
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '1.25'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '1.25'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rubocop-rake
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: 0.6.0
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: 0.6.0
153
+ - !ruby/object:Gem::Dependency
154
+ name: simplecov
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: 0.21.2
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: 0.21.2
167
+ - !ruby/object:Gem::Dependency
168
+ name: test-unit
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: '3.0'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - "~>"
179
+ - !ruby/object:Gem::Version
180
+ version: '3.0'
181
+ - !ruby/object:Gem::Dependency
182
+ name: opentelemetry-instrumentation-action_pack
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - "~>"
186
+ - !ruby/object:Gem::Version
187
+ version: 0.2.0
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - "~>"
193
+ - !ruby/object:Gem::Version
194
+ version: 0.2.0
195
+ - !ruby/object:Gem::Dependency
196
+ name: opentelemetry-instrumentation-rack
197
+ requirement: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - "~>"
200
+ - !ruby/object:Gem::Version
201
+ version: '0.21'
202
+ type: :development
203
+ prerelease: false
204
+ version_requirements: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - "~>"
207
+ - !ruby/object:Gem::Version
208
+ version: '0.21'
209
+ - !ruby/object:Gem::Dependency
210
+ name: rack
211
+ requirement: !ruby/object:Gem::Requirement
212
+ requirements:
213
+ - - "~>"
214
+ - !ruby/object:Gem::Version
215
+ version: '2.2'
216
+ type: :development
217
+ prerelease: false
218
+ version_requirements: !ruby/object:Gem::Requirement
219
+ requirements:
220
+ - - "~>"
221
+ - !ruby/object:Gem::Version
222
+ version: '2.2'
223
+ - !ruby/object:Gem::Dependency
224
+ name: rack-test
225
+ requirement: !ruby/object:Gem::Requirement
226
+ requirements:
227
+ - - "~>"
228
+ - !ruby/object:Gem::Version
229
+ version: '1.1'
230
+ type: :development
231
+ prerelease: false
232
+ version_requirements: !ruby/object:Gem::Requirement
233
+ requirements:
234
+ - - "~>"
235
+ - !ruby/object:Gem::Version
236
+ version: '1.1'
237
+ description:
238
+ email:
239
+ - splunk-oss@splunk.com
240
+ executables: []
241
+ extensions: []
242
+ extra_rdoc_files: []
243
+ files:
244
+ - ".github/CODEOWNERS"
245
+ - ".github/workflows/main.yml"
246
+ - ".gitignore"
247
+ - ".gitlab-ci.yml"
248
+ - ".rubocop.yml"
249
+ - CHANGELOG.md
250
+ - CODE_OF_CONDUCT.md
251
+ - CONTRIBUTING.md
252
+ - Gemfile
253
+ - LICENSE
254
+ - MIGRATING.md
255
+ - README.md
256
+ - Rakefile
257
+ - SECURITY.md
258
+ - conf/otel-collector-config.yaml
259
+ - docker-compose.yml
260
+ - docs/README.md
261
+ - docs/advanced-config.md
262
+ - docs/correlating-traces-and-logs.md
263
+ - docs/instrumenting-rails.md
264
+ - docs/troubleshooting.md
265
+ - examples/basic/README.md
266
+ - examples/basic/collector_trace.png
267
+ - examples/basic/console.rb
268
+ - examples/basic/direct_trace.png
269
+ - examples/basic/docker-compose.yml
270
+ - examples/rails-7-barebones/.bundle/config
271
+ - examples/rails-7-barebones/.gitignore
272
+ - examples/rails-7-barebones/Dockerfile
273
+ - examples/rails-7-barebones/Gemfile
274
+ - examples/rails-7-barebones/README.md
275
+ - examples/rails-7-barebones/app.ru
276
+ - examples/rails-7-barebones/config/initializers/splunk_otel.rb
277
+ - examples/rails-7-barebones/docker-compose.yml
278
+ - examples/rails-7-barebones/tests-e2e/rails_7_barebones_test.rb
279
+ - examples/rails-7-barebones/wait-for.sh
280
+ - lib/splunk/otel.rb
281
+ - lib/splunk/otel/common.rb
282
+ - lib/splunk/otel/instrumentation/action_pack.rb
283
+ - lib/splunk/otel/instrumentation/action_pack/instrumentation.rb
284
+ - lib/splunk/otel/instrumentation/action_pack/railtie.rb
285
+ - lib/splunk/otel/instrumentation/action_pack/version.rb
286
+ - lib/splunk/otel/instrumentation/rack.rb
287
+ - lib/splunk/otel/instrumentation/rack/middleware.rb
288
+ - lib/splunk/otel/logging.rb
289
+ - lib/splunk/otel/version.rb
290
+ - scripts/install-release-deps.sh
291
+ - scripts/release.sh
292
+ - splunk-otel.gemspec
293
+ homepage: https://github.com/signalfx/splunk-otel-ruby
294
+ licenses: []
295
+ metadata:
296
+ rubygems_mfa_required: 'true'
297
+ post_install_message:
298
+ rdoc_options: []
299
+ require_paths:
300
+ - lib
301
+ required_ruby_version: !ruby/object:Gem::Requirement
302
+ requirements:
303
+ - - ">="
304
+ - !ruby/object:Gem::Version
305
+ version: 2.6.0
306
+ required_rubygems_version: !ruby/object:Gem::Requirement
307
+ requirements:
308
+ - - ">="
309
+ - !ruby/object:Gem::Version
310
+ version: '0'
311
+ requirements: []
312
+ rubygems_version: 3.3.7
313
+ signing_key:
314
+ specification_version: 4
315
+ summary: Splunk OpenTelemetry Ruby distribution
316
+ test_files: []