opentelemetry-instrumentation-grape 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: 25c8a076ac07f11cfc5d41bf7035adc5ce3579c0c3ce3a943fb8846ad08e5dd9
4
+ data.tar.gz: 42b13be6617af1fbc786791ba8dd0474bdcea8e43dd8334d141c5cab281cddff
5
+ SHA512:
6
+ metadata.gz: db42d81e80b02223e51ec84df978ec6e01c889ccbe6429e2ba6605ab8c946610b55a0efa77e96b816be17c2e4443c7224335a8212bfd700df191eef03d1a1c65
7
+ data.tar.gz: f6f6dac0041d2e34afea5808745181684da05ef6bdb2c1d971b1c024aa46ff251f6ea8f7737f5a11332d3ba459bef18bcaffd40dddfc1d4ef9f35ff0318fb3e6
data/.yardopts ADDED
@@ -0,0 +1,9 @@
1
+ --no-private
2
+ --title=OpenTelemetry Grape 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-grape
2
+
3
+ ### v0.1.0 / 2023-04-17
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,91 @@
1
+ # OpenTelemetry Grape Instrumentation
2
+
3
+ The Grape instrumentation is a community-maintained instrumentation for [Grape][grape], a REST-like API framework for Ruby.
4
+
5
+ It relies on the Grape built-in support for `ActiveSupport::Notifications` (more info [here](https://github.com/ruby-grape/grape#active-support-instrumentation)) and the [OpenTelemetry Rack instrumentation](opentelemetry-rack-instrumentation).
6
+
7
+ It currently supports the following events:
8
+
9
+ - `endpoint_run.grape`
10
+ - `endpoint_render.grape`
11
+ - `endpoint_run_filters.grape`
12
+ - `format_response.grape`
13
+
14
+ ## How do I get started?
15
+
16
+ Install the gem using:
17
+
18
+ ```
19
+ gem install opentelemetry-instrumentation-grape
20
+ ```
21
+
22
+ Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-grape` in your `Gemfile`.
23
+
24
+ ## Usage
25
+
26
+ To use the instrumentation, call `use` with the name of the instrumentation:
27
+
28
+ ```ruby
29
+ OpenTelemetry::SDK.configure do |c|
30
+ c.use 'OpenTelemetry::Instrumentation::Grape'
31
+ end
32
+ ```
33
+
34
+ Grape is "designed to run on Rack or complement existing web application frameworks such as Rails and Sinatra". As a result, this instrumentation uses the Rack instrumentation and modifies the Rack spans, modifying the span name and adding Grape attributes and events. It is recommended to use it along with Rails and/or Sinatra instrumentations, if any of these frameworks are being used.
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
+ ### Configuration options
45
+
46
+ #### `:ignored_events` (array)
47
+
48
+ Indicate if any events should not produce spans.
49
+
50
+ - Accepted values: `:endpoint_render`, `:endpoint_run_filters`, `:format_response`.
51
+ - Defaults to `[]` (no ignored events).
52
+
53
+ Example:
54
+
55
+ ```ruby
56
+ OpenTelemetry::SDK.configure do |c|
57
+ c.use 'OpenTelemetry::Instrumentation::Grape', { ignored_events: [:endpoint_run_filters] }
58
+ end
59
+ ```
60
+
61
+ Note that the `endpoint_run` event cannot be ignored. If you need to disable the instrumentation, set `:enabled` to `false`:
62
+
63
+ ```ruby
64
+ OpenTelemetry::SDK.configure do |c|
65
+ config = { 'OpenTelemetry::Instrumentation::Grape' => { enabled: false } }
66
+ c.use_all(config)
67
+ end
68
+ ```
69
+
70
+ ## Examples
71
+
72
+ Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/grape/example/trace_demonstration.rb)
73
+
74
+ ## How can I get involved?
75
+
76
+ The `opentelemetry-instrumentation-grape` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
77
+
78
+ 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].
79
+
80
+ ## License
81
+
82
+ The `opentelemetry-instrumentation-grape` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
83
+
84
+ [bundler-home]: https://bundler.io
85
+ [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
86
+ [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
87
+ [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
88
+ [community-meetings]: https://github.com/open-telemetry/community#community-meetings
89
+ [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
90
+ [grape]: https://github.com/ruby-grape/grape
91
+ [opentelemetry-rack-instrumentation]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/rack
@@ -0,0 +1,111 @@
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 Grape
10
+ # Handles the events instrumented with ActiveSupport notifications.
11
+ # These handlers contain all the logic needed to create and connect spans.
12
+ class EventHandler
13
+ class << self
14
+ # Handles the start of the endpoint_run event, modifying the parent Rack span
15
+ # and recording it as a span event
16
+ def endpoint_run(_name, start, _finish, _id, payload)
17
+ span = OpenTelemetry::Instrumentation::Rack.current_span
18
+ return unless span.recording?
19
+
20
+ endpoint = payload[:endpoint]
21
+ span.name = span_name(endpoint)
22
+ span.add_attributes(attributes_from_grape_endpoint(endpoint))
23
+
24
+ span.add_event('grape.endpoint_run', timestamp: start)
25
+ handle_payload_exception(span, payload[:exception_object]) if payload[:exception_object]
26
+ end
27
+
28
+ # Handles the endpoint_render event, recording it as a span event
29
+ def endpoint_render(_name, start, _finish, _id, payload)
30
+ span = OpenTelemetry::Instrumentation::Rack.current_span
31
+ return unless span.recording?
32
+
33
+ span.add_event('grape.endpoint_render', timestamp: start)
34
+ end
35
+
36
+ # Handles the endpoint_run_filters events, recording them as a span event
37
+ def endpoint_run_filters(_name, start, finish, _id, payload)
38
+ span = OpenTelemetry::Instrumentation::Rack.current_span
39
+ return unless span.recording?
40
+
41
+ filters = payload[:filters]
42
+ type = payload[:type]
43
+
44
+ # Prevent submitting empty filters
45
+ return if (!filters || filters.empty?) || !type || (finish - start).zero?
46
+
47
+ attributes = { 'grape.filter.type' => type.to_s }
48
+ span.add_event('grape.endpoint_run_filters', attributes: attributes, timestamp: start)
49
+ end
50
+
51
+ # Handles the format_response event, recording it as a span event
52
+ def format_response(_name, start, _finish, _id, payload)
53
+ span = OpenTelemetry::Instrumentation::Rack.current_span
54
+ return unless span.recording?
55
+
56
+ attributes = {
57
+ 'grape.formatter.type' => formatter_type(payload[:formatter])
58
+ }
59
+ span.add_event('grape.format_response', attributes: attributes, timestamp: start)
60
+ handle_payload_exception(span, payload[:exception_object]) if payload[:exception_object]
61
+ end
62
+
63
+ private
64
+
65
+ def span_name(endpoint)
66
+ "HTTP #{request_method(endpoint)} #{path(endpoint)}"
67
+ end
68
+
69
+ def attributes_from_grape_endpoint(endpoint)
70
+ {
71
+ OpenTelemetry::SemanticConventions::Trace::CODE_NAMESPACE => endpoint.options[:for]&.base.to_s,
72
+ OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE => path(endpoint)
73
+ }
74
+ end
75
+
76
+ # ActiveSupport::Notifications will attach a `:exception_object` to the payload if there was
77
+ # an error raised during the execution of the &block associated to the Notification.
78
+ def handle_payload_exception(span, exception)
79
+ # Only record exceptions if they were not raised (i.e. do not have a status code in Grape)
80
+ # or do not have a 5xx status code. These exceptions are recorded by Rack.
81
+ # See instrumentation/rack/lib/opentelemetry/instrumentation/rack/middlewares/tracer_middleware.rb#L155
82
+ return unless exception.respond_to?('status') && exception.status.to_i < 500
83
+
84
+ span.record_exception(exception)
85
+ span.status = OpenTelemetry::Trace::Status.error("Unhandled exception of type: #{exception.class}")
86
+ end
87
+
88
+ def request_method(endpoint)
89
+ endpoint.options[:method]&.first
90
+ end
91
+
92
+ def path(endpoint)
93
+ return '' unless endpoint.routes
94
+
95
+ namespace = endpoint.routes.first.namespace
96
+ version = endpoint.routes.first.options[:version] || ''
97
+ prefix = endpoint.routes.first.options[:prefix]&.to_s || ''
98
+ parts = [prefix, version] + namespace.split('/') + endpoint.options[:path]
99
+ parts.reject { |p| p.blank? || p.eql?('/') }.join('/').prepend('/')
100
+ end
101
+
102
+ def formatter_type(formatter)
103
+ basename = formatter.name.split('::').last
104
+ # Convert from CamelCase to snake_case
105
+ basename.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
106
+ end
107
+ end
108
+ end
109
+ end
110
+ end
111
+ 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 Grape
10
+ # The Instrumentation class contains logic to detect and install the Grape instrumentation
11
+ class Instrumentation < OpenTelemetry::Instrumentation::Base
12
+ # Minimum Grape version needed for compatibility with this instrumentation
13
+ MINIMUM_VERSION = Gem::Version.new('1.2.0')
14
+
15
+ install do |_config|
16
+ install_rack_instrumentation
17
+ require_dependencies
18
+ subscribe
19
+ end
20
+
21
+ present do
22
+ defined?(::Grape)
23
+ end
24
+
25
+ compatible do
26
+ !defined?(::ActiveSupport::Notifications).nil? && gem_version >= MINIMUM_VERSION
27
+ end
28
+
29
+ option :ignored_events, default: [], validate: :array
30
+
31
+ private
32
+
33
+ def gem_version
34
+ Gem::Version.new(::Grape::VERSION)
35
+ end
36
+
37
+ def install_rack_instrumentation
38
+ OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.install({})
39
+ end
40
+
41
+ def require_dependencies
42
+ require_relative 'subscriber'
43
+ end
44
+
45
+ def subscribe
46
+ Subscriber.subscribe
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,49 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ require_relative 'event_handler'
8
+
9
+ module OpenTelemetry
10
+ module Instrumentation
11
+ module Grape
12
+ # Manages all subscriptions, both for custom subscribers and built-in notifications
13
+ class Subscriber
14
+ class << self
15
+ # Subscribe to all notifications (except those specified in the :ignored_events configs)
16
+ def subscribe
17
+ subscriptions = filter_ignored_events(SUBSCRIPTIONS)
18
+ subscriptions.each do |subscriber_method, event|
19
+ ::ActiveSupport::Notifications.subscribe(event) do |*args|
20
+ EventHandler.send(subscriber_method, *args)
21
+ end
22
+ end
23
+ end
24
+
25
+ private
26
+
27
+ # ActiveSupport::Notifications that can be subscribed to using the documented `.subscribe` interface.
28
+ # Reference: https://api.rubyonrails.org/classes/ActiveSupport/Notifications.html#method-c-subscribe
29
+ SUBSCRIPTIONS = {
30
+ endpoint_run: 'endpoint_run.grape',
31
+ endpoint_render: 'endpoint_render.grape',
32
+ endpoint_run_filters: 'endpoint_run_filters.grape',
33
+ format_response: 'format_response.grape'
34
+ }.freeze
35
+
36
+ def filter_ignored_events(subscriptions)
37
+ # Do not ignore 'endpoint_run' event
38
+ ignored_events = config[:ignored_events] - [:endpoint_run]
39
+ subscriptions.reject { |event| ignored_events.include?(event) }
40
+ end
41
+
42
+ def config
43
+ Grape::Instrumentation.instance.config
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,14 @@
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 Grape
10
+ # Current gem version
11
+ VERSION = '0.1.0'
12
+ end
13
+ end
14
+ 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 Grape gem
13
+ module Grape
14
+ end
15
+ end
16
+ end
17
+
18
+ require_relative './grape/instrumentation'
19
+ require_relative './grape/version'
@@ -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/grape'
@@ -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,310 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: opentelemetry-instrumentation-grape
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: 2023-04-17 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.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.1.0
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.22.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.22.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: opentelemetry-instrumentation-rack
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '0.21'
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'
55
+ - !ruby/object:Gem::Dependency
56
+ name: activesupport
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: appraisal
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 2.2.0
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 2.2.0
83
+ - !ruby/object:Gem::Dependency
84
+ name: bundler
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '2.4'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '2.4'
97
+ - !ruby/object:Gem::Dependency
98
+ name: grape
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '1.2'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '1.2'
111
+ - !ruby/object:Gem::Dependency
112
+ name: minitest
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '5.0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '5.0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: opentelemetry-sdk
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '1.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.0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: opentelemetry-test-helpers
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: '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'
153
+ - !ruby/object:Gem::Dependency
154
+ name: rack-test
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - ">="
158
+ - !ruby/object:Gem::Version
159
+ version: '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'
167
+ - !ruby/object:Gem::Dependency
168
+ name: rake
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: '13.0'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - "~>"
179
+ - !ruby/object:Gem::Version
180
+ version: '13.0'
181
+ - !ruby/object:Gem::Dependency
182
+ name: rspec-mocks
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - ">="
186
+ - !ruby/object:Gem::Version
187
+ version: '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'
195
+ - !ruby/object:Gem::Dependency
196
+ name: rubocop
197
+ requirement: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - "~>"
200
+ - !ruby/object:Gem::Version
201
+ version: 1.48.1
202
+ type: :development
203
+ prerelease: false
204
+ version_requirements: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - "~>"
207
+ - !ruby/object:Gem::Version
208
+ version: 1.48.1
209
+ - !ruby/object:Gem::Dependency
210
+ name: simplecov
211
+ requirement: !ruby/object:Gem::Requirement
212
+ requirements:
213
+ - - "~>"
214
+ - !ruby/object:Gem::Version
215
+ version: 0.17.1
216
+ type: :development
217
+ prerelease: false
218
+ version_requirements: !ruby/object:Gem::Requirement
219
+ requirements:
220
+ - - "~>"
221
+ - !ruby/object:Gem::Version
222
+ version: 0.17.1
223
+ - !ruby/object:Gem::Dependency
224
+ name: webmock
225
+ requirement: !ruby/object:Gem::Requirement
226
+ requirements:
227
+ - - "~>"
228
+ - !ruby/object:Gem::Version
229
+ version: 3.7.6
230
+ type: :development
231
+ prerelease: false
232
+ version_requirements: !ruby/object:Gem::Requirement
233
+ requirements:
234
+ - - "~>"
235
+ - !ruby/object:Gem::Version
236
+ version: 3.7.6
237
+ - !ruby/object:Gem::Dependency
238
+ name: yard
239
+ requirement: !ruby/object:Gem::Requirement
240
+ requirements:
241
+ - - "~>"
242
+ - !ruby/object:Gem::Version
243
+ version: '0.9'
244
+ type: :development
245
+ prerelease: false
246
+ version_requirements: !ruby/object:Gem::Requirement
247
+ requirements:
248
+ - - "~>"
249
+ - !ruby/object:Gem::Version
250
+ version: '0.9'
251
+ - !ruby/object:Gem::Dependency
252
+ name: yard-doctest
253
+ requirement: !ruby/object:Gem::Requirement
254
+ requirements:
255
+ - - "~>"
256
+ - !ruby/object:Gem::Version
257
+ version: 0.1.6
258
+ type: :development
259
+ prerelease: false
260
+ version_requirements: !ruby/object:Gem::Requirement
261
+ requirements:
262
+ - - "~>"
263
+ - !ruby/object:Gem::Version
264
+ version: 0.1.6
265
+ description: Grape instrumentation for the OpenTelemetry framework
266
+ email:
267
+ - cncf-opentelemetry-contributors@lists.cncf.io
268
+ executables: []
269
+ extensions: []
270
+ extra_rdoc_files: []
271
+ files:
272
+ - ".yardopts"
273
+ - CHANGELOG.md
274
+ - LICENSE
275
+ - README.md
276
+ - lib/opentelemetry-instrumentation-grape.rb
277
+ - lib/opentelemetry/instrumentation.rb
278
+ - lib/opentelemetry/instrumentation/grape.rb
279
+ - lib/opentelemetry/instrumentation/grape/event_handler.rb
280
+ - lib/opentelemetry/instrumentation/grape/instrumentation.rb
281
+ - lib/opentelemetry/instrumentation/grape/subscriber.rb
282
+ - lib/opentelemetry/instrumentation/grape/version.rb
283
+ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
284
+ licenses:
285
+ - Apache-2.0
286
+ metadata:
287
+ changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-grape/0.1.0/file/CHANGELOG.md
288
+ source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/grape
289
+ bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
290
+ documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-grape/0.1.0
291
+ post_install_message:
292
+ rdoc_options: []
293
+ require_paths:
294
+ - lib
295
+ required_ruby_version: !ruby/object:Gem::Requirement
296
+ requirements:
297
+ - - ">="
298
+ - !ruby/object:Gem::Version
299
+ version: '3.0'
300
+ required_rubygems_version: !ruby/object:Gem::Requirement
301
+ requirements:
302
+ - - ">="
303
+ - !ruby/object:Gem::Version
304
+ version: '0'
305
+ requirements: []
306
+ rubygems_version: 3.2.33
307
+ signing_key:
308
+ specification_version: 4
309
+ summary: Grape instrumentation for the OpenTelemetry framework
310
+ test_files: []