signalfx-tracing 1.4.3 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d8084beade571589adf44ec1abf80119b97ec39a003cbbb140ea4c773295988
-  data.tar.gz: 117f57ee3d8c08085774660863c10aa80c2cc0b8c39447519ce0372ac41e85b5
+  metadata.gz: eb69751bf1eff41423dfb43a0470b00194ee39ca02cd1647eecbe845e31e0472
+  data.tar.gz: c3d1bb44a2fda8b7aa96b68ed98be8e1d6a23a502f570e7e04eb5ef42f413b1c
 SHA512:
-  metadata.gz: 8827b0f0b970821aa91b193256d1e7ab0c080bb740421f6739fd2446a4e06e56eb38ea38fef65d3b94efaa7487d642ab9101e2bc61eb2ebbaa1e3c819fc3144c
-  data.tar.gz: 0caaf7c27b8510d3f2473775787496e52a2386e052f24c380bf9584c2c24a21a1750e1e4475a5c727dc1281b403f7280e8aa3bf88a3c845edcd883b38ecf138a
+  metadata.gz: 977d6e639a0bd2098d23147cee9de114fca97e8156f67e186775a457c380a11ac52169765c3a5d796f170b89e8f4c04971366f6382428ddc4a015ccd8de1df33
+  data.tar.gz: c475b7183dcd21489595eb46d0168550b0b0f4b40bf0a9e8fe1f2f6321b9a4e5feee53913c93ba73d746f1ad3c6b89fd3cc4c1aa0f921542554ebf951f533cd0

data/.gitignore

@@ -1,3 +1,4 @@
+/vendor/
 *.lock
 *.gem
 .idea

data/README.md

@@ -29,12 +29,12 @@ 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        |
 | [Pg](#pg)                       | pg-instrumentation                     | >= 0.18.0          |
-| [Rack](#rack)                   | rack-tracer                            | >= 0.1             |
+| [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           |
@@ -44,7 +44,7 @@ Here are the requirements and supported software for the library.
 
 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 `rack-tracer` instrumentation with your dependency manager
+Sinatra, install the `sfx-rack-tracer` instrumentation with your dependency manager
 or with the bootstrap utility. In these cases, the routes through the web
 server are automatically traced.
 
@@ -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
@@ -369,12 +371,12 @@ end
 ```
 ### Rack
 
-Rack spans are created using the `rack-tracer` gem. This is enabled
+Rack spans are created using the `sfx-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).
+[here](https://github.com/signalfx/ruby-rack-tracer).
 
 #### Usage
 
@@ -394,7 +396,7 @@ use Rack::Tracer
 ### Rails
 
 Rails applications can be traced using the notifications provided by ActiveSupport.
-It will use `rack-tracer` to trace by requests.
+It will use `sfx-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 `rack-tracer` to trace requests and
+registers a Sinatra extension that uses `sfx-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

@@ -7,12 +7,12 @@ 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"],
+  "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" => ["rack-tracer", { git: 'git://github.com/signalfx/ruby-rack-tracer.git', branch: 'sfx_release' }],
+  "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"],

data/gem.deps.rb

@@ -1,12 +1,12 @@
 group :instrumentations do
   gem 'activerecord-opentracing', '~> 0.2.1'
-  gem 'grape-instrumentation', "~> 0.1.0"
+  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 'rack-tracer', git: 'git://github.com/signalfx/ruby-rack-tracer.git', branch: 'sfx_release'
-  gem 'rails-instrumentation', '0.1.3'
+  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'

data/lib/signalfx/tracing.rb

@@ -1,9 +1,14 @@
 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/sfx_logger'
 require 'signalfx/tracing/tags'
+require 'signalfx/tracing/tracer'
+require 'signalfx/tracing/span'
 require 'thread'
 
 module SignalFx
@@ -19,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|
@@ -41,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}" }
@@ -54,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 = Jaeger::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

@@ -0,0 +1,27 @@
+require 'jaeger/span'
+
+module SignalFx
+  module Tracing
+    module Span
+      def record_exception(exception, record_error=true) 
+        set_tag('error', true) if record_error
+
+        fields = {
+          :event => 'error',
+          :'error.kind' => exception.class.to_s,
+          :'error.object' => exception,
+          :message => exception.message,
+        }
+
+        if not exception.backtrace.nil?
+          fields[:stack] = exception.backtrace.join('\n')
+        end
+
+        log_kv(**fields)
+      end
+    end
+  end
+end
+
+
+Jaeger::Span.class_eval { include SignalFx::Tracing::Span }

data/lib/signalfx/tracing/tracer.rb

@@ -1,14 +1,22 @@
+require 'jaeger/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.
+# This also adds the set_error method that can be used to add an exception to
+# the currently active span.
 
 module SignalFx
   module Tracing
-    class Tracer < ::Jaeger::Client::Tracer
+    class Tracer < ::Jaeger::Tracer
       def set_reporter(reporter)
         @reporter = reporter
       end
+
+      def record_exception(exception, record_error=true)
+        span = active_span
+        span.record_exception(exception, record_error) if span 
+      end
     end
   end
 end

data/lib/signalfx/tracing/version.rb

@@ -1,5 +1,5 @@
 module Signalfx
   module Tracing
-    VERSION = "1.4.3"
+    VERSION = "1.6.1"
   end
 end

data/signalfx-tracing.gemspec

@@ -20,8 +20,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit"
 
   # TODO pin versions once consistent across all dependencies
   spec.add_dependency "opentracing", "> 0.3.0"
@@ -34,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.4.3
+  version: 1.6.1
 platform: ruby
 authors:
 - SignalFx, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2020-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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'
 - !ruby/object:Gem::Dependency
   name: opentracing
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +132,7 @@ files:
 - lib/signalfx/tracing/register.rb
 - lib/signalfx/tracing/reporter/auto_reviving_async_reporter.rb
 - lib/signalfx/tracing/sfx_logger.rb
+- lib/signalfx/tracing/span.rb
 - lib/signalfx/tracing/tags.rb
 - lib/signalfx/tracing/tracer.rb
 - lib/signalfx/tracing/version.rb