rails-instrumentation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f16a0197a70766717864896e3d9124ac48883ecf01d6e3c748a3ac0ebe7d0cb7
+  data.tar.gz: 9ca9ebbc6a9250bdffe7b3d5007720c2b7f5c1d21e52f2f40435d83963c50257
+SHA512:
+  metadata.gz: 21a28e7f1141283809344b4ea7fccc32bf04ecd0a8a44e8c58d153346278c1f8e17db608636616bbd88baef54a2c1454bb26f63d7b58ea11331ed81f8701ae8c
+  data.tar.gz: e5183229a9d28d1577d3a33833adb400d9e21aeeebba0d7777b2a32a5ca01f0ae427e2cffff39e95e835a84335672644ae58d6e7590c400ed1c550d072643722

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,42 @@
+
+AllCops:
+    Exclude:
+        - 'test/**/*'
+        - 'gemfiles/**/*'
+        - 'bin/**/*'
+
+Style/Documentation:
+    Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+    Enabled: false
+
+Metrics/MethodLength:
+    Enabled: false
+
+Metrics/BlockLength:
+    Enabled: false
+
+Metrics/AbcSize:
+    Enabled: false
+
+RSpec/MultipleExpectations:
+    Enabled: false
+
+RSpec/ExampleLength:
+    Enabled: false
+
+RSpec/FilePath:
+    Enabled: false
+
+RSpec/VerifiedDoubles:
+    Enabled: false
+
+Metrics/ModuleLength:
+    Enabled: false
+
+Metrics/LineLength:
+    Max: 100
+    Exclude:
+        - 'spec/**/*'
+

data/Appraisals

@@ -0,0 +1,19 @@
+appraise 'rails-latest' do
+  gem 'rails'
+end
+
+appraise 'rails-5.2' do
+  gem 'rails', '~> 5.2.0'
+end
+
+appraise 'rails-5.1' do
+  gem 'rails', '~> 5.1.0'
+end
+
+appraise 'rails-5.0' do
+  gem 'rails', '~> 5.0.0'
+end
+
+appraise 'rails-4.2' do
+  gem 'rails', '~> 4.2.0'
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails-instrumentation.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 SignalFx
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,152 @@
+# Rails::Instrumentation
+
+OpenTracing instrumentation for Rails using ActiveSupport notifications. All events
+currently instrumented by ActiveSupport are available to trace.
+
+## Supported versions
+
+- Rails 5.2.x, 5.1.x, 5.0.x, 4.2.x
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-instrumentation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-instrumentation
+
+## Usage
+
+```ruby
+require 'rails/instrumentation'
+
+tracer_impl = SomeTracerImplementation.new
+
+Rails::Instrumentation.instrument(tracer: tracer,
+                                  exclude_events: [])
+```
+
+`instrument` takes these optional named arguments:
+- `tracer`: OpenTracing tracer to be used for this instrumentation
+    - Default: `OpenTracing.global_tracer`
+- `exclude_events`: Some events may be too noisy or they may simply not be
+  necessary. These can be passed in as an array, and the instrumentation will
+  not subscribe to those events. The available events can be found in the [Instrumented Events](#instrumented-events) section.
+    - Default: `[]`
+    - Example: `['sql.active_record', 'read_fragment.action_controller']`
+
+All instrumentation can be removed:
+
+```ruby
+Rails::Instrumentation.uninstrument
+```
+
+This will clear all subscribers registered by this instrumentation.
+
+## Instrumented Events
+
+Events that have additional useful information in the payload will have additional
+tags on their span, as listed below.
+
+For more information about each event, please look at the ActiveSupport
+notifications [documentation](https://guides.rubyonrails.org/active_support_instrumentation.html).
+
+### Action Controller
+
+| Event                                    | Span Tag Names                                                                                                                                                 |
+| ---                                      | ---                                                                                                                                                            |
+| write_fragment.action_controller         | key.write                                                                                                                                                      |
+| read_fragment.action_controller          | key.read                                                                                                                                                       |
+| expire_fragment.action_controller        | key.expire                                                                                                                                                     |
+| exist_fragment?.action_controller        | key.exist                                                                                                                                                      |
+| write_page.action_controller             | path.write                                                                                                                                                     |
+| expire_page.action_controller            | path.expire                                                                                                                                                    |
+| start_processing.action_controller       | controller<br> controller.action<br> request.params<br> request.format<br> http.method<br> http.url                                                            |
+| process_action.action_controller         | controller<br> controller.action<br> request.params<br> request.format<br> http.method<br> http.url<br> http.status_code<br> view.runtime_ms<br> db.runtime_ms |
+| send_file.action_controller              | path.send                                                                                                                                                      |
+| send_data.action_controller              |                                                                                                                                                                |
+| redirect_to.action_controller            | http.status_code<br> redirect.url                                                                                                                              |
+| halted_callback.action_controller        | filter                                                                                                                                                         |
+| unpermitted_parameters.action_controller | unpermitted_keys                                                                                                                                               |
+### Action View
+
+| Event                         | Span Tag Names                                                 |
+| ---                           | ---                                                            |
+| render_tempate.action_view    | template.identifier<br> template.layout                        |
+| render_partial.action_view    | partial.identifier                                             |
+| render_collection.action_view | template.identifier<br> template.count<br> template.cache_hits |
+
+### Active Record
+
+| Event                       | Span Tag Names                                               |
+| ---                         | ---                                                          |
+| sql.active_record           | db.statement<br> name<br> connection_id<br> binds<br> cached |
+| instantiation.active_record | record.count<br> record.class                                |
+
+### Action Mailer
+
+| Event                 | Span Tag Names                                                                                                                             |
+| ---                   | ---                                                                                                                                        |
+| receive.action_mailer | mailer<br> message.id<br> message.subject<br> message.to<br> message.from<br> message.bcc<br> message.cc<br> message.date<br> message.body |
+| deliver.action_mailer | mailer<br> message.id<br> message.subject<br> message.to<br> message.from<br> message.bcc<br> message.cc<br> message.date<br> message.body |
+| process.action_mailer | mailer<br> action<br> args                                                                                                                 |
+
+### Active Support
+
+| Event                          | Span Tag Names                  |
+| ---                            | ---                             |
+| cache_read.active_support      | key<br> hit<br> super_operation |
+| cache_generate.active_support  | key                             |
+| cache_fetch_hit.active_support | key                             |
+| cache_write.active_support     | key                             |
+| cache_delete.active_support    | key                             |
+| cache_exist?.active_support    | key                             |
+
+### Active Job
+
+| Event                    | Span Tag Names  |
+| ---                      | ---             |
+| enqueue_at.active_job    | adapter<br> job |
+| enqueue.active_job       | adapter<br> job |
+| perform_start.active_job | adapter<br> job |
+| perform.active_job       | adapter<br> job |
+
+### Action Cable
+
+| Event                                           | Span Tag Names                     |
+| ---                                             | ---                                |
+| perform_action.action_cable                     | channel_class<br> action<br> data  |
+| transmit.action_cable                           | channel_class<br> data<br> via     |
+| transmit_subscription_confirmation.action_cable | channel_class                      |
+| transmit_subscription_rejection.action_cable    | channel_class                      |
+| broadcast.action_cable                          | broadcasting<br> message<br> coder |
+
+### Active Storage
+
+| Event                                     | Span Tag Names               |
+| ---                                       | ---                          |
+| service_upload.active_storage             | key<br> service<br> checksum |
+| service_streaming_download.active_storage | key<br> service              |
+| service_download.active_storage           | key<br> service              |
+| service_delete.active_storage             | key<br> service              |
+| service_delete_prefixed.active_storage    | key.prefix<br> service       |
+| service_exist.active_storage              | key<br> service<br> exist    |
+| service_url.active_storage                | key<br> service<br> url      |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/signalfx/ruby-rails-instrumentation.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec'
+end
+
+task default: :spec