opentelemetry-instrumentation-bunny 0.18.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: 7017b44c6e5771d43df19a8cae34b9fc09aa1704fcc6a7fee2647533e5139293
4
+ data.tar.gz: 23d03bf9f48589519802c6ca15d481ceef3bf74e02be14deabae4daf5159d8c7
5
+ SHA512:
6
+ metadata.gz: 5d2004d14ff1e155c5ce8cddfca3d0e9bdf88a95f1fa58d4397700408c2bc6e94b8947bdb1c52d164a663e6e7871ad8cfedf1161d919518fb3dcf827da2c8245
7
+ data.tar.gz: 92ed569d2efdb8619e11898d5f5a4ea9a021f6121f3f8fc1bcf051f234249de5dfd5569270c8d29a4f379298f1fc8d4139a09f52df404f34e598e679e93de53b
data/.yardopts ADDED
@@ -0,0 +1,9 @@
1
+ --no-private
2
+ --title=OpenTelemetry Bunny 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-bunny
2
+
3
+ ### v0.18.0 / 2021-05-21
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,53 @@
1
+ # OpenTelemetry bunny Instrumentation
2
+
3
+ The bunny instrumentation is a community-maintained instrumentation for [bunny][bunny-home], a client library for RabbitMQ.
4
+
5
+ ## How do I get started?
6
+
7
+ Install the gem using:
8
+
9
+ ```
10
+ gem install opentelemetry-instrumentation-bunny
11
+ ```
12
+
13
+ Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-bunny` in your `Gemfile`.
14
+
15
+ ## Usage
16
+
17
+ To use the instrumentation, call `use` with the name of the instrumentation:
18
+
19
+ ```ruby
20
+ OpenTelemetry::SDK.configure do |c|
21
+ c.use 'OpenTelemetry::Instrumentation::Bunny'
22
+ end
23
+ ```
24
+
25
+ Alternatively, you can also call `use_all` to install all the available instrumentation.
26
+
27
+ ```ruby
28
+ OpenTelemetry::SDK.configure do |c|
29
+ c.use_all
30
+ end
31
+ ```
32
+
33
+ ## Examples
34
+
35
+ Example usage can be seen in the `./example/bunny.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/master/instrumentation/bunny/example/bunny.rb)
36
+
37
+ ## How can I get involved?
38
+
39
+ The `opentelemetry-instrumentation-bunny` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
40
+
41
+ The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] 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].
42
+
43
+ ## License
44
+
45
+ The `opentelemetry-instrumentation-bunny` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
46
+
47
+ [bunny-home]: https://github.com/ruby-amqp/bunny
48
+ [bundler-home]: https://bundler.io
49
+ [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
50
+ [license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
51
+ [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
52
+ [community-meetings]: https://github.com/open-telemetry/community#community-meetings
53
+ [ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby
@@ -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'
@@ -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
+ # 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 should be able to handle the case when the library is not installed on a user's system.
15
+ module Instrumentation
16
+ end
17
+ end
18
+
19
+ require_relative './instrumentation/bunny'
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ require 'opentelemetry'
8
+
9
+ module OpenTelemetry
10
+ module Instrumentation
11
+ # Contains the OpenTelemetry instrumentation for the bunny gem
12
+ module Bunny
13
+ end
14
+ end
15
+ end
16
+
17
+ require_relative './bunny/instrumentation'
18
+ require_relative './bunny/version'
@@ -0,0 +1,41 @@
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 Bunny
10
+ # The Instrumentation class contains logic to detect and install the
11
+ # bunny instrumentation
12
+ class Instrumentation < OpenTelemetry::Instrumentation::Base
13
+ install do |_config|
14
+ require_patches
15
+ patch
16
+ end
17
+
18
+ present do
19
+ defined?(::Bunny)
20
+ end
21
+
22
+ private
23
+
24
+ def require_patches
25
+ require_relative 'patch_helpers'
26
+ require_relative 'patches/channel'
27
+ require_relative 'patches/consumer'
28
+ require_relative 'patches/queue'
29
+ require_relative 'patches/reader_loop'
30
+ end
31
+
32
+ def patch
33
+ ::Bunny::Channel.prepend(Patches::Channel)
34
+ ::Bunny::Consumer.prepend(Patches::Consumer)
35
+ ::Bunny::Queue.prepend(Patches::Queue)
36
+ ::Bunny::ReaderLoop.prepend(Patches::ReaderLoop)
37
+ end
38
+ end
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,94 @@
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 Bunny
10
+ # The PatchHelper module provides functionality shared between patches.
11
+ #
12
+ # For additional details around trace messaging semantics
13
+ # See https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/messaging.md#messaging-attributes
14
+ module PatchHelpers
15
+ def self.with_send_span(channel, tracer, exchange, routing_key, &block)
16
+ attributes = basic_attributes(channel, channel.connection, exchange, routing_key)
17
+ destination = destination_name(exchange, routing_key)
18
+
19
+ tracer.in_span("#{destination} send", attributes: attributes, kind: :producer, &block)
20
+ end
21
+
22
+ def self.with_process_span(channel, tracer, delivery_info, properties, &block)
23
+ destination = destination_name(delivery_info[:exchange], delivery_info[:routing_key])
24
+ parent_context, links = extract_context(properties)
25
+
26
+ OpenTelemetry::Context.with_current(parent_context) do
27
+ tracer.in_span("#{destination} process", links: links, kind: :consumer, &block)
28
+ end
29
+ end
30
+
31
+ def self.destination_name(exchange, routing_key)
32
+ [exchange, routing_key].compact.join('.')
33
+ end
34
+
35
+ def self.extract_context(properties)
36
+ # use the receive span as parent context
37
+ parent_context = OpenTelemetry.propagation.extract(properties[:tracer_receive_headers])
38
+
39
+ # link to the producer context
40
+ producer_context = OpenTelemetry.propagation.extract(properties[:headers])
41
+ producer_span_context = OpenTelemetry::Trace.current_span(producer_context).context
42
+ links = [OpenTelemetry::Trace::Link.new(producer_span_context)] if producer_span_context.valid?
43
+
44
+ [parent_context, links]
45
+ end
46
+
47
+ def self.inject_context_into_property(properties, key)
48
+ properties[key] ||= {}
49
+ OpenTelemetry.propagation.inject(properties[key])
50
+ end
51
+
52
+ def self.trace_enrich_receive_span(span, channel, delivery_info, properties)
53
+ exchange = delivery_info.exchange
54
+ routing_key = delivery_info.routing_key
55
+ destination = OpenTelemetry::Instrumentation::Bunny::PatchHelpers.destination_name(exchange, routing_key)
56
+ destination_kind = OpenTelemetry::Instrumentation::Bunny::PatchHelpers.destination_kind(channel, exchange)
57
+ span.name = "#{destination} receive"
58
+ span['messaging.destination'] = exchange
59
+ span['messaging.destination_kind'] = destination_kind
60
+ span['messaging.rabbitmq.routing_key'] = routing_key if routing_key
61
+ span['messaging.operation'] = 'receive'
62
+
63
+ inject_context_into_property(properties, :tracer_receive_headers)
64
+ end
65
+
66
+ def self.basic_attributes(channel, transport, exchange, routing_key)
67
+ attributes = {
68
+ 'messaging.system' => 'rabbitmq',
69
+ 'messaging.destination' => exchange,
70
+ 'messaging.destination_kind' => destination_kind(channel, exchange),
71
+ 'messaging.protocol' => 'AMQP',
72
+ 'messaging.protocol_version' => ::Bunny.protocol_version,
73
+ 'net.peer.name' => transport.host,
74
+ 'net.peer.port' => transport.port
75
+ }
76
+ attributes['messaging.rabbitmq.routing_key'] = routing_key if routing_key
77
+ attributes
78
+ end
79
+
80
+ def self.destination_kind(channel, exchange)
81
+ # The default exchange with no name is always a direct exchange
82
+ # https://github.com/ruby-amqp/bunny/blob/master/lib/bunny/exchange.rb#L33
83
+ return 'queue' if exchange == ''
84
+
85
+ # All exchange types https://www.rabbitmq.com/tutorials/amqp-concepts.html#exchanges
86
+ # except direct exchanges are mapped to topic
87
+ return 'queue' if channel.find_exchange(exchange)&.type == :direct
88
+
89
+ 'topic'
90
+ end
91
+ end
92
+ end
93
+ end
94
+ end
@@ -0,0 +1,51 @@
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 Bunny
10
+ module Patches
11
+ # The Channel module contains the instrumentation patch the Channel#basic_get, Channel#basic_publish and Channel#handle_frameset methods
12
+ module Channel
13
+ def basic_get(queue, opts = { manual_ack: false })
14
+ attributes = OpenTelemetry::Instrumentation::Bunny::PatchHelpers.basic_attributes(self, connection, '', nil)
15
+
16
+ tracer.in_span("#{queue} receive", attributes: attributes, kind: :consumer) do |span, _ctx|
17
+ delivery_info, properties, payload = super
18
+
19
+ return [delivery_info, properties, payload] unless delivery_info
20
+
21
+ OpenTelemetry::Instrumentation::Bunny::PatchHelpers.trace_enrich_receive_span(span, self, delivery_info, properties)
22
+
23
+ [delivery_info, properties, payload]
24
+ end
25
+ end
26
+
27
+ def basic_publish(payload, exchange, routing_key, opts = {})
28
+ OpenTelemetry::Instrumentation::Bunny::PatchHelpers.with_send_span(self, tracer, exchange, routing_key) do
29
+ OpenTelemetry::Instrumentation::Bunny::PatchHelpers.inject_context_into_property(opts, :headers)
30
+
31
+ super(payload, exchange, routing_key, opts)
32
+ end
33
+ end
34
+
35
+ # This method is called when rabbitmq pushes messages to subscribed consumers
36
+ def handle_frameset(basic_deliver, properties, content)
37
+ OpenTelemetry::Instrumentation::Bunny::PatchHelpers.trace_enrich_receive_span(OpenTelemetry::Trace.current_span, self, basic_deliver, properties) if basic_deliver
38
+
39
+ super
40
+ end
41
+
42
+ private
43
+
44
+ def tracer
45
+ Bunny::Instrumentation.instance.tracer
46
+ end
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,28 @@
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 Bunny
10
+ module Patches
11
+ # The Consumer module contains the instrumentation patch for the Consumer class
12
+ module Consumer
13
+ def call(delivery_info, properties, payload)
14
+ OpenTelemetry::Instrumentation::Bunny::PatchHelpers.with_process_span(queue.channel, tracer, delivery_info, properties) do
15
+ super
16
+ end
17
+ end
18
+
19
+ private
20
+
21
+ def tracer
22
+ Bunny::Instrumentation.instance.tracer
23
+ end
24
+ end
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,32 @@
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 Bunny
10
+ module Patches
11
+ # The Queue module contains the instrumentation patch the Queue#pop method.
12
+ module Queue
13
+ def pop(opts = { manual_ack: false }, &block)
14
+ return super unless block
15
+
16
+ super do |delivery_info, properties, payload|
17
+ OpenTelemetry::Instrumentation::Bunny::PatchHelpers.with_process_span(channel, tracer, delivery_info, properties) do
18
+ yield delivery_info, properties, payload
19
+ end
20
+ end
21
+ end
22
+
23
+ private
24
+
25
+ def tracer
26
+ Bunny::Instrumentation.instance.tracer
27
+ end
28
+ end
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,29 @@
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 Bunny
10
+ module Patches
11
+ # The ReaderLoop module contains the instrumentation patch the ReaderLoop#run_once method
12
+ module ReaderLoop
13
+ def run_once
14
+ attributes = OpenTelemetry::Instrumentation::Bunny::PatchHelpers.basic_attributes(nil, @transport, '', nil)
15
+ tracer.in_span('Bunny::ReaderLoop#run_once', attributes: attributes, kind: :consumer) do
16
+ super
17
+ end
18
+ end
19
+
20
+ private
21
+
22
+ def tracer
23
+ Bunny::Instrumentation.instance.tracer
24
+ end
25
+ end
26
+ end
27
+ end
28
+ end
29
+ 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 Bunny
10
+ VERSION = '0.18.0'
11
+ end
12
+ end
13
+ end
metadata ADDED
@@ -0,0 +1,215 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: opentelemetry-instrumentation-bunny
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.18.0
5
+ platform: ruby
6
+ authors:
7
+ - OpenTelemetry Authors
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-05-21 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.rc1
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.rc1
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.0
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.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.2.0
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 2.2.0
55
+ - !ruby/object:Gem::Dependency
56
+ name: bundler
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '1.17'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '1.17'
69
+ - !ruby/object:Gem::Dependency
70
+ name: bunny
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
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: rubocop
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: 0.73.0
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: 0.73.0
125
+ - !ruby/object:Gem::Dependency
126
+ name: simplecov
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: 0.17.1
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: 0.17.1
139
+ - !ruby/object:Gem::Dependency
140
+ name: yard
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: '0.9'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: '0.9'
153
+ - !ruby/object:Gem::Dependency
154
+ name: yard-doctest
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: 0.1.6
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: 0.1.6
167
+ description: Bunny instrumentation for the OpenTelemetry framework
168
+ email:
169
+ - cncf-opentelemetry-contributors@lists.cncf.io
170
+ executables: []
171
+ extensions: []
172
+ extra_rdoc_files: []
173
+ files:
174
+ - ".yardopts"
175
+ - CHANGELOG.md
176
+ - LICENSE
177
+ - README.md
178
+ - lib/opentelemetry-instrumentation-bunny.rb
179
+ - lib/opentelemetry/instrumentation.rb
180
+ - lib/opentelemetry/instrumentation/bunny.rb
181
+ - lib/opentelemetry/instrumentation/bunny/instrumentation.rb
182
+ - lib/opentelemetry/instrumentation/bunny/patch_helpers.rb
183
+ - lib/opentelemetry/instrumentation/bunny/patches/channel.rb
184
+ - lib/opentelemetry/instrumentation/bunny/patches/consumer.rb
185
+ - lib/opentelemetry/instrumentation/bunny/patches/queue.rb
186
+ - lib/opentelemetry/instrumentation/bunny/patches/reader_loop.rb
187
+ - lib/opentelemetry/instrumentation/bunny/version.rb
188
+ homepage: https://github.com/open-telemetry/opentelemetry-ruby
189
+ licenses:
190
+ - Apache-2.0
191
+ metadata:
192
+ changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-bunny/v0.18.0/file.CHANGELOG.html
193
+ source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/instrumentation/bunny
194
+ bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
195
+ documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-bunny/v0.18.0
196
+ post_install_message:
197
+ rdoc_options: []
198
+ require_paths:
199
+ - lib
200
+ required_ruby_version: !ruby/object:Gem::Requirement
201
+ requirements:
202
+ - - ">="
203
+ - !ruby/object:Gem::Version
204
+ version: 2.5.0
205
+ required_rubygems_version: !ruby/object:Gem::Requirement
206
+ requirements:
207
+ - - ">="
208
+ - !ruby/object:Gem::Version
209
+ version: '0'
210
+ requirements: []
211
+ rubygems_version: 3.1.6
212
+ signing_key:
213
+ specification_version: 4
214
+ summary: Bunny instrumentation for the OpenTelemetry framework
215
+ test_files: []