signalfx-tracing 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cba6686f3650fe7e78107b4361557d19f6c113027130637e6a0fa951ab9572d6
-  data.tar.gz: 0016fde2502c3f243c5c8041763883ec1563ee50de05f273f5084916d0b8257f
+  metadata.gz: 8cb7c6cd9186c6b200d8f49f568c408ad95ac990b178b463ee5eda7631d17cd3
+  data.tar.gz: d3356e20ea75c5914fa09a2da0d0f45890bd37be0dc2c2f43ed8bccfdd5673e8
 SHA512:
-  metadata.gz: fe820cfaebb70a14236557a2c0b3d56da086845b5bf32ad8fc423535d6abb3925b0777135ffffba44fc13d069c2540f8f0f42e2ad6c8c2b17d07b129bb4b22fa
-  data.tar.gz: d63db2fd564d7bda03cc6ac0a16b9dea32c75561d9a5c1facdbbeff99c246805dac1c77f65b82d440dd104584632038174d6976733e8ab5030b6af82cb1fb85e
+  metadata.gz: 9efc8169781a8a48507606d8af68cf04f138863b3ebe26690bcead5dd2b26b4936a83e23890d8c0826f4a63351e52e136163ea9edcb731a9059c858985307d22
+  data.tar.gz: 3028ae140b2ed3e2b0aae422c2385c7f83d3ef7befc25adf497dbe9c9e8521a20cabc17ea1fcd7109cd0bb6aee1fbb3e2762cc70e23c82c06f02acd99c7a003a

data/README.md

@@ -90,19 +90,21 @@ When interfacing with these web servers as a Rack application, please configure
 
 ### Libraries/Frameworks
 
-| Library       | Versions Supported |
-| ------------- | ------------------ |
-| ActiveRecord  | > 3.2              |
-| Elasticsearch | >= 5.x             |
-| Faraday       | > 0.9.2            |
-| Mongo         | >= 2.1             |
-| Mysql2        | >= 0.5.0           |
-| Net::HTTP     | Ruby > 2.0         |
-| Rack          | >= 2.0             |
-| Rails         | >= 4.2.0           |
-| Redis         | >= 4.0.1           |
-| REST Client   | >= 2.0.0           |
-| Sinatra       | >= 1.1.4           |
+| Library                             | Versions Supported |
+| ----------------------------------- | ------------------ |
+| [ActiveRecord](#active-record)      | > 3.2              |
+| [Elasticsearch](#elasticsearch)     | >= 5.x             |
+| [Faraday](#faraday)                 | > 0.9.2            |
+| [Grape](#grape)                     | > 1.0.0            |
+| [Mongo](#mongo)                     | >= 2.1             |
+| [Mysql2](#mysql2)                   | >= 0.5.0           |
+| [Net::HTTP](#nethttp)               | Ruby > 2.0         |
+| [Rack](#rack)                       | >= 2.0             |
+| [Rails](#rails)                     | >= 4.2.0           |
+| [Redis](#redis)                     | >= 4.0.1           |
+| [RestClient](#restclient)           | >= 2.0.0           |
+| [Sequel](#sequel)                   | >= 3.48.0          |
+| [Sinatra](#sinatra)                 | >= 1.1.4           |
 
 ## Active Record
 
@@ -177,6 +179,41 @@ end
 
 For more detailed usage, please check the instrumentation's page.
 
+## Grape
+
+This instrumentation subscribes to ActiveSupport notifications emitted by the
+Grape API. It patches `Grape::API` to automatically insert the `Rack::Tracer`
+middleware and trace requests.
+
+The source for this instrumentation is located [here](https://github.com/signalfx/ruby-grape-instrumentation)
+
+### Usage
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:Grape)
+end
+```
+
+`instrument` takes these optional arguments:
+- `tracer`: custom tracer to use. Defaults to `OpenTracing.global_tracer`
+- `parent_span`: parent span to group spans or block that returns a span. Default: `nil`
+- `disable_patching`: disable patching if managing the middleware stack manually. Default: `false`
+
+If patching is disabled, but spans nested by request are still desired, then the
+Rack middleware must be manually added to the API class.
+
+```ruby
+require 'rack/tracer'
+
+class MyAPI << Grape::API
+  insert 0, Rack::Tracer
+  ...
+end
+```
+
+Please see the instrumentation's page for more details.
+
 ## Mongo
 
 Mongo driver instrumentation traces queries performed through the Ruby Mongodb driver.
@@ -242,10 +279,9 @@ use Rack::Tracer
 ## Rails
 
 Rails applications can be traced using the notifications provided by ActiveSupport.
-It can use `rack-tracer` to trace by requests, or it'll try to group spans by
-request ID.
+It will use `rack-tracer` to trace by requests.
 
-The forked source for this instrumentation is located [here](https://github.com/signalfx/ruby-rails-tracer).
+The forked source for this instrumentation is located [here](https://github.com/signalfx/ruby-rails-instrumentation).
 
 ### Usage
 
@@ -259,10 +295,14 @@ Optionally, to disable Rack instrumentation, set the `rack_tracer` field to fals
 
 ```ruby
 SignalFx::Tracing::Instrumenter.configure do |p|
-    p.instrument(:Rails, rack_tracer: false)
+    p.instrument(:Rails, rack_tracer: false, exclude_events: [])
 end
 ```
 
+By default, all Rails ActiveSupport notifications are traced. However, if this
+is too noisy, events to ignore can be passed as an array as `exclude_events`.
+A full list of events can be seen on the instrumentation's Readme.
+
 Note that if `rack_tracer` is set to `false`, requests propagated to the Rails
 app will not be extracted. For example, if a traced service makes a request to
 an endpoint served by the Rails app, it will not be automatically nested.
@@ -306,6 +346,24 @@ Arguments:
 - `propagate`: Propagate spans to the request endpoint.
   - Default: `false`
 
+## Sequel
+
+Sequel instrumentation adds extensions to the Database and Dataset to trace queries.
+
+The source for this instrumentation is located [here](https://github.com/signalfx/ruby-sequel-instrumentation).
+
+### Usage
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:Sequel)
+end
+```
+
+Arguments:
+- `tracer`: Optional custom tracer for this instrumentation
+  - Default: `OpenTracing.global_tracer`
+
 ## Sinatra
 
 Sinatra instrumentation traces requests and template rendering. The instrumenter

data/lib/signalfx/tracing/instrumentation/grape.rb

@@ -0,0 +1,57 @@
+require 'opentracing'
+
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module Grape
+
+        Register.add_lib :Grape, self
+
+        class << self
+
+          def instrument(opts = {})
+            return if @instrumented
+
+            begin
+              require 'grape'
+            rescue LoadError => error
+              return
+            end
+
+            require 'grape/instrumentation'
+            
+            tracer = opts.fetch(:tracer, OpenTracing.global_tracer)
+            parent_span = opts.fetch(:parent_span, nil)
+
+            ::Grape::Instrumentation.instrument(tracer: tracer, parent_span: parent_span)
+            patch_middleware if !opts.fetch(:disable_patching, false)
+
+            @instrumented = true
+          end
+
+          def patch_middleware
+            require 'rack/tracer'
+
+            ::Grape::API.class_eval do
+              if Gem::Version.new(::Grape::VERSION) >= Gem::Version.new('1.2.0')
+                singleton_class.send(:alias_method, :initial_setup_original, :initial_setup)
+
+                def self.initial_setup(base_instance_parent)
+                  initial_setup_original(base_instance_parent)
+                  base_instance_parent.insert(0, ::Rack::Tracer) if !base_instance_parent.middleware.any? { |m| m[2].to_s == 'Rack::Tracer'}
+                end
+              else
+                singleton_class.send(:alias_method, :inherited_original, :initial_setup)
+
+                def self.inherited(api)
+                  inherited_original(api)
+                  api.use(::Rack::Tracer) if !api.middleware.any? { |m| m[1].to_s == 'Rack::Tracer' }
+                end
+              end
+            end # class_eval
+          end
+        end
+      end
+    end
+  end
+end

data/lib/signalfx/tracing/instrumentation/rails.rb

@@ -10,19 +10,26 @@ module SignalFx
           def instrument(opts = {})
             return if @instrumented
 
-            # instrument supported versions
-            return if !defined?(::Rails) or Gem::Version.new(::Rails::VERSION::STRING) < Gem::Version.new('3.2')
+            # check for required gems
+            begin
+              require 'active_support'
+              require 'rails'
+            rescue LoadError
+              return
+            end
 
-            require 'rails/tracer'
+            require 'rails/instrumentation'
             require 'rack/tracer'
 
-            if opts.fetch(:rack_tracer, false)
+            if opts.fetch(:rack_tracer, true)
               # add rack middlewares
-              ::Rails.configuration.middleware.use(::Rack::Tracer)
-              ::Rails.configuration.middleware.insert_after(::Rack::Tracer, ::Rails::Rack::Tracer)
+              ::Rails.configuration.middleware.insert(0, ::Rack::Tracer)
             end
 
-            ::Rails::Tracer.instrument(full_trace: true)
+            exclude_events = opts.fetch(:exclude_events, [])
+            tracer = opts.fetch(:tracer, OpenTracing.global_tracer)
+
+            ::Rails::Instrumentation.instrument(tracer: tracer, exclude_events: exclude_events)
 
             @instrumented = true
           end

data/lib/signalfx/tracing/instrumentation/sequel.rb

@@ -0,0 +1,28 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module Sequel
+
+        Register.add_lib :Sequel, self
+
+        class << self
+
+          def instrument(opts = {})
+            begin
+              require 'sequel'
+            rescue LoadError
+              return
+            end
+
+            require 'sequel/instrumentation'
+
+            tracer = opts.fetch(:tracer, OpenTracing.global_tracer)
+
+            ::Sequel::Instrumentation.instrument(tracer: tracer) if !@instrumented
+            @instrumented = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/signalfx/tracing/register.rb

@@ -40,3 +40,5 @@ require 'signalfx/tracing/instrumentation/mongodb'
 require 'signalfx/tracing/instrumentation/elasticsearch'
 require 'signalfx/tracing/instrumentation/mysql2'
 require 'signalfx/tracing/instrumentation/redis'
+require 'signalfx/tracing/instrumentation/sequel'
+require 'signalfx/tracing/instrumentation/grape'

data/lib/signalfx/tracing/version.rb

@@ -1,5 +1,5 @@
 module Signalfx
   module Tracing
-    VERSION = "0.1.7"
+    VERSION = "0.1.8"
   end
 end

data/signalfx-tracing.gemspec

@@ -44,9 +44,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mongodb-instrumentation", "~> 0.1.1"
   spec.add_dependency "mysql2-instrumentation", "~> 0.1.0"
   spec.add_dependency "redis-instrumentation", "~> 0.1.0"
+  spec.add_dependency "sequel-instrumentation", "~> 0.1.0"
+  spec.add_dependency "grape-instrumentation", "~> 0.1.0"
+  spec.add_dependency "rails-instrumentation", "~> 0.1.0"
 
   # forks
-  spec.add_dependency "signalfx-rails-instrumentation", "~> 0.1.4"
   spec.add_dependency "signalfx-elasticsearch-instrumentation", "~> 0.1.0"
   spec.add_dependency "signalfx-faraday-instrumentation", "~> 0.1.1"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signalfx-tracing
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Ashwin Chandrasekar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-24 00:00:00.000000000 Z
+date: 2019-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,19 +151,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: signalfx-rails-instrumentation
+  name: sequel-instrumentation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: grape-instrumentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rails-instrumentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: signalfx-elasticsearch-instrumentation
   requirement: !ruby/object:Gem::Requirement
@@ -240,6 +268,7 @@ files:
 - lib/signalfx/tracing/instrumentation/active_record.rb
 - lib/signalfx/tracing/instrumentation/elasticsearch.rb
 - lib/signalfx/tracing/instrumentation/faraday.rb
+- lib/signalfx/tracing/instrumentation/grape.rb
 - lib/signalfx/tracing/instrumentation/mongodb.rb
 - lib/signalfx/tracing/instrumentation/mysql2.rb
 - lib/signalfx/tracing/instrumentation/net_http.rb
@@ -248,6 +277,7 @@ files:
 - lib/signalfx/tracing/instrumentation/rails.rb
 - lib/signalfx/tracing/instrumentation/redis.rb
 - lib/signalfx/tracing/instrumentation/restclient.rb
+- lib/signalfx/tracing/instrumentation/sequel.rb
 - lib/signalfx/tracing/instrumentation/sinatra.rb
 - lib/signalfx/tracing/register.rb
 - lib/signalfx/tracing/reporter/auto_reviving_async_reporter.rb
@@ -273,8 +303,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Auto-instrumentation framework for Ruby