signalfx-tracing 1.5.2 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76f49e90a746e01bab86b3172c2ddd7f49aae975d70191f297a1e18e110e558d
-  data.tar.gz: 677c15658a0d10c61c8defc270e1c9a4d84c8e838626dfc9fc63198927ba755f
+  metadata.gz: 2bdfe4908f45da406037ff74a393f763c4b162ae1fc0fcc018bdb0c437f694ed
+  data.tar.gz: 654481fb002121b3f3fdb9698030c6fd88ca1dab4595de9371601cbbf877dfcf
 SHA512:
-  metadata.gz: b934a8cdc290183f72306b772e1b4422171ad3c717fe97c9f9c697deb543c67d95ce25b7c7073dcc50e30a888a1ae5101477fb6260c611c82c985ee81d11b7bb
-  data.tar.gz: 91a4a8d6817d3c28cb70672f315706a5c4153d279a956682650c0adf4d7ec69fa6ab305c38dce31220eca11932a924e6d63484427c18288057218cb13b69fa77
+  metadata.gz: 866e9610bc170b39a318de3ab65a5c7f73e74b1cad50af8cafb33c1870bb41762c5276baf52a6adba517eb650442e984bd033456b5e9510c85a48c8da30e62ab
+  data.tar.gz: 8ef2fe7d563d9e3b97d3c2c8c581d5c9315f5aa3042e470acaf779f2c84cb2546f130440759f86aa542c628a4f56b6fd2b5bdf61af0a3f654d116ee554801a16

data/README.md

@@ -26,25 +26,25 @@ Here are the requirements and supported software for the library.
 
 | Library                         | Instrumentation name                   | Versions Supported |
 | ------------------------------- | -------------------------------------- | ------------------ |
-| [ActiveRecord](#active-record)  | activerecord-opentracing               | ~> 5.0             |
+| [ActiveRecord](#active-record)  | signalfx-activerecord-opentracing      | ~> 5.0             |
 | [Elasticsearch](#elasticsearch) | signalfx-elasticsearch-instrumentation | >= 6.0.2           |
 | [Faraday](#faraday)             | signalfx-faraday-instrumentation       | >= 0.9.0           |
-| [Grape](#grape)                 | grape-instrumentation                  | >= 0.2.0           |
-| [Mongo](#mongo)                 | mongodb-instrumentation                | >= 2.1.0           |
-| [Mysql2](#mysql2)               | mysql2-instrumentation                 | >= 0.4.0           |
-| [Net::HTTP](#nethttp)           | nethttp-instrumentation                | Ruby >= 2.0        |
-| [Pg](#pg)                       | pg-instrumentation                     | >= 0.18.0          |
-| [Rack](#rack)                   | sfx-rack-tracer                        | >= 0.10.0          |
-| [Rails](#rails)                 | rails-instrumentation                  | >= 3.0.0           |
-| [Redis](#redis)                 | redis-instrumentation                  | >= 4.0.0           |
-| [RestClient](#restclient)       | restclient-instrumentation             | >= 1.5.0           |
-| [Sequel](#sequel)               | sequel-instrumentation                 | >= 3.47.0          |
-| [Sidekiq](#sidekiq)             | sfx-sidekiq-opentracing                | >= 0.7.0           |
-| [Sinatra](#sinatra)             | sinatra-instrumentation                | >= 1.0.0           |
+| [Grape](#grape)                 | signalfx-grape-instrumentation         | >= 0.2.0           |
+| [Mongo](#mongo)                 | signalfgx-mongodb-instrumentation      | >= 2.1.0           |
+| [Mysql2](#mysql2)               | signalfx-mysql2-instrumentation        | >= 0.4.0           |
+| [Net::HTTP](#nethttp)           | signalfx-nethttp-instrumentation       | Ruby >= 2.0        |
+| [Pg](#pg)                       | signalfx-pg-instrumentation            | >= 0.18.0          |
+| [Rack](#rack)                   | signalfx-rack-tracer                   | >= 0.10.0          |
+| [Rails](#rails)                 | signalfx-rails-instrumentation         | >= 3.0.0           |
+| [Redis](#redis)                 | signalfx-redis-instrumentation         | >= 4.0.0           |
+| [RestClient](#restclient)       | signalfx-restclient-instrumentation    | >= 1.5.0           |
+| [Sequel](#sequel)               | signalfx-sequel-instrumentation        | >= 3.47.0          |
+| [Sidekiq](#sidekiq)             | signalfx-sidekiq-opentracing           | >= 0.7.0           |
+| [Sinatra](#sinatra)             | signalfx-sinatra-instrumentation       | >= 1.0.0           |
 
 Instrumentation for routes using Puma or Passenger is provided through
 Rack. If you use a framework that builds on top of Rack, such as Rails or
-Sinatra, install the `sfx-rack-tracer` instrumentation with your dependency manager
+Sinatra, install the `signalfx-rack-tracer` instrumentation with your dependency manager
 or with the bootstrap utility. In these cases, the routes through the web
 server are automatically traced.
 
@@ -89,8 +89,8 @@ The steps assume you have RubyGems and Bundler.
 3. Add each applicable instrumentation to your application's Gemfile. For
    example, this is how you add Rails and Redis:
    ```bash
-   $ gem 'rails-instrumentation'
-   $ gem 'redis-instrumentation'
+   $ gem 'signalfx-rails-instrumentation'
+   $ gem 'signalfx-redis-instrumentation'
    ```
    For information about instrumentation names, see supported libraries and their
    current versions in `gem.deps.rb`. If you configure Rails instrumentation, it
@@ -120,8 +120,10 @@ If the default configuration values don't apply for your environment, override t
 | ingest_url          | SIGNALFX_ENDPOINT_URL              | `http://localhost:9080/v1/trace` | The endpoint the tracer sends spans to. Send spans to a Smart Agent, OpenTelemetry Collector, or a SignalFx ingest endpoint. |
 | service_name        | SIGNALFX_SERVICE_NAME              | `signalfx-ruby-tracing`          | The name to identify the service in SignalFx. |
 | access_token        | SIGNALFX_ACCESS_TOKEN              | `''`                             | The SignalFx organization access token. |
+| span_tags           | SIGNALFX_SPAN_TAGS                 | `nil`                            | Comma-separated list of tags included in every reported span. For example, "key1:val1,key2:val2". Use only string values for tags.|
 | N/A                 | SIGNALFX_RECORDED_VALUE_MAX_LENGTH | `1200`                           | Maximum length an attribute value can have. Values longer than this are truncated. |
 
+
 ### Automatically instrument code:
 
 Configure the auto-instrumentor to check for modules defined in the code and
@@ -156,7 +158,7 @@ This instrumentation creates spans for each Active Record query using the Active
 Support notifications framework. If you configure Rails instrumentation, it also configures Active Record instrumentation, so you don't need to instrument both.
 
 The source for this instrumentation is located
-[here](https://github.com/salemove/ruby-activerecord-opentracing).
+[here](https://github.com/signalfx/ruby-activerecord-opentracing).
 
 #### Usage
 
@@ -216,7 +218,7 @@ 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).
+[here](https://github.com/signalfx/ruby-faraday-tracer).
 
 #### Usage
 
@@ -369,7 +371,7 @@ end
 ```
 ### Rack
 
-Rack spans are created using the `sfx-rack-tracer` gem. This is enabled
+Rack spans are created using the `signalfx-rack-tracer` gem. This is enabled
 automatically for other frameworks that are built on top of Rack, but it can
 also be separately enabled.
 
@@ -394,7 +396,7 @@ use Rack::Tracer
 ### Rails
 
 Rails applications can be traced using the notifications provided by ActiveSupport.
-It will use `sfx-rack-tracer` to trace by requests.
+It will use `signalfx-rack-tracer` to trace by requests.
 
 The forked source for this instrumentation is located
 [here](https://github.com/signalfx/ruby-rails-instrumentation).
@@ -541,7 +543,7 @@ Arguments:
 ### Sinatra
 
 Sinatra instrumentation traces requests and template rendering. The instrumenter
-registers a Sinatra extension that uses `sfx-rack-tracer` to trace requests and
+registers a Sinatra extension that uses `signalfx-rack-tracer` to trace requests and
 monkey-patches to trace view rendering. Rack instrumentation is automatically
 enabled when using Sinatra instrumentation.
 

data/bin/sfx-rb-trace-bootstrap

@@ -4,21 +4,21 @@ require 'ostruct'
 require 'pp'
 
 instrumentations = {
-  "activerecord" => ["activerecord-opentracing", "~> 0.2.1"],
-  "elasticsearch" => ["signalfx-elasticsearch-instrumentation", "~> 0.1.0"],
-  "faraday" => ["signalfx-faraday-instrumentation", "~> 0.1.1"],
-  "grape" => ["grape-instrumentation", "~> 0.2.0"],
-  "mongodb" => ["mongodb-instrumentation", "~> 0.1.1"],
-  "mysql2" => ["mysql2-instrumentation", "~> 0.2.1"],
-  "nethttp" => ["nethttp-instrumentation", "~> 0.1.2"],
-  "pg" => ["pg-instrumentation", "~> 0.1.0"],
-  "rack" => ["sfx-rack-tracer", "~> 0.10.0"],
-  "rails" => ["rails-instrumentation", "~> 0.1.5"],
-  "redis" => ["redis-instrumentation", "~> 0.2.0"],
-  "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"]
+  "activerecord" => ["signalfx-activerecord-opentracing", "~> 0.1.0"],
+  "elasticsearch" => ["signalfx-elasticsearch-instrumentation", "~> 0.2.0"],
+  "faraday" => ["signalfx-faraday-instrumentation", "~> 0.2.0"],
+  "grape" => ["signalfx-grape-instrumentation", "~> 0.1.0"],
+  "mongodb" => ["signalfx-mongodb-instrumentation", "~> 0.1.1"],
+  "mysql2" => ["signalfx-mysql2-instrumentation", "~> 0.1.1"],
+  "nethttp" => ["signalfx-nethttp-instrumentation", "~> 0.2.0"],
+  "pg" => ["signalfx-pg-instrumentation", "~> 0.1.0"],
+  "rack" => ["signalfx-rack-tracer", "~> 0.1.0"],
+  "rails" => ["signalfx-rails-instrumentation", "~> 0.2.0"],
+  "redis" => ["signalfx-redis-instrumentation", "~> 0.1.0"],
+  "restclient" => ["signalfx-restclient-instrumentation", "~> 0.1.0"],
+  "sequel" => ["signalfx-sequel-instrumentation", "~> 0.1.0"],
+  "sidekiq" => ["signalfx-sidekiq-opentracing", "~> 0.1.0"],
+  "sinatra" => ["signalfx-sinatra-instrumentation", "~> 0.1.0"]
 }
 
 options = OpenStruct.new

data/gem.deps.rb

@@ -1,17 +1,17 @@
 group :instrumentations do
-  gem 'activerecord-opentracing', '~> 0.2.1'
-  gem 'grape-instrumentation', "~> 0.2.0"
-  gem 'mongodb-instrumentation', '~> 0.1.1'
-  gem 'mysql2-instrumentation', '~> 0.2.1'
-  gem 'nethttp-instrumentation', '~> 0.1.2'
-  gem 'pg-instrumentation',  '~> 0.1.0'
-  gem 'sfx-rack-tracer', '~> 0.10.0'
-  gem 'rails-instrumentation', '~> 0.1.5'
-  gem 'redis-instrumentation', '~> 0.2.0'
-  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'
+  gem 'signalfx-activerecord-opentracing', '~> 0.1.0'
+  gem 'signalfx-grape-instrumentation', "~> 0.1.0"
+  gem 'signalfx-mongodb-instrumentation', '~> 0.1.1'
+  gem 'signalfx-mysql2-instrumentation', '~> 0.1.1'
+  gem 'signalfx-nethttp-instrumentation', '~> 0.2.0'
+  gem 'signalfx-pg-instrumentation',  '~> 0.1.0'
+  gem 'signalfx-rack-tracer', '~> 0.1.0'
+  gem 'signalfx-rails-instrumentation', '~> 0.2.0'
+  gem 'signalfx-redis-instrumentation', '~> 0.1.0'
+  gem 'signalfx-restclient-instrumentation', '~> 0.1.0'
+  gem 'signalfx-sequel-instrumentation', '~> 0.1.0'
+  gem 'signalfx-sidekiq-opentracing', '~> 0.1.0'
+  gem 'signalfx-elasticsearch-instrumentation', '~> 0.2.0'
+  gem 'signalfx-faraday-instrumentation', '~> 0.2.0'
+  gem 'signalfx-sinatra-instrumentation', '~> 0.1.0'
 end

data/lib/signalfx/tracing.rb

@@ -1,8 +1,10 @@
 require 'jaeger/client'
+require 'jaeger/samplers'
+require 'jaeger/injectors'
+require 'jaeger/extractors'
 require 'signalfx/tracing/http_sender'
 require 'signalfx/tracing/register'
 require 'signalfx/tracing/compat'
-require 'signalfx/tracing/client'
 require 'signalfx/tracing/sfx_logger'
 require 'signalfx/tracing/tags'
 require 'signalfx/tracing/tracer'
@@ -22,11 +24,14 @@ module SignalFx
                       ingest_url: ENV['SIGNALFX_ENDPOINT_URL'] || ENV['SIGNALFX_INGEST_URL'] || 'http://localhost:9080/v1/trace',
                       service_name: ENV['SIGNALFX_SERVICE_NAME'] || "signalfx-ruby-tracing",
                       access_token: ENV['SIGNALFX_ACCESS_TOKEN'],
-                      auto_instrument: false)
+                      auto_instrument: false,
+                      span_tags: {})
           @ingest_url = ingest_url
           @service_name = service_name
           @access_token = access_token
-          set_tracer(tracer: tracer, service_name: service_name, access_token: access_token) if @tracer.nil?
+
+          span_tags = process_span_tags(span_tags)
+          set_tracer(tracer: tracer, service_name: service_name, access_token: access_token, span_tags: span_tags) if @tracer.nil?
 
           if auto_instrument
             Register.available_libs.each_pair do |key, value|
@@ -44,6 +49,17 @@ module SignalFx
           Compat.apply
         end
 
+        def process_span_tags(span_tags={})
+          span_tags_string = ENV['SIGNALFX_SPAN_TAGS']
+          if not span_tags_string.nil?
+            span_tags_string.split(',').each do |t|
+              k, v = t.strip.split(':')
+              span_tags[k] = v
+            end
+          end
+          return span_tags
+        end
+
         def instrument(to_patch, **args)
           if Register.available_libs[to_patch].nil?
             logger.error { "instrumentation not found: #{to_patch}" }
@@ -57,33 +73,38 @@ module SignalFx
           end
         end
 
-        def set_tracer(tracer: nil, service_name: nil, access_token: nil)
+        def new_tracer(service_name: nil, access_token: nil, span_tags: {})
+          # build a new tracer if one wasn't provided
+          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, tags: span_tags)
+          @http_sender = SignalFx::Tracing::HttpSenderWithFlag.new(url: @ingest_url, headers: headers, encoder: encoder)
+          @reporter = Jaeger::Client::Reporters::RemoteReporter.new(sender: @http_sender, flush_interval: 1)
+
+          injectors = {
+            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_TEXT_MAP => [Jaeger::Client::Extractors::B3TextMapCodec]
+          }
+
+          Tracer.new(
+            reporter: reporter,
+            sampler: Jaeger::Samplers::Const.new(true),
+            injectors: Jaeger::Injectors.prepare(injectors),
+            extractors: Jaeger::Extractors.prepare(extractors)
+          )
+        end
+
+        def set_tracer(tracer: nil, service_name: nil, access_token: nil, span_tags: {})
           # 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)
-            @reporter = Jaeger::Client::Reporters::RemoteReporter.new(sender: @http_sender, flush_interval: 1)
-
-            injectors = {
-              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_TEXT_MAP => [Jaeger::Client::Extractors::B3TextMapCodec]
-            }
-
-            @tracer = SignalFx::Tracing::Client.build(
-              service_name: service_name,
-              reporter: @reporter,
-              injectors: injectors,
-              extractors: extractors
-            )
+            @tracer = new_tracer(service_name: service_name, access_token: access_token, span_tags: span_tags)
             OpenTracing.global_tracer = @tracer
           else
             @tracer = tracer

data/lib/signalfx/tracing/span.rb

@@ -3,19 +3,16 @@ require 'jaeger/span'
 module SignalFx
   module Tracing
     module Span
-      def set_error(error) 
-        set_tag('error', true)
-        log_kv(
-          event: 'error',
-          :'error.kind' => error.class.to_s,
-          :'error.object' => error,
-          message: error.message,
-          stack: error.backtrace.join("\n")
-        )
+      def record_exception(exception, record_error=true) 
+        set_tag(:error, true) if record_error
+        set_tag(:'sfx.error.kind', exception.class.to_s) 
+        set_tag(:'sfx.error.message', exception.message)
+        if not exception.backtrace.nil?
+          set_tag(:'sfx.error.stack', exception.backtrace.join('\n'))
+        end
       end
     end
   end
 end
 
-
-Jaeger::Span.class_eval { include SignalFx::Tracing::Span }
+Jaeger::Span.class_eval { prepend SignalFx::Tracing::Span }

data/lib/signalfx/tracing/tracer.rb

@@ -13,9 +13,9 @@ module SignalFx
         @reporter = reporter
       end
 
-      def set_error(error)
+      def record_exception(exception, record_error=true)
         span = active_span
-        span.set_error(error) if span 
+        span.record_exception(exception, record_error) if span 
       end
     end
   end

data/lib/signalfx/tracing/version.rb

@@ -1,5 +1,5 @@
 module Signalfx
   module Tracing
-    VERSION = "1.5.2"
+    VERSION = "2.2.1"
   end
 end

data/signalfx-tracing.gemspec

@@ -34,5 +34,9 @@ Gem::Specification.new do |spec|
   # `gem install -g`
 
   # stdlib instrumentations
-  spec.add_dependency "nethttp-instrumentation", "~> 0.1.2"
+  spec.add_dependency "signalfx-nethttp-instrumentation", "~> 0.2.0"
+
+  # uncomment and run `bundle install` in order to run the whole test suite
+  spec.add_development_dependency "faraday", "~> 1.0"
+  spec.add_development_dependency "signalfx-faraday-instrumentation"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signalfx-tracing
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 2.2.1
 platform: ruby
 authors:
 - SignalFx, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,19 +81,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: nethttp-instrumentation
+  name: signalfx-nethttp-instrumentation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: signalfx-faraday-instrumentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - info@signalfx.com
@@ -110,7 +138,6 @@ files:
 - bin/sfx-rb-trace-bootstrap
 - gem.deps.rb
 - lib/signalfx/tracing.rb
-- lib/signalfx/tracing/client.rb
 - lib/signalfx/tracing/compat.rb
 - lib/signalfx/tracing/compat/phusion_passenger.rb
 - lib/signalfx/tracing/http_sender.rb

data/lib/signalfx/tracing/client.rb

@@ -1,38 +0,0 @@
-module SignalFx
-  module Tracing
-    module Client
-      include ::Jaeger::Client 
-
-      def self.build(host: '127.0.0.1',
-                     port: 6831,
-                     service_name:,
-                     flush_interval: DEFAULT_FLUSH_INTERVAL,
-                     sampler: Samplers::Const.new(true),
-                     logger: Logger.new(STDOUT),
-                     sender: nil,
-                     reporter: nil,
-                     injectors: {},
-                     extractors: {},
-                     tags: {})
-        encoder = Encoders::ThriftEncoder.new(service_name: service_name, tags: tags)
-
-        if sender
-          warn '[DEPRECATION] Passing `sender` directly to Jaeger::Client.build is deprecated.' \
-          'Please use `reporter` instead.'
-        end
-
-        reporter ||= Reporters::RemoteReporter.new(
-          sender: sender || UdpSender.new(host: host, port: port, encoder: encoder, logger: logger),
-          flush_interval: flush_interval
-        )
-
-        Tracer.new(
-          reporter: reporter,
-          sampler: sampler,
-          injectors: Injectors.prepare(injectors),
-          extractors: Extractors.prepare(extractors)
-        )
-      end
-    end
-  end
-end