signalfx-tracing 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76f49e90a746e01bab86b3172c2ddd7f49aae975d70191f297a1e18e110e558d
-  data.tar.gz: 677c15658a0d10c61c8defc270e1c9a4d84c8e838626dfc9fc63198927ba755f
+  metadata.gz: 49437c65e9bfc27abb4f181a5d313fb6a4c9bf50fd772c69740c0ac6b2b8f76e
+  data.tar.gz: 03302bdbd211243994211258d45d8d31bdb64f2937a5d761d96aabdead863048
 SHA512:
-  metadata.gz: b934a8cdc290183f72306b772e1b4422171ad3c717fe97c9f9c697deb543c67d95ce25b7c7073dcc50e30a888a1ae5101477fb6260c611c82c985ee81d11b7bb
-  data.tar.gz: 91a4a8d6817d3c28cb70672f315706a5c4153d279a956682650c0adf4d7ec69fa6ab305c38dce31220eca11932a924e6d63484427c18288057218cb13b69fa77
+  metadata.gz: 312b0aacb48ca54b5b27b5285d179216ca2e57b2ec22c88dff141a2859be907e3891be3e71b63aeccc18ff501051adf4faead0558be63b76413097e7db257197
+  data.tar.gz: 90bf8a6f27e8ca4b856b3c06ff9e09f4c20b5ac7deda0bcd300c099233e15b14c981291b926f6a90e6ac86f2109137f5ad6d5c422c584b7cdbb914ba2af4fe48

data/README.md

@@ -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

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,14 +3,14 @@ require 'jaeger/span'
 module SignalFx
   module Tracing
     module Span
-      def set_error(error) 
-        set_tag('error', true)
+      def record_exception(exception, record_error=true) 
+        set_tag('error', true) if record_error
         log_kv(
           event: 'error',
-          :'error.kind' => error.class.to_s,
-          :'error.object' => error,
-          message: error.message,
-          stack: error.backtrace.join("\n")
+          :'error.kind' => exception.class.to_s,
+          :'error.object' => exception,
+          message: exception.message,
+          stack: exception.backtrace.join("\n")
         )
       end
     end

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 = "1.6.0"
   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.2
+  version: 1.6.0
 platform: ruby
 authors:
 - SignalFx, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,7 +110,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