signalfx-tracing 1.1.0 → 1.2.0

data/README.md

@@ -140,6 +140,7 @@ When interfacing with these web servers as a Rack application, please configure
 | [Redis](#redis)                     | >= 4.0.0           |
 | [RestClient](#restclient)           | >= 1.5.0           |
 | [Sequel](#sequel)                   | >= 3.47.0          |
+| [Sidekiq](#sidekiq)                 | >= 0.7.0           |
 | [Sinatra](#sinatra)                 | >= 1.0.0           |
 
 ## Active Record
@@ -460,6 +461,35 @@ Arguments:
 - `tracer`: Optional custom tracer for this instrumentation
   - Default: `OpenTracing.global_tracer`
 
+## Sidekiq
+
+Sidekiq instrumentation traces worker job submissions and execution via [Sidekiq middleware](https://github.com/mperham/sidekiq/wiki/Middleware).
+The instrumenter registers both client and server middleware that use job metadata to
+represent all job submissions and their invocations.  Trace context propagation adds
+to this job metadata to unifiy distributed client and server requests and processing.
+
+The source for this instrumentation is located [here](https://github.com/signalfx/ruby-sidekiq-tracer).
+
+### Usage
+
+```bash
+$ # install the instrumentation if not done previously
+$ sfx-rb-trace-bootstrap -i sidekiq
+```
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:Sidekiq, propagate: false)
+end
+```
+
+Arguments:
+- `tracer`: Optional custom tracer for this instrumentation
+  - Default: `OpenTracing.global_tracer`
+- `propagate`: Optional boolean to enable/disable trace context injection via job metadata
+  - Default: `true`
+
+
 ## Sinatra
 
 Sinatra instrumentation traces requests and template rendering. The instrumenter

data/bin/sfx-rb-trace-bootstrap

@@ -16,6 +16,7 @@ instrumentations = {
   "redis" => ["redis-instrumentation", "~> 0.1.1"],
   "restclient" => ["restclient-instrumentation", "~> 0.1.1"],
   "sequel" => ["sequel-instrumentation", "~> 0.1.0"],
+  "sidekiq" => ["sfx-sidekiq-opentracing", "~> 0.0.3"],
   "sinatra" => ["sinatra-instrumentation", "~> 0.1.2"]
 }
 

data/gem.deps.rb

@@ -9,6 +9,7 @@ group :instrumentations do
   gem 'redis-instrumentation', '~> 0.1.1'
   gem 'restclient-instrumentation', '~> 0.1.1'
   gem 'sequel-instrumentation', '~> 0.1.0'
+  gem 'sfx-sidekiq-opentracing', '~> 0.0.3'
   gem 'signalfx-elasticsearch-instrumentation', '~> 0.1.0'
   gem 'signalfx-faraday-instrumentation', '~> 0.1.1'
   gem 'sinatra-instrumentation', '~> 0.1.2'

data/lib/signalfx/tracing.rb

@@ -21,7 +21,7 @@ module SignalFx
           @ingest_url = ingest_url
           @service_name = service_name
           @access_token = access_token
-          set_tracer(tracer: tracer, service_name: service_name, access_token: access_token)
+          set_tracer(tracer: tracer, service_name: service_name, access_token: access_token) if @tracer.nil?
 
           if auto_instrument
             Register.available_libs.each_pair do |key, value|
@@ -55,10 +55,12 @@ module SignalFx
             @reporter = Jaeger::Client::Reporters::RemoteReporter.new(sender: @http_sender, flush_interval: 1)
 
             injectors = {
-              OpenTracing::FORMAT_RACK => [Jaeger::Client::Injectors::B3RackCodec]
+              OpenTracing::FORMAT_RACK => [Jaeger::Client::Injectors::B3RackCodec],
+              OpenTracing::FORMAT_TEXT_MAP => [Jaeger::Client::Injectors::B3RackCodec]
             }
             extractors = {
-              OpenTracing::FORMAT_RACK => [Jaeger::Client::Extractors::B3RackCodec]
+              OpenTracing::FORMAT_RACK => [Jaeger::Client::Extractors::B3RackCodec],
+              OpenTracing::FORMAT_TEXT_MAP => [Jaeger::Client::Extractors::B3TextMapCodec]
             }
 
             @tracer = Jaeger::Client.build(

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

@@ -0,0 +1,35 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module Sidekiq
+
+        Register.add_lib :Sidekiq, self
+
+        class << self
+          def instrument(opts = {})
+            return if @instrumented
+            begin
+              require 'sidekiq'
+            rescue LoadError
+              return
+            end
+
+            begin
+              require 'sidekiq/tracer'
+            rescue LoadError => e
+              puts e.message
+              return
+            end
+
+            ::Sidekiq::Tracer.instrument(
+              tracer: opts.fetch(:tracer, OpenTracing.global_tracer),
+              opts: { propagate_context: opts.fetch(:propagate, true) }
+            )
+            @instrumented = true
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/signalfx/tracing/register.rb

@@ -42,3 +42,4 @@ require 'signalfx/tracing/instrumentation/mysql2'
 require 'signalfx/tracing/instrumentation/redis'
 require 'signalfx/tracing/instrumentation/sequel'
 require 'signalfx/tracing/instrumentation/grape'
+require 'signalfx/tracing/instrumentation/sidekiq'

data/lib/signalfx/tracing/version.rb

@@ -1,5 +1,5 @@
 module Signalfx
   module Tracing
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/signalfx-tracing.gemspec

@@ -25,7 +25,7 @@ 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.10.0"
+  spec.add_dependency "jaeger-client", "~> 1.0.0"
 
   # We are no longer setting all available instrumentations as dependencies.
   # Manual installation via bootstrapper or gem.deps.rb is now required.

metadata

@@ -1,83 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: signalfx-tracing
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
+  prerelease: 
 platform: ruby
 authors:
 - SignalFx, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2019-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: opentracing
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">"
+    - - '>'
       - !ruby/object:Gem::Version
         version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">"
+    - - '>'
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: jaeger-client
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: nethttp-instrumentation
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.2
 description: 
@@ -88,7 +99,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE
 - README.md
@@ -112,6 +123,7 @@ files:
 - lib/signalfx/tracing/instrumentation/redis.rb
 - lib/signalfx/tracing/instrumentation/restclient.rb
 - lib/signalfx/tracing/instrumentation/sequel.rb
+- lib/signalfx/tracing/instrumentation/sidekiq.rb
 - lib/signalfx/tracing/instrumentation/sinatra.rb
 - lib/signalfx/tracing/register.rb
 - lib/signalfx/tracing/reporter/auto_reviving_async_reporter.rb
@@ -121,25 +133,26 @@ files:
 homepage: https://github.com/signalfx/signalfx-ruby-tracing
 licenses:
 - Apache-2.0
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Auto-instrumentation framework for Ruby
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: ba2591d862b7c31748ce57e4011d1cf6e810811c
-  data.tar.gz: 5bd3c7c1d10012b3593f2eb9e474a2c4cd583fb4
-SHA512:
-  metadata.gz: 1270b6c9d02a08019277233f55f917a3257f05b559c5abaa31d0e10b1a8ea563caed502499a9642ec821d5d6cf33193a1e4cefb49c2c66035028a256660244ac
-  data.tar.gz: d03c8427a2c07913a447b831a2386150fe637025ce4114bb7dc1b72ec7596c410b0c2ecda3fd41a6082a6c821e7d27fe5edc2d789ba0782fda2fb40c0e928a90