signalfx-tracing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a420459939e98542547b4e5e7e6c767b004cb711
+  data.tar.gz: f688a0ec1e90979c4abdd6b3384d75f6d4146bb5
+SHA512:
+  metadata.gz: 191c96d35b8e2ff7eb6b77f734be4a1ebf30a7f6f3daf0e95f7e4e87f3499f56498d63e13e27093c2cb88b4a7e769e9df62709e1f63012329ae53add06ae9dcb
+  data.tar.gz: bcff8a6b2a0b9742b104299dfe22e331c32a3f5b38bf68912e6df0239f4277e6264d164cf4331fee241d12284c8c01a3755257b84d4093a5ae853472fd82c393

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in signalfx-tracing.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 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

data/README.md

@@ -0,0 +1,254 @@
+# Ruby auto-instrumenter
+
+## Usage
+
+Configure the instrumentation anywhere in the setup portion of your code or before doing anything
+that needs to be traced.
+
+For Rails, this would go in `config/initializer/tracing.rb`.
+
+The instrumentation can be done automatically, where the auto-instrumenter will
+check for modules defined in the code and instrument them if available:
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure(auto_instrument:true)
+```
+
+Manual configuration may be desirable when only some libraries should be traced.
+These instrumentations to can be selected in a block:
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |patcher|
+    patcher.instrument(:LibName)
+    ...
+end
+```
+
+Valid lib names are listed below with the instrumentation documentation.
+
+`configure` accepts several optional parameters:
+- `tracer`: a preconfigured OpenTracing tracer to use. If one is not provided,
+  a new tracer will be initialized.
+  - Default: `nil`
+- `ingest_url`: this is the endpoint to which spans are sent by the tracer.
+  - Default: `https://ingest.signalfx.com/v1/trace`
+- `service_name`: service name to send spans under.
+  - Default: `signalfx-ruby-tracing`
+- `access_token`: SignalFx access token for authentication.
+  - Default: `''`
+
+Environment variables can be used to configure `service_name` and `access_token`
+if not given to the `configure` method.
+
+```bash
+export SIGNALFX_ACCESS_TOKEN="<token>"
+export SIGNALFX_SERVICE_NAME="<service_name>"
+export SIGNALFX_INGEST_URL="<url>"
+```
+
+If these environment variables are not set, the values will default to the ones
+listed above.
+
+The `access_token` or `SIGNALFX_ACCESS_TOKEN` only needs to be set when sending
+spans to a SignalFx ingest directly. It is not required when using the Smart
+Agent or Smart Gateway.
+
+# Instrumentation
+
+This section contains details and configuration for specific frameworks.
+
+### Runtimes
+
+- MRI Ruby (CRuby) 2.0+
+
+### Web servers
+
+- Puma >= 5.0.0
+
+### 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          |                    |
+| Rails         |                    |
+| REST Client   | >= 2.0.0           |
+| Sinatra       | >= 1.1.4           |
+
+## Active Record
+
+This instrumentation creates spans for each Active Record query using the Active
+Support notifications framework.
+
+The source for this instrumentation is located [here](https://github.com/salemove/ruby-activerecord-opentracing).
+
+### Usage
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:ActiveRecord)
+end
+```
+
+## Elasticsearch
+
+Elasticsearch queries through the Ruby client are traced using a wrapper around
+the transport.
+
+The forked source for the instrumentation is located [here](https://github.com/signalfx/ruby-elasticsearch-tracer).
+
+### Usage
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:Elasticsearch, auto_instrument: true)
+end
+```
+
+When the `auto_instrument` option is `true`, it will allow all new Elasticsearch
+clients to automatically wrap the default or configured transport and get
+traces for queries. No additional configuration is necessary.
+
+Alternatively, the instrumentation can be used selectively by setting a custom
+transport on the clients to be traced manually:
+
+```ruby
+require 'elasticsearch'
+require 'elasticsearch-tracer'
+
+client = Elasticsearch::TracingClient.new
+client.transport = Elasticsearch::Tracer::Transport.new(tracer: OpenTracing.global_tracer,
+                                                        active_span: -> { OpenTracing.global_tracer.active_span },
+                                                        transport: client.transport)
+```
+
+## Faraday
+
+Faraday HTTP client instrumentation automatically creates spans for outgoing
+requests. If the remote service has instrumentation that is aware of Rack,
+those spans will be automatically nested with Faraday's spans.
+
+The source for this instrumentation is located [here](https://github.com/opentracing-contrib/ruby-faraday-tracer).
+
+### Usage
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:Faraday)
+end
+```
+
+To use the instrumentation directly without patching, the Faraday middleware
+must be inserted for each new connection:
+```ruby
+conn = Faraday.new(url: 'http://localhost:3000/') do |faraday|
+  faraday.use Faraday::Tracer
+end
+```
+
+For more detailed usage, please check the instrumenation's page.
+
+## Mysql2
+
+Mysql2 instrumentation traces all queries performed with the Mysql2 client.
+
+The source for this instrumentation is located [here](https://github.com/signalfx/ruby-mysql2-instrumentation)
+
+### Usage
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:Mysql2)
+end
+```
+
+## Net::HTTP
+
+This automatically traces all requests using Net::HTTP.
+
+The source for this instrumentation is located [here](https://github.com/signalfx/ruby-net-http-instrumentation).
+
+### Usage
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:NetHttp)
+end
+```
+
+## Rack
+
+Rack spans are created using the `rack-tracer` gem. This is enabled
+automatically for other frameworks that are built on top of Rack, but it can
+also be separately enabled.
+
+The source for this instrumentation is located [here](https://github.com/opentracing-contrib/ruby-rack-tracer).
+
+### Usage
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:Rack)
+end
+```
+
+## 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.
+
+The forked source for this instrumentation is located [here](https://github.com/signalfx/ruby-rails-tracer).
+
+### Usage
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:Rails)
+end
+```
+
+Optionally, to disable Rack instrumentation, set the `rack_tracer` field to false.
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:Rails, rack_tracer: false)
+end
+```
+
+## RestClient
+
+RestClient requests can be patched to automatically be wrapped in a span. It
+will also inject the span context so remote services can extract it.
+
+The source for this instrumentation is located [here](https://github.com/signalfx/ruby-restclient-instrumentation).
+
+### Usage
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:RestClient)
+end
+```
+
+## Sinatra
+
+Sinatra instrumentation traces requests and template rendering. The instrumenter
+registers a Sinatra extension that uses `rack-tracer` to trace requests and
+monkey-patches to trace view rendering. Rack instrumentation is automatically
+enabled when using Sinatra instrumentation.
+
+The source for this instrumentation is located [here](https://github.com/signalfx/ruby-sinatra-instrumentation).
+
+### Usage
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:Sinatra)
+end
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "signalfx/tracing"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/signalfx/tracing.rb

@@ -0,0 +1,60 @@
+require 'jaeger/client'
+require 'signalfx/tracing/http_sender'
+require 'signalfx/tracing/register'
+require 'thread'
+
+module SignalFx
+  module Tracing
+    module Instrumenter
+
+      class << self
+
+        attr_reader :ingest_url
+        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)
+          @ingest_url = ingest_url
+          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
+            end
+          else
+            yield self
+          end
+        end
+
+        def instrument(to_patch, **args)
+          if Register.available_libs[to_patch].nil?
+            puts "instrumentation not found"
+          else
+            Register.available_libs[to_patch].instrument(**args)
+          end
+        end
+
+        def set_tracer(tracer: nil, service_name: nil, access_token: nil)
+          # build a new tracer if one wasn't provided
+          if tracer.nil?
+            headers = {}
+
+            # don't set the header if no token was provided
+            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)
+
+            @tracer = Jaeger::Client.build(service_name: service_name, sender: http_sender, flush_interval: 1)
+            OpenTracing.global_tracer = @tracer
+          else
+            @tracer = tracer
+          end
+        end
+      end
+    end
+  end
+end

data/lib/signalfx/tracing/http_sender.rb

@@ -0,0 +1,23 @@
+require 'jaeger/client/http_sender'
+
+# This child class of HttpSender exists to allow Net::HTTP instrumentation to
+# ignore requests made by the tracer. The tracer uses the Thrift HTTP Transport,
+# which uses Net::HTTP internally, to send spans to the collector.
+#
+# The sender spins in a separate thread to send spans. The overridden
+# HttpSender#send_spans sets a thread variable, :http_sender_thread, which is
+# checked with a block passed to the Net::HTTP instrumentation.
+
+module SignalFx
+  module Tracing
+    class HttpSenderWithFlag < Jaeger::Client::HttpSender
+      def send_spans(spans)
+        Thread.current.thread_variable_set(:http_sender_thread, true)
+
+        super
+      ensure
+        Thread.current.thread_variable_set(:http_sender_thread, nil)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module ActiveRecord
+
+        Register.add_lib :ActiveRecord, self
+
+        class << self
+
+          def instrument(opts = {})
+            # load ActiveRecord and ActiveSupport if present
+            begin
+              require 'active_support'
+              require 'active_record'
+            rescue LoadError
+              return
+            end
+
+            require 'active_record/opentracing'
+            ::ActiveRecord::OpenTracing.instrument
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module Elasticsearch
+
+        Register.add_lib :Elasticsearch, self
+
+        class << self
+
+          attr_reader :instrumented
+
+          def instrument(opts = {})
+            return if @instrumented
+
+            begin
+              require 'elasticsearch'
+            rescue LoadError
+              return
+            end
+
+            require 'elasticsearch-tracer'
+
+            patch_new if opts.fetch(:auto_instrument, false)
+
+            # prevent re-instrumenting
+            @instrumented = true
+          end
+
+          def patch_new
+            ::Elasticsearch::Client.module_eval do
+              alias_method :new_original, :new
+
+              def new(arguments = {}, &block)
+                # create a new TracingClient, which is almost identical to the
+                # default client, and add the tracing transport afterwards. This
+                # allows us to maintain the original transport if the user has
+                # specified a non-default transport
+                client = ::Elasticsearch::Tracer::TracingClient.new(arguments, &block)
+                client.transport = ::Elasticsearch::Tracer::Transport.new(tracer: OpenTracing.global_tracer,
+                                                                          active_span: -> { OpenTracing.global_tracer.active_span },
+                                                                          transport: client.transport)
+
+                return client
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module Faraday
+
+        Register.add_lib :Faraday, self
+
+        class << self
+          
+          def instrument(opts = {})
+            begin
+              require 'faraday'
+            rescue LoadError
+              return
+            end
+
+            require 'faraday/tracer'
+
+            patch_initialize
+          end
+
+          # somewhat messy, but this lets connections be traced without manual
+          # configuration to use the middleware
+          def patch_initialize
+            ::Faraday::Connection.module_eval do
+              alias_method :initialize_original, :initialize
+
+              def initialize(url = nil, options = nil)
+                # initialize the connection as usual
+                initialize_original(url, options)
+
+                # before we let go, add the Faraday tracer to the beginning of the stack
+                @builder.insert(0, ::Faraday::Tracer)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,25 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module MongoDB
+
+        Register.add_lib :MongoDB, self
+
+        class << self
+
+          def instrument(opts = {})
+            begin
+              require 'mongo'
+            rescue LoadError
+              return
+            end
+
+            require 'mongodb/instrumentation'
+
+            ::MongoDB::Instrumentation.instrument
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module Mysql2
+
+        Register.add_lib :Mysql2, self
+
+        class << self
+
+          def instrument(opts = {})
+            begin
+              require 'mysql2'
+            rescue LoadError
+              return
+            end
+
+            require 'mysql2/instrumentation'
+
+            ::Mysql2::Instrumentation.instrument(tracer: SignalFx::Tracing::Instrumenter.tracer)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module NetHttp
+
+        Register.add_lib :NetHttp, self
+
+        class << self
+
+          def instrument(opts = {})
+            require 'net/http/tracer'
+
+            ignore_request = lambda { Thread.current.thread_variable_get(:http_sender_thread) }
+            ::Net::Http::Tracer.instrument(ignore_request: ignore_request)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/signalfx/tracing/instrumentation/patching-test.rb

@@ -0,0 +1,23 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module PatchingTest
+
+        Register.add_lib :PatchingTest, self
+
+        class << self
+
+          def instrument
+            ::PatchingTest::ToPatch.class_eval do
+              alias_method :test_old, :test
+
+              def test
+                puts "patched test"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module Rack
+
+        Register.add_lib :Rack, self
+
+        class << self
+
+          def instrument(opts = {})
+            begin
+              require 'rack'
+            rescue LoadError
+              return
+            end
+
+            require 'rack/tracer'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module Rails
+
+        Register.add_lib :Rails, self
+
+        class << self
+
+          def instrument(opts = {})
+            # instrument supported versions
+            return if !defined?(::Rails) or Gem::Version.new(::Rails::VERSION::STRING) < Gem::Version.new('3.2')
+
+            require 'rails/tracer'
+            require 'rack/tracer'
+
+            if opts.fetch(:rack_tracer, false)
+              # add rack middlewares
+              ::Rails.configuration.middleware.use(::Rack::Tracer)
+              ::Rails.configuration.middleware.insert_after(::Rack::Tracer, ::Rails::Rack::Tracer)
+            end
+
+            ::Rails::Tracer.instrument(full_trace: true)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module RestClient
+
+        Register.add_lib :RestClient, self
+
+        class << self
+
+          def instrument(opts = {})
+            begin
+              require 'restclient'
+            rescue LoadError
+              return
+            end
+
+            require 'restclient/instrumentation'
+            
+            ::RestClient::Instrumentation.instrument
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module Sinatra
+
+        Register.add_lib :Sinatra, self
+
+        class << self
+
+          def instrument(opt = {})
+            begin
+              require 'sinatra'
+            rescue LoadError
+              return
+            end
+
+            require 'sinatra/tracer'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/signalfx/tracing/register.rb

@@ -0,0 +1,41 @@
+module SignalFx
+    module Tracing
+        module Instrumenter
+            class Register
+
+                @available_libs = {}
+                @initialized = false
+
+                def self.available_libs
+                    return @available_libs
+                end
+
+                def self.initialized?
+                    return @initialized
+                end
+
+                def self.include_patches
+                    # all of the available patches must be added to the table here
+                    @available_libs[:PatchingTest] = Patches::PatchingTest::ToPatch.new
+
+                    @initialized = true
+                end
+
+                def self.add_lib(patch_key, patch_module)
+                  @available_libs[patch_key] = patch_module
+                end
+            end
+        end
+    end
+end
+
+require 'signalfx/tracing/instrumentation/active_record'
+require 'signalfx/tracing/instrumentation/sinatra'
+require 'signalfx/tracing/instrumentation/faraday'
+require 'signalfx/tracing/instrumentation/rack'
+require 'signalfx/tracing/instrumentation/net_http'
+require 'signalfx/tracing/instrumentation/rails'
+require 'signalfx/tracing/instrumentation/restclient'
+require 'signalfx/tracing/instrumentation/mongodb'
+require 'signalfx/tracing/instrumentation/elasticsearch'
+require 'signalfx/tracing/instrumentation/mysql2'

data/lib/signalfx/tracing/version.rb

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

data/signalfx-tracing.gemspec

@@ -0,0 +1,55 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "signalfx/tracing/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "signalfx-tracing"
+  spec.version       = Signalfx::Tracing::VERSION
+  spec.authors       = ["Ashwin Chandrasekar"]
+  spec.email         = ["achandrasekar@signalfx.com"]
+
+  spec.summary       = %q{Auto-instrumentation framework for Ruby}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/signalfx/signalfx-ruby-tracing"
+  spec.license       = "Apache 2.0"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  # 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 "sinatra-instrumentation", "~> 0.1"
+  spec.add_dependency "nethttp-instrumentation", "~> 0.1"
+  spec.add_dependency "restclient-instrumentation", "~> 0.1"
+  spec.add_dependency "mongodb-instrumentation", "~> 0.1"
+  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"
+
+  # external
+  spec.add_dependency "faraday-tracer", "~> 0.7.0"
+  spec.add_dependency "rack-tracer", "~> 0.8"
+  spec.add_dependency "activerecord-opentracing", "~> 0.2.1"
+end

metadata

@@ -0,0 +1,262 @@
+--- !ruby/object:Gem::Specification
+name: signalfx-tracing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ashwin Chandrasekar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: jaeger-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: sinatra-instrumentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: nethttp-instrumentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: restclient-instrumentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: mongodb-instrumentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: mysql2-instrumentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: signalfx-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
+    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: faraday-tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rack-tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: activerecord-opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+description: 
+email:
+- achandrasekar@signalfx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/signalfx/tracing.rb
+- lib/signalfx/tracing/http_sender.rb
+- lib/signalfx/tracing/instrumentation/active_record.rb
+- lib/signalfx/tracing/instrumentation/elasticsearch.rb
+- lib/signalfx/tracing/instrumentation/faraday.rb
+- lib/signalfx/tracing/instrumentation/mongodb.rb
+- lib/signalfx/tracing/instrumentation/mysql2.rb
+- lib/signalfx/tracing/instrumentation/net_http.rb
+- lib/signalfx/tracing/instrumentation/patching-test.rb
+- lib/signalfx/tracing/instrumentation/rack.rb
+- lib/signalfx/tracing/instrumentation/rails.rb
+- lib/signalfx/tracing/instrumentation/restclient.rb
+- lib/signalfx/tracing/instrumentation/sinatra.rb
+- lib/signalfx/tracing/register.rb
+- lib/signalfx/tracing/version.rb
+- signalfx-tracing.gemspec
+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
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Auto-instrumentation framework for Ruby
+test_files: []