signalfx-tracing 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a420459939e98542547b4e5e7e6c767b004cb711
-  data.tar.gz: f688a0ec1e90979c4abdd6b3384d75f6d4146bb5
+  metadata.gz: 1c6ff836a9a573045e3aac0ea378a834f286b98f
+  data.tar.gz: 6f195c1c6bfc7bb9ae83b7c554af22b2451e7532
 SHA512:
-  metadata.gz: 191c96d35b8e2ff7eb6b77f734be4a1ebf30a7f6f3daf0e95f7e4e87f3499f56498d63e13e27093c2cb88b4a7e769e9df62709e1f63012329ae53add06ae9dcb
-  data.tar.gz: bcff8a6b2a0b9742b104299dfe22e331c32a3f5b38bf68912e6df0239f4277e6264d164cf4331fee241d12284c8c01a3755257b84d4093a5ae853472fd82c393
+  metadata.gz: e7c2c8fe68cc903d5a3d378d30810fcb14ed1eed352261d80081f07c1534609cdf789698cfff2b78b5fd34699aaaaa8c2ea18681a85915a3dc44083a4153fba6
+  data.tar.gz: 6e3fa6cdbbf10bc991a7b3b7039536c6af3681806e5ae6172c9afa2b0359515e58f7deb4c45930f9b6188df6b0224486d2aca18537ca3ea6445e9f12eb07c57f

data/README.md

@@ -1,5 +1,19 @@
 # Ruby auto-instrumenter
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'signalfx-tracing'
+```
+
+and then execute:
+
+```bash
+$ bundle install
+```
+
 ## Usage
 
 Configure the instrumentation anywhere in the setup portion of your code or before doing anything
@@ -75,8 +89,8 @@ This section contains details and configuration for specific frameworks.
 | Mongo         | >= 2.1             |
 | Mysql2        | >= 0.5.0           |
 | Net::HTTP     | Ruby > 2.0         |
-| Rack          |                    |
-| Rails         |                    |
+| Rack          | >= 2.0             |
+| Rails         | >= 4.2.0           |
 | REST Client   | >= 2.0.0           |
 | Sinatra       | >= 1.1.4           |
 
@@ -151,7 +165,7 @@ conn = Faraday.new(url: 'http://localhost:3000/') do |faraday|
 end
 ```
 
-For more detailed usage, please check the instrumenation's page.
+For more detailed usage, please check the instrumentation's page.
 
 ## Mysql2
 
@@ -232,10 +246,16 @@ The source for this instrumentation is located [here](https://github.com/signalf
 
 ```ruby
 SignalFx::Tracing::Instrumenter.configure do |p|
-    p.instrument(:RestClient)
+    p.instrument(:RestClient, tracer: tracer, propagate: true)
 end
 ```
 
+Arguments:
+- `tracer`: Optional custom tracer to use for this instrumentation
+  - Default: `OpenTracing.global_tracer`
+- `propagate`: Propagate spans to the request endpoint.
+  - Default: `false`
+
 ## Sinatra
 
 Sinatra instrumentation traces requests and template rendering. The instrumenter

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

@@ -8,10 +8,11 @@ module SignalFx
         class << self
 
           def instrument(opts = {})
-            require 'net/http/tracer'
+            require 'net/http/instrumentation'
 
+            tracer = opts.fetch(:tracer, OpenTracing.global_tracer)
             ignore_request = lambda { Thread.current.thread_variable_get(:http_sender_thread) }
-            ::Net::Http::Tracer.instrument(ignore_request: ignore_request)
+            ::Net::Http::Instrumentation.instrument(tracer: tracer, ignore_request: ignore_request)
           end
         end
       end

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

@@ -16,7 +16,9 @@ module SignalFx
 
             require 'restclient/instrumentation'
             
-            ::RestClient::Instrumentation.instrument
+            tracer = opts.fetch(:tracer, OpenTracing.global_tracer)
+            propagate = opts.fetch(:propagate, false)
+            ::RestClient::Instrumentation.instrument(tracer: tracer, propagate: propagate)
           end
         end
       end

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

@@ -14,7 +14,7 @@ module SignalFx
               return
             end
 
-            require 'sinatra/tracer'
+            require 'sinatra/instrumentation'
           end
         end
       end

data/lib/signalfx/tracing/version.rb

@@ -1,5 +1,5 @@
 module Signalfx
   module Tracing
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/signalfx/tracing.rb

@@ -1,4 +1,6 @@
 require 'jaeger/client'
+require 'jaeger/client/injectors'
+require 'jaeger/client/extractors'
 require 'signalfx/tracing/http_sender'
 require 'signalfx/tracing/register'
 require 'thread'
@@ -48,7 +50,18 @@ module SignalFx
 
             http_sender = SignalFx::Tracing::HttpSenderWithFlag.new(url: @ingest_url, headers: headers, encoder: encoder)
 
-            @tracer = Jaeger::Client.build(service_name: service_name, sender: http_sender, flush_interval: 1)
+            injectors = {
+              OpenTracing::FORMAT_RACK => [Jaeger::Client::Injectors::B3RackCodec]
+            }
+            extractors = {
+              OpenTracing::FORMAT_RACK => [Jaeger::Client::Extractors::B3RackCodec]
+            }
+
+            @tracer = Jaeger::Client.build(service_name: service_name,
+                                           sender: http_sender,
+                                           injectors: injectors,
+                                           extractors: extractors,
+                                           flush_interval: 1)
             OpenTracing.global_tracer = @tracer
           else
             @tracer = tracer
@@ -56,5 +69,8 @@ module SignalFx
         end
       end
     end
+
+    # auto-configure if the correct env var is set
+    Instrumenter.configure(auto_instrument: true) if ENV['SIGNALFX_AUTO_INSTRUMENT'] == 'true'
   end
 end

data/signalfx-tracing.gemspec

@@ -36,7 +36,8 @@ Gem::Specification.new do |spec|
 
   # TODO pin versions once consistent across all dependencies
   spec.add_dependency "opentracing", "> 0.3.0"
-  spec.add_dependency "jaeger-client", "~> 0.6.1"
+  # spec.add_dependency "jaeger-client", "~> 0.6.1"
+  spec.add_dependency "jaeger-client", "~> 0.7.0"
 
   spec.add_dependency "sinatra-instrumentation", "~> 0.1"
   spec.add_dependency "nethttp-instrumentation", "~> 0.1"
@@ -45,8 +46,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mysql2-instrumentation", "~> 0.1"
 
   # forks
-  spec.add_dependency "signalfx-rails-instrumentation", "~> 0.1.0"
-  spec.add_dependency "signalfx-elasticsearch-instrumentation", "~> 0.1.0"
+  spec.add_dependency "signalfx-rails-instrumentation", "~> 0.1"
+  spec.add_dependency "signalfx-elasticsearch-instrumentation", "~> 0.1"
 
   # external
   spec.add_dependency "faraday-tracer", "~> 0.7.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signalfx-tracing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ashwin Chandrasekar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-14 00:00:00.000000000 Z
+date: 2018-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: sinatra-instrumentation
   requirement: !ruby/object:Gem::Requirement
@@ -142,28 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: signalfx-elasticsearch-instrumentation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: faraday-tracer
   requirement: !ruby/object:Gem::Requirement