signalfx-tracing 1.5.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e746c7d7bd14f60dd0f45b263b38e05e4f4e591b221ad877d047c38aaf4ec8bf
-  data.tar.gz: 7916da5154ead8d2cd37325bfa1bf9ed4f254704919d9802fb883a5783a0aeb9
+  metadata.gz: 2f20ce1d0998b95c507dd19b340537e51865387f1ab5022c45185746e0d03667
+  data.tar.gz: 0ada0dc7104f4dbaedd9194928117e7baf0aa23ae3ba66f69371bfc253582f0c
 SHA512:
-  metadata.gz: 8e82266212716e99449a73c3d11a8bbee4229c213b95d3be3cea1e96e562ea97969f807f95ebfec0c5e12fae2155ad9b7b8a6960eee7a6a7675e51979d8554f9
-  data.tar.gz: 26cd1d84fb7171603390a5f569122d7a91919e5c53b44041a358d651c685ae428d538e81afc6af780bec5024320dae394b0e8d2790e8ea4523077fdc8d8089c0
+  metadata.gz: baedb458a7cd326d523f53845cfc8157201de6d34811fde58c3643e8da2cb081e0a83186ee53e7815e86db11671659d87a33ab06ef56d496e74e3e0007fcfc34
+  data.tar.gz: b0ad72691b7a438b008d4748a4717cfc0f1a004b8cb939a1392f2fb88aa4cb7030807a23b8132829d80200443da11096fa21afad987b330b20e40fbaf230a7b9

data/README.md

@@ -29,7 +29,7 @@ Here are the requirements and supported software for the library.
 | [ActiveRecord](#active-record)  | 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.13.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        |
@@ -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
 
@@ -374,7 +376,7 @@ 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).
+[here](https://github.com/signalfx/ruby-rack-tracer).
 
 #### Usage
 

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.1.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.1.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.3'
-  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.1"
+    VERSION = "2.1.1"
   end
 end

data/signalfx-tracing.gemspec

@@ -35,4 +35,8 @@ Gem::Specification.new do |spec|
 
   # stdlib instrumentations
   spec.add_dependency "nethttp-instrumentation", "~> 0.1.2"
+
+  # 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.1
+  version: 2.1.1
 platform: ruby
 authors:
 - SignalFx, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
+- !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