zipkin-tracer 0.21.2 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc6bb6d03809b2c58f53130d3471bc875cc8b99b
-  data.tar.gz: 952bcafa2c2ebdce4d26f49664e6b8cee9af4ce6
+  metadata.gz: 9e370dd751832be287e591eb227b01384f939a87
+  data.tar.gz: 1c14cb00ffa226c6f301130e543ac6bd4e4b81a4
 SHA512:
-  metadata.gz: 38cbbe277215a92f7c1c01b0f727e20ae1d765e00c3c3364d7da898294725e2dd3fd7f23fe3f31743ed46fa910619e1dc082d96b4afbc0b5ba0eb212ca4f3365
-  data.tar.gz: 4913f1f54e4eea4f079c5bb4bd6002c838fd5ab439ed9ecb8de5cbb7a424916c28a24ea1cefdec0a2630bf9b359ee3e42b859f19d00a7f96a73b6598ec76e596
+  metadata.gz: 5403b8f35d8ae2c2b63e84b8b205bd89f54790c2ccada5e60e83c6d5f64cdd3315b28a765149d47269327f9bca1d07229dfb59c248b7959032fc5e6d4bad47c2
+  data.tar.gz: bc38a24c9a4dcc616f662bf9009009abd437e967d519e93b68d9a015a3a1fb08627755d7a396d710726d96b4c185c03d69cb4b6917e58ae6b0a0cfd3a81e6a80

data/lib/zipkin-tracer/config.rb

@@ -1,5 +1,6 @@
 require 'logger'
 require 'zipkin-tracer/application'
+require 'zipkin-tracer/rack/zipkin-tracer'
 
 module ZipkinTracer
   # Configuration of this gem. It reads the configuration and provides default values
@@ -7,7 +8,7 @@ module ZipkinTracer
     attr_reader :service_name, :service_port, :json_api_host,
       :zookeeper, :sample_rate, :logger, :log_tracing,
       :annotate_plugin, :filter_plugin, :whitelist_plugin,
-      :sampled_as_boolean
+      :sampled_as_boolean, :record_on_server_receive
 
     def initialize(app, config_hash)
       config = config_hash || Application.config(app)
@@ -30,7 +31,6 @@ module ZipkinTracer
       # A block of code which can be called to force sampling. Forces sampling if returns true
       @whitelist_plugin  = config[:whitelist_plugin]
       @logger            = Application.logger
-      @log_tracing       = config[:log_tracing]       # Was the logger in fact setup by the client?
       # Was the logger in fact setup by the client?
       @log_tracing       = config[:log_tracing]
       # When set to false, it uses 1/0 in the 'X-B3-Sampled' header, else uses true/false
@@ -39,6 +39,9 @@ module ZipkinTracer
       if @sampled_as_boolean
         @logger && @logger.warn("Using a boolean in the Sampled header is deprecated. Consider setting sampled_as_boolean to false")
       end
+      # Record the given tags on server receive, even if the zipkin headers were present in the incoming request?
+      @record_on_server_receive = parse_tags(config[:record_on_server_receive])
+
       Trace.sample_rate = @sample_rate
     end
 
@@ -62,10 +65,17 @@ module ZipkinTracer
       sampled_as_boolean: true
     }
 
+    def parse_tags(tag_names)
+      return {} unless present?(tag_names)
+      names = tag_names.split(",").map(&:strip)
+      (ZipkinTracer::RackHandler::DEFAULT_SERVER_RECV_TAGS.keys & names).each_with_object({}) do |name, tags|
+        tags[name] = ZipkinTracer::RackHandler::DEFAULT_SERVER_RECV_TAGS[name]
+      end
+    end
+
     def present?(str)
       return false if str.nil?
       !!(/\A[[:space:]]*\z/ !~ str)
     end
-
   end
 end

data/lib/zipkin-tracer/rack/zipkin-tracer.rb

@@ -1,3 +1,4 @@
+require 'rack'
 require 'finagle-thrift/trace'
 require 'finagle-thrift/tracer'
 require 'zipkin-tracer/config'
@@ -8,6 +9,14 @@ module ZipkinTracer
   # This middleware reads Zipkin headers from the request and sets/creates a Trace.id usable by the rest of the app
   # It will also send the trace to the Zipkin service using one of the methods configured.
   class RackHandler
+    # the following constants are defined only from rack 1.6
+    PATH_INFO = Rack::PATH_INFO rescue 'PATH_INFO'.freeze
+    REQUEST_METHOD = Rack::REQUEST_METHOD rescue 'REQUEST_METHOD'.freeze
+
+    DEFAULT_SERVER_RECV_TAGS = {
+     Trace::BinaryAnnotation::PATH => PATH_INFO
+    }.freeze
+
     def initialize(app, config = nil)
       @app = app
       @config = Config.new(app, config).freeze
@@ -21,7 +30,7 @@ module ZipkinTracer
         if !trace_id.sampled? || !routable_request?(env)
           @app.call(env)
         else
-          @tracer.with_new_span(trace_id, env['REQUEST_METHOD'].to_s.downcase) do |span|
+          @tracer.with_new_span(trace_id, env[REQUEST_METHOD].to_s.downcase) do |span|
             trace!(span, zipkin_env) { @app.call(env) }
           end
         end
@@ -31,7 +40,7 @@ module ZipkinTracer
     private
 
     def routable_request?(env)
-      Application.routable_request?(env['PATH_INFO'],  env['REQUEST_METHOD'])
+      Application.routable_request?(env[PATH_INFO],  env[REQUEST_METHOD])
     end
 
     def annotate_plugin(env, status, response_headers, response_body)
@@ -39,8 +48,7 @@ module ZipkinTracer
     end
 
     def trace!(span, zipkin_env, &block)
-      # if called by a service, the caller already added the information
-      trace_request_information(span, zipkin_env.env) unless zipkin_env.called_with_zipkin_headers?
+      trace_request_information(span, zipkin_env)
       span.record(Trace::Annotation::SERVER_RECV)
       span.record('whitelisted') if zipkin_env.force_sample?
       status, headers, body = yield
@@ -49,8 +57,16 @@ module ZipkinTracer
       span.record(Trace::Annotation::SERVER_SEND)
     end
 
-    def trace_request_information(span, env)
-      span.record_tag(Trace::BinaryAnnotation::PATH, env['PATH_INFO'])
+    def trace_request_information(span, zipkin_env)
+      tags = if !@config.record_on_server_receive.empty?
+        # if the user specified tags to record on server receive, use these no matter what
+        @config.record_on_server_receive
+      elsif !zipkin_env.called_with_zipkin_headers?
+        # if the request comes from a non zipkin-enabled source record the default tags
+        DEFAULT_SERVER_RECV_TAGS
+      end
+      return if tags.nil?
+      tags.each { |annotation_key, env_key| span.record_tag(annotation_key, zipkin_env.env[env_key]) }
     end
   end
 end

data/lib/zipkin-tracer/version.rb

@@ -1,3 +1,3 @@
 module ZipkinTracer
-  VERSION = '0.21.2'.freeze
+  VERSION = '0.22.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.21.2
+  version: 0.22.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-30 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -147,14 +147,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '3.0'
 description: Adds tracing instrumentation for ruby applications
 email:
 - franklin@twitter.com