opentelemetry-instrumentation-que 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 1704f5e2fdd57330cd6c2d5da1d522bf224d8d0b97c33a713bf258b66d8bffb5
4
+ data.tar.gz: ec7f743861ee2f30a75e70f96c5c161c2fd692b49a7199f1146ec546f97dc5b2
5
+ SHA512:
6
+ metadata.gz: 321b908a1eb46a075e69bca045e5a347615f9b72334e9cd3e3d3df0eb01a462f108054f9adc8cc10b6ae43fd64023d179e51a08424e5350b3dc7da2e8ee3e4ee
7
+ data.tar.gz: 12413bbe07dda7e8ebe5130945efdf3f4cb3b880dc18cf350788b4f773ca3e5e0e3e1cd4e56f24cfb61811515bc559892b8a03796a35c094f2d732a20f0f7774
data/.yardopts ADDED
@@ -0,0 +1,9 @@
1
+ --no-private
2
+ --title=OpenTelemetry Que Instrumentation
3
+ --markup=markdown
4
+ --main=README.md
5
+ ./lib/opentelemetry/instrumentation/**/*.rb
6
+ ./lib/opentelemetry/instrumentation.rb
7
+ -
8
+ README.md
9
+ CHANGELOG.md
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ # Release History: opentelemetry-instrumentation-que
2
+
3
+ ### v0.1.0 / 2021-09-15
4
+
5
+ * Initial release.
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright The OpenTelemetry Authors
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,78 @@
1
+ # Que Instrumentation
2
+
3
+ The Que instrumentation is a community-maintained instrumentation for the [Que][que-home].
4
+
5
+ ## How do I get started?
6
+
7
+ Install the gem using:
8
+
9
+ ```
10
+ gem install opentelemetry-instrumentation-que
11
+ ```
12
+
13
+ Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-que` to your `Gemfile`.
14
+
15
+ ## Usage
16
+
17
+ To install the instrumentation, add the gem to your Gemfile:
18
+
19
+ ```ruby
20
+ gem 'opentelemetry-instrumentation-que'
21
+ ```
22
+
23
+ Then call `use` with the name of the instrumentation:
24
+
25
+ ```ruby
26
+ require 'rubygems'
27
+ require 'bundler/setup'
28
+
29
+ Bundler.require
30
+
31
+ OpenTelemetry::SDK.configure do |c|
32
+ c.use 'OpenTelemetry::Instrumentation::Que'
33
+ end
34
+ ```
35
+
36
+ Alternatively, you can also call `use_all` to install all the available instrumentation.
37
+
38
+ ```ruby
39
+ OpenTelemetry::SDK.configure do |c|
40
+ c.use_all
41
+ end
42
+ ```
43
+
44
+ By default tracing information is propagated using Que Job tags. This can be disabled using:
45
+
46
+ ```ruby
47
+ OpenTelemetry::SDK.configure do |c|
48
+ c.use 'OpenTelemetry::Instrumentation::Que', propagation_style: :none
49
+ end
50
+ ```
51
+
52
+ If you wish the job will be executed in the same logicial trace as a direct
53
+ child of the span that enqueued the job then set propagation_style to `child`. By
54
+ default the jobs are just linked together.
55
+
56
+ ```ruby
57
+ OpenTelemetry::SDK.configure do |c|
58
+ c.use 'OpenTelemetry::Instrumentation::Que', propagation_style: :child
59
+ end
60
+ ```
61
+
62
+ ## How can I get involved?
63
+
64
+ The `opentelemetry-instrumentation-que` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
65
+
66
+ The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
67
+
68
+ ## License
69
+
70
+ The `opentelemetry-instrumentation-que` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
71
+
72
+ [que-home]: https://github.com/que-rb/que
73
+ [bundler-home]: https://bundler.io
74
+ [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
75
+ [license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
76
+ [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
77
+ [community-meetings]: https://github.com/open-telemetry/community#community-meetings
78
+ [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
@@ -0,0 +1,67 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module Instrumentation
9
+ module Que
10
+ # The Instrumentation class contains logic to detect and install the Que
11
+ # instrumentation
12
+ class Instrumentation < OpenTelemetry::Instrumentation::Base
13
+ MINIMUM_VERSION = Gem::Version.new('1.0.0.beta4')
14
+
15
+ install do |_|
16
+ require_dependencies
17
+ patch
18
+
19
+ ::Que.job_middleware.push(Middlewares::ServerMiddleware)
20
+ end
21
+
22
+ present do
23
+ defined?(::Que)
24
+ end
25
+
26
+ compatible do
27
+ gem_version >= MINIMUM_VERSION
28
+ end
29
+
30
+ ## Supported configuration keys for the install config hash:
31
+ #
32
+ # propagation_style: controls how the job's execution is traced and related
33
+ # to the trace where the job was enqueued. Can be one of:
34
+ #
35
+ # - :link (default) - the job will be executed in a separate trace.
36
+ # The initial span of the execution trace will be linked to the span
37
+ # that enqueued the job, via a Span Link.
38
+ # - :child - the job will be executed in the same logical trace, as a
39
+ # direct child of the span that enqueued the job.
40
+ # - :none - the job's execution will not be explicitly linked to the
41
+ # span that enqueued the job.
42
+ #
43
+ # Note that in all cases, we will store Que's Job ID as the
44
+ # `messaging.message_id` attribute, so out-of-band correlation may
45
+ # still be possible depending on your backend system.
46
+ #
47
+ option :propagation_style, default: :link, validate: ->(opt) { %i[link child none].include?(opt) }
48
+
49
+ private
50
+
51
+ def require_dependencies
52
+ require_relative 'tag_setter'
53
+ require_relative 'middlewares/server_middleware'
54
+ require_relative 'patches/que_job'
55
+ end
56
+
57
+ def gem_version
58
+ Gem.loaded_specs['que'].version
59
+ end
60
+
61
+ def patch
62
+ ::Que::Job.prepend(Patches::QueJob)
63
+ end
64
+ end
65
+ end
66
+ end
67
+ end
@@ -0,0 +1,95 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module Instrumentation
9
+ module Que
10
+ module Middlewares
11
+ # Server middleware to trace Que jobs
12
+ class ServerMiddleware
13
+ def self.call(job, &block) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
14
+ job_class = job_class(job)
15
+ span_name = "#{job_class} process"
16
+ attributes = attributes_before_job_completion(job, job_class)
17
+
18
+ extracted_context = extract_context_from_tags(job.que_attrs[:data][:tags] || [])
19
+
20
+ OpenTelemetry::Context.with_current(extracted_context) do
21
+ if otel_config[:propagation_style] == :child
22
+ tracer.in_span(span_name, attributes: attributes, kind: :consumer) do |span|
23
+ block.call
24
+ enhance_span_after_job_completion(span, job)
25
+ end
26
+ else
27
+ span_links = otel_config[:propagation_style] == :link ? prepare_span_links(extracted_context) : []
28
+
29
+ root_span = tracer.start_root_span(span_name, attributes: attributes, links: span_links, kind: :consumer)
30
+ OpenTelemetry::Trace.with_span(root_span) do |span|
31
+ block.call
32
+ enhance_span_after_job_completion(span, job)
33
+ ensure
34
+ root_span.finish
35
+ end
36
+ end
37
+ end
38
+
39
+ # return value is not important
40
+ nil
41
+ end
42
+
43
+ def self.tracer
44
+ OpenTelemetry::Instrumentation::Que::Instrumentation.instance.tracer
45
+ end
46
+
47
+ def self.otel_config
48
+ Que::Instrumentation.instance.config
49
+ end
50
+
51
+ def self.attributes_before_job_completion(job, job_class)
52
+ attributes = {
53
+ 'messaging.system' => 'que',
54
+ 'messaging.destination' => job.que_attrs[:queue] || 'default',
55
+ 'messaging.destination_kind' => 'queue',
56
+ 'messaging.operation' => 'process',
57
+ 'messaging.que.job_class' => job_class,
58
+ 'messaging.que.priority' => job.que_attrs[:priority] || 100
59
+ }
60
+ attributes['messaging.message_id'] = job.que_attrs[:id] if job.que_attrs[:id]
61
+ attributes
62
+ end
63
+
64
+ def self.enhance_span_after_job_completion(span, job)
65
+ span.set_attribute('messaging.que.attempts', job.que_attrs[:error_count])
66
+
67
+ error = job.que_error
68
+ return unless error
69
+
70
+ span.record_exception(error)
71
+ span.status = OpenTelemetry::Trace::Status.error("Unhandled exception of type: #{error.class}")
72
+ end
73
+
74
+ # tags is an array looking something like ["tag1", "traceparent:..."]
75
+ def self.extract_context_from_tags(tags)
76
+ # Convert tags into Hash (ignoring elements that cannot be converted)
77
+ tags_hash = Hash[
78
+ tags.map { |value| value.split(':', 2) }.select { |value| value.size == 2 }
79
+ ]
80
+ OpenTelemetry.propagation.extract(tags_hash)
81
+ end
82
+
83
+ def self.job_class(job)
84
+ job.que_attrs[:job_class] || job.class.name
85
+ end
86
+
87
+ def self.prepare_span_links(extracted_context)
88
+ span_context = OpenTelemetry::Trace.current_span(extracted_context).context
89
+ span_context.valid? ? [OpenTelemetry::Trace::Link.new(span_context)] : []
90
+ end
91
+ end
92
+ end
93
+ end
94
+ end
95
+ end
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module Instrumentation
9
+ module Que
10
+ module Patches
11
+ # Module to prepend to Que::Job for instrumentation
12
+ module QueJob
13
+ def self.prepended(base)
14
+ class << base
15
+ prepend ClassMethods
16
+ end
17
+ end
18
+
19
+ # Module to prepend to Que singleton class
20
+ module ClassMethods
21
+ def enqueue(*args, tags: nil, **arg_opts)
22
+ tracer = Que::Instrumentation.instance.tracer
23
+ otel_config = Que::Instrumentation.instance.config
24
+
25
+ tracer.in_span('send', kind: :producer) do |span|
26
+ # Que doesn't have a good place to store metadata. There are
27
+ # basically two options: the job payload and the job tags.
28
+ #
29
+ # Using the job payload is very brittle. We'd have to modify
30
+ # existing Hash arguments or add a new argument when there are
31
+ # no arguments we can modify. If the server side is not using
32
+ # this instrumentation yet (e.g. old jobs before the
33
+ # instrumentation was added or when instrumentation is being
34
+ # added to client side first) then the server can error out due
35
+ # to unexpected payload.
36
+ #
37
+ # The second option (which we are using here) is to use tags.
38
+ # They also are not meant for tracing information but they are
39
+ # much safer to use than modifying the payload.
40
+ if otel_config[:propagation_style] != :none
41
+ tags ||= []
42
+ OpenTelemetry.propagation.inject(tags, setter: TagSetter)
43
+ end
44
+
45
+ job = super(*args, tags: tags, **arg_opts)
46
+
47
+ span.name = "#{job.que_attrs[:job_class]} send"
48
+ span.add_attributes(QueJob.job_attributes(job))
49
+
50
+ job
51
+ end
52
+ end
53
+ end
54
+
55
+ def self.job_attributes(job)
56
+ attributes = {
57
+ 'messaging.system' => 'que',
58
+ 'messaging.destination_kind' => 'queue',
59
+ 'messaging.operation' => 'send',
60
+ 'messaging.destination' => job.que_attrs[:queue] || 'default',
61
+ 'messaging.que.job_class' => job.que_attrs[:job_class],
62
+ 'messaging.que.priority' => job.que_attrs[:priority] || 100
63
+ }
64
+ attributes['messaging.message_id'] = job.que_attrs[:id] if job.que_attrs[:id]
65
+ attributes
66
+ end
67
+ end
68
+ end
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module Instrumentation
9
+ module Que
10
+ # The TagSetter class provides methods for writing tracing information to
11
+ # Que tags.
12
+ #
13
+ # @example
14
+ # OpenTelemetry.propagation.inject(tags, setter: TagSetter)
15
+ class TagSetter
16
+ def self.set(carrier, key, value)
17
+ carrier << "#{key}:#{value}"
18
+ end
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module Instrumentation
9
+ module Que
10
+ VERSION = '0.1.0'
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ require 'opentelemetry'
8
+ require 'opentelemetry-instrumentation-base'
9
+
10
+ module OpenTelemetry
11
+ module Instrumentation
12
+ # Contains the OpenTelemetry instrumentation for the Que gem
13
+ module Que
14
+ end
15
+ end
16
+ end
17
+
18
+ require_relative './que/instrumentation'
19
+ require_relative './que/version'
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ # OpenTelemetry is an open source observability framework, providing a
8
+ # general-purpose API, SDK, and related tools required for the instrumentation
9
+ # of cloud-native software, frameworks, and libraries.
10
+ #
11
+ # The OpenTelemetry module provides global accessors for telemetry objects.
12
+ # See the documentation for the `opentelemetry-api` gem for details.
13
+ module OpenTelemetry
14
+ # "Instrumentation" are specified by
15
+ # https://github.com/open-telemetry/opentelemetry-specification/blob/784635d01d8690c8f5fcd1f55bdbc8a13cf2f4f2/specification/glossary.md#instrumentation-library
16
+ #
17
+ # Instrumentation should be able to handle the case when the library is not installed on a user's system.
18
+ module Instrumentation
19
+ end
20
+ end
21
+
22
+ require_relative './instrumentation/que'
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ require_relative './opentelemetry/instrumentation'
metadata ADDED
@@ -0,0 +1,255 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: opentelemetry-instrumentation-que
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - OpenTelemetry Authors
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-09-15 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.0.rc3
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.0.rc3
27
+ - !ruby/object:Gem::Dependency
28
+ name: opentelemetry-instrumentation-base
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 0.18.2
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 0.18.2
41
+ - !ruby/object:Gem::Dependency
42
+ name: activerecord
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '6.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '6.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: appraisal
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 2.2.0
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 2.2.0
69
+ - !ruby/object:Gem::Dependency
70
+ name: bundler
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '1.17'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '1.17'
83
+ - !ruby/object:Gem::Dependency
84
+ name: minitest
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '5.0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '5.0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: opentelemetry-sdk
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: 1.0.0.rc1
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: 1.0.0.rc1
111
+ - !ruby/object:Gem::Dependency
112
+ name: pg
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '1.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.1'
125
+ - !ruby/object:Gem::Dependency
126
+ name: que
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: 1.0.0.beta4
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: 1.0.0.beta4
139
+ - !ruby/object:Gem::Dependency
140
+ name: rake
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: '13.0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: '13.0'
153
+ - !ruby/object:Gem::Dependency
154
+ name: rubocop
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: 0.73.0
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: 0.73.0
167
+ - !ruby/object:Gem::Dependency
168
+ name: simplecov
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: 0.17.1
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - "~>"
179
+ - !ruby/object:Gem::Version
180
+ version: 0.17.1
181
+ - !ruby/object:Gem::Dependency
182
+ name: yard
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - "~>"
186
+ - !ruby/object:Gem::Version
187
+ version: '0.9'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - "~>"
193
+ - !ruby/object:Gem::Version
194
+ version: '0.9'
195
+ - !ruby/object:Gem::Dependency
196
+ name: yard-doctest
197
+ requirement: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - "~>"
200
+ - !ruby/object:Gem::Version
201
+ version: 0.1.6
202
+ type: :development
203
+ prerelease: false
204
+ version_requirements: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - "~>"
207
+ - !ruby/object:Gem::Version
208
+ version: 0.1.6
209
+ description: Que instrumentation for the OpenTelemetry framework
210
+ email:
211
+ - cncf-opentelemetry-contributors@lists.cncf.io
212
+ executables: []
213
+ extensions: []
214
+ extra_rdoc_files: []
215
+ files:
216
+ - ".yardopts"
217
+ - CHANGELOG.md
218
+ - LICENSE
219
+ - README.md
220
+ - lib/opentelemetry-instrumentation-que.rb
221
+ - lib/opentelemetry/instrumentation.rb
222
+ - lib/opentelemetry/instrumentation/que.rb
223
+ - lib/opentelemetry/instrumentation/que/instrumentation.rb
224
+ - lib/opentelemetry/instrumentation/que/middlewares/server_middleware.rb
225
+ - lib/opentelemetry/instrumentation/que/patches/que_job.rb
226
+ - lib/opentelemetry/instrumentation/que/tag_setter.rb
227
+ - lib/opentelemetry/instrumentation/que/version.rb
228
+ homepage: https://github.com/open-telemetry/opentelemetry-ruby
229
+ licenses:
230
+ - Apache-2.0
231
+ metadata:
232
+ changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-que/v0.1.0/file.CHANGELOG.html
233
+ source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/que
234
+ bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
235
+ documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-que/v0.1.0
236
+ post_install_message:
237
+ rdoc_options: []
238
+ require_paths:
239
+ - lib
240
+ required_ruby_version: !ruby/object:Gem::Requirement
241
+ requirements:
242
+ - - ">="
243
+ - !ruby/object:Gem::Version
244
+ version: 2.5.0
245
+ required_rubygems_version: !ruby/object:Gem::Requirement
246
+ requirements:
247
+ - - ">="
248
+ - !ruby/object:Gem::Version
249
+ version: '0'
250
+ requirements: []
251
+ rubygems_version: 3.1.6
252
+ signing_key:
253
+ specification_version: 4
254
+ summary: Que instrumentation for the OpenTelemetry framework
255
+ test_files: []