signalfx-rails-instrumentation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e565a70df20743b39f645bd25ce64cf05bfe406b
+  data.tar.gz: f967090b54195ba8f332f569e5a7ad4216a504e0
+SHA512:
+  metadata.gz: 79fcf9f87ea5e8364b6ff967ed19b2925000c8f12ca56ee2248aaa5266639dbbd9835520c47d43a9c07c47c93d7f9b6e1b8c3c54c5c8a2d580ce5d072684decf
+  data.tar.gz: fba383d8a340228ff5b55e2eebbb26794938737a7505bb076491f7e677d2a223dd275843348e550a1a7bda9a23610c1faeff70cf8394b4b31f6a403b43052a9d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Appraisal
+*.gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -0,0 +1,25 @@
+sudo: true
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+gemfile:
+  - gemfiles/rails_32.gemfile
+  - gemfiles/rails_40.gemfile
+  - gemfiles/rails_41.gemfile
+  - gemfiles/rails_42.gemfile
+  - gemfiles/rails_50.gemfile
+  - gemfiles/rails_51.gemfile
+matrix:
+  exclude:
+    - rvm: 2.4
+      gemfile: gemfiles/rails_32.gemfile
+    - rvm: 2.4
+      gemfile: gemfiles/rails_40.gemfile
+    - rvm: 2.4
+      gemfile: gemfiles/rails_41.gemfile
+before_install: 
+  - gem install bundler -v 1.15.3
+services:
+  - memcached

data/Appraisals

@@ -0,0 +1,24 @@
+appraise "rails-32" do
+  gem "rails", "~> 3.2.0"
+  gem 'test-unit', '~> 3.0'
+end
+
+appraise "rails-40" do
+  gem "rails", "~> 4.0.0"
+end
+
+appraise "rails-41" do
+  gem "rails", "~> 4.1.0"
+end
+
+appraise "rails-42" do
+  gem "rails", "~> 4.2.0"
+end
+
+appraise "rails-50" do
+  gem "rails", "~> 5.0.0"
+end
+
+appraise "rails-51" do
+  gem "rails", "~> 5.1.0"
+end

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+## v0.5.0
+
+* Expose global Rails::Tracer which instruments all sub-modules [#26](https://github.com/iaintshine/ruby-rails-tracer/pull/26)
+* Allow to disable sub-tracers [#25](https://github.com/iaintshine/ruby-rails-tracer/pull/25)
+* Support Evented and Timed subscribers in cache instrumentation [#24](https://github.com/iaintshine/ruby-rails-tracer/pull/24)
+* Test and add support for multiple Rails versions - 3.2+ [#23](https://github.com/iaintshine/ruby-rails-tracer/pull/23)
+* Development instructions update [#27](https://github.com/iaintshine/ruby-rails-tracer/pull/27)
+
+## v0.4.3
+
+* Handle instrumentation exceptions and mark spans as failed [#21](https://github.com/iaintshine/ruby-rails-tracer/pull/21)
+
+## v0.4.2
+
+* Test the gem with multiple Ruby versions 2.2+ [#20](https://github.com/iaintshine/ruby-rails-tracer/pull/20)
+* Set explicit Ruby version requirement in gemspec.
+
+## v0.4.1
+
+* Use tracing matchers in tests [#19](https://github.com/iaintshine/ruby-rails-tracer/pull/19)
+
+## v0.4.0
+
+* Start maintaining CHANGELOG.md [#18](https://github.com/iaintshine/ruby-rails-tracer/pull/18)
+* Auto enable tracing-logger when Dalli is auto-instrumented [#17](https://github.com/iaintshine/ruby-rails-tracer/pull/17)
+* Introduce Dalli and ActiveSupport::Cache::DalliStore auto-instrumentation [#9](https://github.com/iaintshine/ruby-rails-tracer/pull/9)
+* Introduce docker-compose with all required external dependencies. 
+
+## v0.3.0
+
+* Introduce ActiveSupport::Cache auto-instrumentation [#4](https://github.com/iaintshine/ruby-rails-tracer/pull/4)
+* Add ActiveRecord::Tracer tests for active span propagation
+
+## v0.2.0
+
+* Introduce ActiveRecord auto-instrumentation [#3](https://github.com/iaintshine/ruby-rails-tracer/pull/3)
+* Add Rails test application to be used in specs
+
+## v0.1.1
+
+* Replace RecordingTracer with Test::Tracer [#6](https://github.com/iaintshine/ruby-rails-tracer/pull/6)
+* README typo fix [#2](https://github.com/iaintshine/ruby-rails-tracer/pull/2) 
+
+## v0.1.0
+
+* Initial release
+* Introduced a rack middleware, to generate more informative operation names based on information supplied by ActionDispatch. [#1](https://github.com/iaintshine/ruby-rails-tracer/pull/1)

data/Gemfile

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

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 {yyyy} {name of copyright owner}
+
+   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,198 @@
+# OpenTracing Rails Instrumentation
+
+This gem is an attempt to introduce OpenTracing instrumentation into Rails. It's in an early stage. 
+
+The following instrumentation is supported:
+
+* ActionDispatch - The library introduces a rack middleware, which is intended to be used together with `rack-tracer`, to generate more informative operation names based on information supplied by ActionDispatch.
+* ActiveRecord - The library hooks up into Rails, and instruments all ActiveRecord query. 
+* ActionSupport::Cache - The library hooks up into Rails, and instruments cache events.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-tracer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-tracer
+
+## Rails::Tracer
+
+The library hooks up into Rails using `ActiveSupport::Notifications`, and instruments all previously mentioned modules. 
+To enable instrumentation, you can either use sub-tracers directly (see sections below) or global `Rails::Tracer` which 
+will enabled all of them (except for Rack/ActionDispatch instrumentation).
+
+### Configuration Options
+
+* `tracer: OpenTracing::Tracer` an OT compatible tracer. Default `OpenTracing.global_tracer`
+* `active_span: boolean` an active span provider. Default: `nil`.
+* `active_record: boolean` whether to enable `ActiveRecord` instrumentation. Default: `true`.
+* `active_support_cache: boolean` whether to enable `ActionDispatch::Cache` instrumentation. Default: `true`.
+  * `dalli: boolean` if set to `true` you will hook up into `Dalli` low-level details. Default: `false`.
+* `rack: boolean` whether to enable extended `Rack` instrumentation. Default: `false`.
+  * `middlewares: ActionDispatch::MiddlewareStack` a middlewares stack. Default: `Rails.configuration.middleware`.
+* `action_controller: boolean` whether to enable `ActionController` instrumentation. Default: `true`.
+* `full_trace: boolean` whether to gather all traces for a request and attempt to build a parent span for the current request. Default: `false`.
+
+### Usage
+
+```ruby
+require 'rails/tracer'
+
+Rails::Tracer.instrument
+```
+
+## ActionDispatch 
+
+When you use `rack-tracer`, the generated operation name corresponds to the request's http method e.g. GET, POST etc.
+It's not perfect. You need to dig into the trace to understand with what url it's related. 
+
+The `rails-tracer` introduces another rack middleware, which is intended to be used together with `rack-tracer`, to generate more informative operation names in the form `ControllerName#action`.
+
+### Usage
+
+```ruby
+require 'rack/tracer'
+require 'rails/tracer'
+
+Rails.configuration.middleware.use(Rack::Tracer)
+Rails.configuration.middleware.insert_after(Rack::Tracer, Rails::Rack::Tracer)
+```
+
+or simpler
+
+```ruby
+Rails::Rack::Tracer.instrument
+```
+
+optionally you can pass `tracer` argument to `instrument` method.
+
+## ActiveRecord
+
+The library hooks up into Rails using `ActiveSupport::Notifications`, and instruments all `ActiveRecord` query. 
+
+### Usage
+
+Auto-instrumentation example. 
+
+```ruby
+require 'rails/tracer'
+
+ActiveRecord::Tracer.instrument(tracer: OpenTracing.global_tracer,
+                               active_span: -> { OpenTracing.global_tracer.active_span })
+```
+
+There are times when you might want to skip ActiveRecord's magic, and use connection directly. Still the library 
+can help you with span creation. Instead of auto-instrumenting you can manually call `ActiveRecord::Tracer.start_span` as shown below.
+
+```ruby
+def q(name, sql)
+  span = ActiveRecord::Tracer.start_span(name, 
+                                          tracer: OpenTracing.global_tracer,
+                                          active_span: -> { OpenTracing.global_tracer.active_span },
+                                          sql: sql)
+  ActiveRecord::Base.
+    connection.
+    raw_connection.
+    query(sql).
+    each(as: :hash)
+ensure
+  span&.finish
+end
+
+q("FirstUser", "SELECT * FROM users LIMIT 1")
+```
+
+## ActiveSupport::Cache
+
+The library hooks up into Rails using `ActiveSupport::Notifications`, and instruments all `ActiveSupport::Cache` events. 
+
+### Usage
+
+Auto-instrumentation example. 
+
+```ruby
+require 'rails/tracer'
+
+ActiveSupport::Cache::Tracer.instrument(tracer: OpenTracing.global_tracer, 
+                                        active_span: -> { OpenTracing.global_tracer.active_span })
+```
+
+If you use [Dalli](https://github.com/petergoldstein/dalli/) and `ActiveSupport::Cache::DalliStore` as your application's cache store, you can get low-level details about Memcached calls by setting `dalli` option to `true`. If you want to get even more details, simply require [tracing-logger](https://github.com/iaintshine/ruby-tracing-logger) and Dalli error logs will be attached to the current active span. The library will wrap current `Dalli.logger` into a `Tracing::CompositeLogger` and append additional `Tracing::Logger` with severity level set to `Logger::ERROR`.
+
+```ruby
+ActiveSupport::Cache::Tracer.instrument(tracer: OpenTracing.global_tracer, 
+                                        active_span: -> { OpenTracing.global_tracer.active_span },
+                                        dalli: true)
+```
+
+If you want to skip the auto-instrumentation, still the library can help you with span creation and setting up proper tags. Instead of auto-instrumenting, as shown above, you can manually call `ActiveSupport::Cache::Tracer.start_span` as shown below.
+
+```ruby
+def read(key)
+  span = ActiveSupport::Cache::Tracer.start_span("InMemoryCache#read", 
+                                                 tracer: OpenTracing.global_tracer,
+                                                 active_span: -> { OpenTracing.global_tracer.active_span },
+                                                 key: key)
+  result = in_memory_cache[key]
+  span.set_tag('cache.hit', !!result) 
+  result
+ensure
+  span&.finish
+end
+
+read("user-1")
+```
+
+## ActionController
+
+This instruments `start_processing` and `process_action` events using `ActiveSupport::Notifications` to get important information about a request once it has finished.
+
+### Usage
+
+Auto-instrumentation example.
+
+```ruby
+require 'rails/tracer'
+
+ActionController::Tracer.instrument(tracer: OpenTracing.global_tracer,
+                                    active_span: -> { OpenTracing.global_tracer.active_span })
+```
+
+## Development
+
+After checking out the repo, install dependencies. 
+
+```
+bundle install
+appraisal install
+```
+
+The tests depends on having memcached running locally within docker container. It means you need to install docker, and docker-compose first.
+Once you're done to run the containers:
+
+```
+docker-compose up -d
+```
+
+Then, to run tests for all appraisals: 
+
+```
+appraisal bundle exec rspec spec
+```
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/iaintshine/ruby-rails-tracer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.