signalfx-tracing 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbe697abb23f55c936cd5937309410b186258073
-  data.tar.gz: 7d32357ae60676f74828bf95fa7294b67880a039
+  metadata.gz: 3ccd213e2f5bb365118397b466f3ac34e660ab5e
+  data.tar.gz: 8b64213ad7583469a8e7c4aea8de6b7b3a6c12ea
 SHA512:
-  metadata.gz: 3e40fc35b33a468d4fcc501a1d3e00b76645bff8389960cf7b61b26a7d51a53fefc1dacb1f32a5facbbe6992ba1de08e64b32765d97b57e7ec7ae963eb5c61a8
-  data.tar.gz: 7682f03f50444badb12acd4039405ef9ccd6c6675f7fd3de3885ddc850793a513d9caea75c846d755f01f01881ea69c9bdc37e58d4eb53e4fc4f716804096f9f
+  metadata.gz: d6c606ea3b6832d534d50c5ea50e9012e6a6d665300c2a7b40a657e241cc675f2548a7387c602dd60f6a39c3586061f412fe25880376dd21ee00be2b70ce7f8c
+  data.tar.gz: 5695eef0830c459b516d8d143a1e0e4e0a032a7120229141cb40a1dc9e1f012632c7a7795468f00120e2ae33fd34f223ac4f00339eb6ec7f5beed29fdd8c05e2

data/README.md

@@ -50,6 +50,9 @@ Valid lib names are listed below with the instrumentation documentation.
   - Default: `signalfx-ruby-tracing`
 - `access_token`: SignalFx access token for authentication.
   - Default: `''`
+- `fork_safe`: If `true`, makes the tracer safe to fork if events cannot
+  be controlled
+  - Default: `false`
 
 Environment variables can be used to configure `service_name` and `access_token`
 if not given to the `configure` method.
@@ -78,6 +81,15 @@ This section contains details and configuration for specific frameworks.
 ### Web servers
 
 - Puma >= 3.0.0
+- Passenger >= 5.0.25
+
+Instrumentation for routes using these web servers is provided through Rack.
+If using a framework that builds on top of Rack, such as Rails or Sinatra, our
+instrumentation includes Rack instrumentation. In these cases, the routes
+through the web server will be automatically traced.
+
+When interfacing with these web servers as a Rack application, please configure
+[Rack instrumentation](#rack) and insert it as middleware.
 
 ### Libraries/Frameworks
 
@@ -225,6 +237,8 @@ The source for this instrumentation is located [here](https://github.com/opentra
 SignalFx::Tracing::Instrumenter.configure do |p|
     p.instrument(:Rack)
 end
+
+use Rack::Tracer
 ```
 
 ## Rails
@@ -292,3 +306,18 @@ SignalFx::Tracing::Instrumenter.configure do |p|
     p.instrument(:Sinatra)
 end
 ```
+
+## Troubleshooting
+
+### Forking
+
+If spans are no longer sent after forking a process, the span reporter thread
+has been lost while copying to the process.
+
+The reporter can be revived by calling `SignalFx::Tracing::Instrumenter.revive`
+in the newly created process.
+
+When the new process can't be handled directly, setting `fork_safe: true`
+when configuring the instrumentation will use a reporter that checks and revives
+itself every time a span is reported.
+

data/lib/signalfx/tracing.rb

@@ -1,8 +1,11 @@
 require 'jaeger/client'
 require 'jaeger/client/injectors'
 require 'jaeger/client/extractors'
+require 'signalfx/tracing/reporter/auto_reviving_async_reporter'
 require 'signalfx/tracing/http_sender'
+require 'signalfx/tracing/tracer'
 require 'signalfx/tracing/register'
+require 'signalfx/tracing/compat'
 require 'thread'
 
 module SignalFx
@@ -11,16 +14,21 @@ module SignalFx
 
       class << self
 
-        attr_reader :ingest_url
+        attr_reader :ingest_url, :service_name, :access_token
         attr_accessor :tracer
 
         def configure(tracer: nil,
                       ingest_url: ENV['SIGNALFX_INGEST_URL'] || 'https://ingest.signalfx.com/v1/trace',
                       service_name: ENV['SIGNALFX_SERVICE_NAME'] || "signalfx-ruby-tracing",
                       access_token: ENV['SIGNALFX_ACCESS_TOKEN'],
-                      auto_instrument: false)
+                      auto_instrument: false,
+                      fork_safe: false)
           @ingest_url = ingest_url
+          @service_name = service_name
+          @access_token = access_token
+          @fork_safe = fork_safe
           set_tracer(tracer: tracer, service_name: service_name, access_token: access_token)
+
           if auto_instrument
             Register.available_libs.each_pair do |key, value|
               value.instrument
@@ -28,6 +36,8 @@ module SignalFx
           else
             yield self
           end
+
+          Compat.apply
         end
 
         def instrument(to_patch, **args)
@@ -47,8 +57,10 @@ module SignalFx
             headers["X-SF-Token"] = access_token if access_token && !access_token.empty?
 
             encoder = Jaeger::Client::Encoders::ThriftEncoder.new(service_name: service_name)
+            @http_sender = SignalFx::Tracing::HttpSenderWithFlag.new(url: @ingest_url, headers: headers, encoder: encoder)
+            reporter = create_reporter(@http_sender)
 
-            http_sender = SignalFx::Tracing::HttpSenderWithFlag.new(url: @ingest_url, headers: headers, encoder: encoder)
+            sampler = Jaeger::Client::Samplers::Const.new(true)
 
             injectors = {
               OpenTracing::FORMAT_RACK => [Jaeger::Client::Injectors::B3RackCodec]
@@ -57,16 +69,30 @@ module SignalFx
               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)
+            @tracer = SignalFx::Tracing::Tracer.new(reporter: reporter, sampler: sampler, injectors: injectors, extractors: extractors)
             OpenTracing.global_tracer = @tracer
           else
             @tracer = tracer
           end
         end
+
+        # This method will either use the default reporter, which will not check
+        # for the sender thread, or if fork_safe is true then it will create the
+        # self-reviving reporter. The main use for this is
+        # when the process with the tracer gets forked or goes through some
+        # other process that kills child threads.
+        def create_reporter(sender)
+          if @fork_safe
+            SignalFx::Tracing::AutoRevivingAsyncReporter.new(sender, 1)
+          else
+            Jaeger::Client::AsyncReporter.create(sender: sender, flush_interval: 1)
+          end
+        end
+
+        # at the moment this just sets a new reporter in the tracer
+        def revive
+          @tracer.set_reporter(create_reporter(@http_sender)) if @tracer.respond_to? :set_reporter
+        end
       end
     end
 

data/lib/signalfx/tracing/compat.rb

@@ -0,0 +1,16 @@
+module SignalFx
+  module Tracing
+    module Compat
+      def self.apply
+        @compat.each { |mod| mod.apply } if @compat
+      end
+
+      def self.add_compat(mod)
+        @compat = [] unless @compat
+        @compat.push(mod)
+      end
+    end
+  end
+end
+
+require 'signalfx/tracing/compat/phusion_passenger'

data/lib/signalfx/tracing/compat/phusion_passenger.rb

@@ -0,0 +1,20 @@
+module SignalFx
+  module Tracing
+    module Compat
+      module PhusionPassenger
+        def self.apply
+          # register a hook for newly spawned processes
+          if defined? ::PhusionPassenger
+            ::PhusionPassenger.on_event(:starting_worker_process) do |forked|
+              if forked
+                SignalFx::Tracing::Instrumenter.revive
+              end
+            end
+          end
+        end
+      end
+
+      add_compat PhusionPassenger
+    end
+  end
+end

data/lib/signalfx/tracing/reporter/auto_reviving_async_reporter.rb

@@ -0,0 +1,35 @@
+require 'jaeger/client/async_reporter'
+
+# The Jaeger client's AsyncReporter creates a thread to handle sending spans on
+# a flush interval. However, when a forking web server like Passenger forks a
+# process that includes the tracer, the sender thread is lost.
+#
+# This checks for the thread's before pushing in a span to the buffer.
+# If it doesn't exist, it tells the instrumenter module to crate a new reporter.
+#
+# If you have control over hooking into fork events, signalfx/tracing/async_reporter
+# and reviving it should be preferred to avoid an unnecessary check with every
+# reported span.
+
+module SignalFx
+  module Tracing
+    class AutoRevivingAsyncReporter < ::Jaeger::Client::AsyncReporter
+      def initialize(sender, flush_interval)
+        @flush_interval = flush_interval
+        @poll_thread = Thread.new do
+          loop do
+            flush
+            sleep(@flush_interval)
+          end
+        end
+
+        super(sender)
+      end
+
+      def report(span)
+        ::SignalFx::Tracing::Instrumenter.revive if !@poll_thread
+        super
+      end
+    end
+  end
+end

data/lib/signalfx/tracing/tracer.rb

@@ -0,0 +1,15 @@
+require 'jaeger/client/tracer'
+
+# The default jaeger tracer doesn't expose @reporter, and attr_accessor can't
+# be added after the fact in a child class. So this just adds an old-fashioned
+# setter for @reporter.
+
+module SignalFx
+  module Tracing
+    class Tracer < ::Jaeger::Client::Tracer
+      def set_reporter(reporter)
+        @reporter = reporter
+      end
+    end
+  end
+end

data/lib/signalfx/tracing/version.rb

@@ -1,5 +1,5 @@
 module Signalfx
   module Tracing
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signalfx-tracing
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ashwin Chandrasekar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-17 00:00:00.000000000 Z
+date: 2018-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -220,6 +220,8 @@ files:
 - bin/console
 - bin/setup
 - lib/signalfx/tracing.rb
+- lib/signalfx/tracing/compat.rb
+- lib/signalfx/tracing/compat/phusion_passenger.rb
 - lib/signalfx/tracing/http_sender.rb
 - lib/signalfx/tracing/instrumentation/active_record.rb
 - lib/signalfx/tracing/instrumentation/elasticsearch.rb
@@ -233,6 +235,8 @@ files:
 - lib/signalfx/tracing/instrumentation/restclient.rb
 - lib/signalfx/tracing/instrumentation/sinatra.rb
 - lib/signalfx/tracing/register.rb
+- lib/signalfx/tracing/reporter/auto_reviving_async_reporter.rb
+- lib/signalfx/tracing/tracer.rb
 - lib/signalfx/tracing/version.rb
 - signalfx-tracing.gemspec
 homepage: https://github.com/signalfx/signalfx-ruby-tracing