opentelemetry-instrumentation-active_storage 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: 6c2a8aa946c3d863a37af9bbc206f0ced3ab3b8ec8fc95718eb908e1835d6cf6
4
+ data.tar.gz: a510a203abcdc3efcbff483b4f408a18a8eaa1648296b9a694f50ec09b91d37f
5
+ SHA512:
6
+ metadata.gz: ae8181c9af74c19705cb113b8cf5da6f760cd5e72c76fc5f91891d236b94d5e71dd3212636b6232fde2190b5c0db5392c40115f36b4faedca31f372920f14f47
7
+ data.tar.gz: 205b923f1145fe45b6db521aa9e1a0f5b86de2053f09b9eee9fb3f193f4a630d00eeedccef57ef63d0c7e10ba440b2218cffc2aa6a2ed26ab2d628e12037ea9c
data/.yardopts ADDED
@@ -0,0 +1,9 @@
1
+ --no-private
2
+ --title=OpenTelemetry Active Storage 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-active_storage
2
+
3
+ ### v0.1.0 / 2025-01-29
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,97 @@
1
+ # OpenTelemetry ActiveStorage Instrumentation
2
+
3
+ The ActiveStorage instrumentation is a community-maintained instrumentation for the ActiveStorage portion of the [Ruby on Rails][rails-home] web-application framework.
4
+
5
+ ## How do I get started?
6
+
7
+ Install the gem using:
8
+
9
+ ```bash
10
+ # Install just the ActiveStorage instrumentation
11
+ gem install opentelemetry-instrumentation-active_storage
12
+ # Install the ActiveStorage instrumentation along with the rest of the Rails-related instrumentation
13
+ gem install opentelemetry-instrumentation-rails
14
+ ```
15
+
16
+ Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-active_storage` in your `Gemfile`.
17
+
18
+ ## Usage
19
+
20
+ To use the instrumentation, call `use` with the name of the instrumentation:
21
+
22
+ ```ruby
23
+ OpenTelemetry::SDK.configure do |c|
24
+ # Use only the ActiveStorage instrumentation
25
+ c.use 'OpenTelemetry::Instrumentation::ActiveStorage'
26
+ # Use the ActiveStorage instrumentation along with the rest of the Rails-related instrumentation
27
+ c.use 'OpenTelemetry::Instrumentation::Rails'
28
+ end
29
+ ```
30
+
31
+ Alternatively, you can also call `use_all` to install all the available instrumentation.
32
+
33
+ ```ruby
34
+ OpenTelemetry::SDK.configure do |c|
35
+ c.use_all
36
+ end
37
+ ```
38
+
39
+ ## Active Support Instrumentation
40
+
41
+ This instrumentation relies entirely on `ActiveSupport::Notifications` and registers a custom Subscriber that listens to relevant events to report as spans.
42
+
43
+ See the table below for details of what [Rails Framework Hook Events](https://guides.rubyonrails.org/active_support_instrumentation.html#active-storage) are recorded by this instrumentation:
44
+
45
+ | Event Name | Creates Span? | Notes |
46
+ | - | - | - |
47
+ | `preview.active_storage` | :white_check_mark: | Creates an `internal` span |
48
+ | `transform.active_storage` | :white_check_mark: | Creates an `internal` span |
49
+ | `analyze.active_storage` | :white_check_mark: | Creates an `internal` span |
50
+ | `service_upload.active_storage` | :white_check_mark: | Creates an `internal` span |
51
+ | `service_streaming_download.active_storage` | :white_check_mark: | Creates an `internal` span |
52
+ | `service_download_chunk.active_storage` | :white_check_mark: | Creates an `internal` span |
53
+ | `service_download.active_storage` | :white_check_mark: | Creates an `internal` span |
54
+ | `service_delete.active_storage` | :white_check_mark: | Creates an `internal` span |
55
+ | `service_delete_prefixed.active_storage` | :white_check_mark: | Creates an `internal` span |
56
+ | `service_exist.active_storage` | :white_check_mark: | Creates an `internal` span |
57
+ | `service_url.active_storage` | :white_check_mark: | Creates an `internal` span |
58
+ | `service_update_metadata.active_storage` | :white_check_mark: | Creates an `internal` span |
59
+
60
+ ### Options
61
+
62
+ ActiveStorage instrumentation doesn't expose secure tokens and urls by default, but if they are needed, simply use `:key` and `:url` option:
63
+
64
+ ```ruby
65
+ OpenTelemetry::SDK.configure do |c|
66
+ c.use 'OpenTelemetry::Instrumentation::ActiveStorage', { key: :include, url: :include }
67
+ end
68
+ ```
69
+
70
+ ## Semantic Conventions
71
+
72
+ Internal spans are named using the name of the `ActiveSupport` event that was provided (e.g. `service_upload.active_storage`).
73
+
74
+ Attributes attached to each event payload are prefixed with `active_storage.` (e.g. `active_storage.checksum`).
75
+
76
+ ## Examples
77
+
78
+ Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_storage/example/trace_demonstration.rb)
79
+
80
+ ## How can I get involved?
81
+
82
+ The `opentelemetry-instrumentation-active_storage` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
83
+
84
+ The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] 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].
85
+
86
+ ## License
87
+
88
+ The `opentelemetry-instrumentation-active_storage` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
89
+
90
+ [rails-home]: https://github.com/rails/rails
91
+ [bundler-home]: https://bundler.io
92
+ [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
93
+ [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
94
+ [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
95
+ [community-meetings]: https://github.com/open-telemetry/community#community-meetings
96
+ [slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
97
+ [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
@@ -0,0 +1,130 @@
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 ActiveStorage
10
+ # The {OpenTelemetry::Instrumentation::ActiveStorage::Instrumentation} class contains logic to detect and install the ActiveStorage instrumentation
11
+ #
12
+ # Installation and configuration of this instrumentation is done within the
13
+ # {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry/SDK#configure-instance_method OpenTelemetry::SDK#configure}
14
+ # block, calling {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry%2FSDK%2FConfigurator:use use()}
15
+ # or {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry%2FSDK%2FConfigurator:use_all use_all()}.
16
+ #
17
+ # ## Configuration keys and options
18
+ #
19
+ # ### `:disallowed_notification_payload_keys`
20
+ #
21
+ # - `array` **default** `[]`
22
+ #
23
+ # Specifies an array of keys that should be excluded from the notification payload as span attributes.
24
+ #
25
+ # ### `:notification_payload_transform`
26
+ #
27
+ # - `proc` **default** `nil`
28
+ #
29
+ # Specifies custom proc used to extract span attributes form the notification payload.
30
+ # Use this to rename keys, extract nested values, or perform any other custom logic.
31
+ #
32
+ # ### `:key`
33
+ #
34
+ # - `symbol` **default** `:omit`
35
+ #
36
+ # Specifies whether to include secure token in the notification payload. Valid values are `:omit` and `:include`.
37
+ #
38
+ # ### `:url`
39
+ #
40
+ # - `symbol` **default** `:omit`
41
+ #
42
+ # Specifies whether to include url in the notification payload. Valid values are `:omit` and `:include`.
43
+ #
44
+ # @example An explicit default configuration
45
+ # OpenTelemetry::SDK.configure do |c|
46
+ # c.use_all({
47
+ # 'OpenTelemetry::Instrumentation::ActionMailer' => {
48
+ # disallowed_notification_payload_keys: [],
49
+ # notification_payload_transform: nil,
50
+ # key: :omit,
51
+ # url: :omit,
52
+ # },
53
+ # })
54
+ # end
55
+ class Instrumentation < OpenTelemetry::Instrumentation::Base
56
+ MINIMUM_VERSION = Gem::Version.new('7.0.0')
57
+
58
+ install do |_config|
59
+ resolve_key
60
+ resolve_url
61
+ resolve_payload_transform
62
+ require_dependencies
63
+ end
64
+
65
+ present do
66
+ defined?(::ActiveStorage)
67
+ end
68
+
69
+ compatible do
70
+ gem_version >= MINIMUM_VERSION
71
+ end
72
+
73
+ option :disallowed_notification_payload_keys, default: [], validate: :array
74
+ option :notification_payload_transform, default: nil, validate: :callable
75
+ option :key, default: :omit, validate: %I[omit include]
76
+ option :url, default: :omit, validate: %I[omit include]
77
+
78
+ private
79
+
80
+ def gem_version
81
+ ::ActiveStorage.version
82
+ end
83
+
84
+ def resolve_key
85
+ return unless _config[:key] == :omit
86
+
87
+ _config[:disallowed_notification_payload_keys].append 'active_storage.key'
88
+ end
89
+
90
+ def resolve_url
91
+ return unless _config[:url] == :omit
92
+
93
+ _config[:disallowed_notification_payload_keys].append 'active_storage.url'
94
+ end
95
+
96
+ def resolve_payload_transform
97
+ if _config[:notification_payload_transform].nil?
98
+ transform_attributes = ->(payload) { transform_payload(payload) }
99
+ else
100
+ original_callable = _config[:notification_payload_transform]
101
+ transform_attributes = lambda do |payload|
102
+ new_payload = transform_payload(payload)
103
+ user_payload = original_callable.call(new_payload)
104
+ if user_payload.instance_of?(Hash)
105
+ user_payload
106
+ else
107
+ OpenTelemetry.logger.error("ActiveStorage: transformed payload is #{user_payload.class} (require Hash)")
108
+ new_payload
109
+ end
110
+ end
111
+ end
112
+ _config[:notification_payload_transform] = transform_attributes
113
+ end
114
+
115
+ def _config
116
+ ActiveStorage::Instrumentation.instance.config
117
+ end
118
+
119
+ # add `active_storage.` prefix to each attribute
120
+ def transform_payload(payload)
121
+ payload.transform_keys { |k| "active_storage.#{k}" }
122
+ end
123
+
124
+ def require_dependencies
125
+ require_relative 'railtie'
126
+ end
127
+ end
128
+ end
129
+ end
130
+ end
@@ -0,0 +1,57 @@
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 ActiveStorage
10
+ SUBSCRIPTIONS = %w[
11
+ preview.active_storage
12
+ transform.active_storage
13
+ analyze.active_storage
14
+ service_upload.active_storage
15
+ service_streaming_download.active_storage
16
+ service_download_chunk.active_storage
17
+ service_download.active_storage
18
+ service_delete.active_storage
19
+ service_delete_prefixed.active_storage
20
+ service_exist.active_storage
21
+ service_url.active_storage
22
+ service_update_metadata.active_storage
23
+ ].freeze
24
+
25
+ # This Railtie sets up subscriptions to relevant ActiveStorage notifications
26
+ class Railtie < ::Rails::Railtie
27
+ config.after_initialize do
28
+ ::OpenTelemetry::Instrumentation::ActiveSupport::Instrumentation.instance.install({})
29
+ subscribe
30
+ end
31
+
32
+ class << self
33
+ def subscribe
34
+ SUBSCRIPTIONS.each do |subscription_name|
35
+ ::OpenTelemetry::Instrumentation::ActiveSupport.subscribe(
36
+ ActiveStorage::Instrumentation.instance.tracer,
37
+ subscription_name,
38
+ config[:notification_payload_transform],
39
+ config[:disallowed_notification_payload_keys]
40
+ )
41
+ end
42
+ end
43
+
44
+ def unsubscribe
45
+ SUBSCRIPTIONS.each do |subscription_name|
46
+ ::ActiveSupport::Notifications.unsubscribe(subscription_name)
47
+ end
48
+ end
49
+
50
+ def config
51
+ ActiveStorage::Instrumentation.instance.config
52
+ end
53
+ end
54
+ end
55
+ end
56
+ end
57
+ 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 ActiveStorage
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 ActiveStorage gem
13
+ module ActiveStorage
14
+ end
15
+ end
16
+ end
17
+
18
+ require_relative 'active_storage/instrumentation'
19
+ require_relative 'active_storage/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/active_storage'
@@ -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,253 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: opentelemetry-instrumentation-active_storage
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: 2025-01-29 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.4.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.4.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: opentelemetry-instrumentation-active_support
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '0.7'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0.7'
41
+ - !ruby/object:Gem::Dependency
42
+ name: opentelemetry-instrumentation-base
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 0.23.0
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 0.23.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.5'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '2.5'
69
+ - !ruby/object:Gem::Dependency
70
+ name: bundler
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '2.4'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '2.4'
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.1'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '1.1'
111
+ - !ruby/object:Gem::Dependency
112
+ name: opentelemetry-test-helpers
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '0.3'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '0.3'
125
+ - !ruby/object:Gem::Dependency
126
+ name: rake
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '13.0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '13.0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rubocop
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: 1.70.0
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: 1.70.0
153
+ - !ruby/object:Gem::Dependency
154
+ name: rubocop-performance
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: 1.23.0
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: 1.23.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: webmock
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - "~>"
186
+ - !ruby/object:Gem::Version
187
+ version: 3.24.0
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - "~>"
193
+ - !ruby/object:Gem::Version
194
+ version: 3.24.0
195
+ - !ruby/object:Gem::Dependency
196
+ name: yard
197
+ requirement: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - "~>"
200
+ - !ruby/object:Gem::Version
201
+ version: '0.9'
202
+ type: :development
203
+ prerelease: false
204
+ version_requirements: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - "~>"
207
+ - !ruby/object:Gem::Version
208
+ version: '0.9'
209
+ description: ActiveStorage 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-active_storage.rb
221
+ - lib/opentelemetry/instrumentation.rb
222
+ - lib/opentelemetry/instrumentation/active_storage.rb
223
+ - lib/opentelemetry/instrumentation/active_storage/instrumentation.rb
224
+ - lib/opentelemetry/instrumentation/active_storage/railtie.rb
225
+ - lib/opentelemetry/instrumentation/active_storage/version.rb
226
+ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
227
+ licenses:
228
+ - Apache-2.0
229
+ metadata:
230
+ changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_storage/0.1.0/file/CHANGELOG.md
231
+ source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/active_storage
232
+ bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
233
+ documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_storage/0.1.0
234
+ post_install_message:
235
+ rdoc_options: []
236
+ require_paths:
237
+ - lib
238
+ required_ruby_version: !ruby/object:Gem::Requirement
239
+ requirements:
240
+ - - ">="
241
+ - !ruby/object:Gem::Version
242
+ version: '3.0'
243
+ required_rubygems_version: !ruby/object:Gem::Requirement
244
+ requirements:
245
+ - - ">="
246
+ - !ruby/object:Gem::Version
247
+ version: '0'
248
+ requirements: []
249
+ rubygems_version: 3.3.27
250
+ signing_key:
251
+ specification_version: 4
252
+ summary: ActiveStorage instrumentation for the OpenTelemetry framework
253
+ test_files: []