zipkin-tracer 0.19.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fada20597d32e18a27712d3031e895f28212c637
-  data.tar.gz: b57584551882c44615be24783c3ea30fb9e8604b
+  metadata.gz: 4657331271ed370854d23b33e9980047aeded135
+  data.tar.gz: 57ffc30cb2d965e4d4a257de2dbcf3d944e447e4
 SHA512:
-  metadata.gz: 906d2105340d18be042320a3a7d1168e1efb417dd1dc1099fb62a16954c7791aef587e4823df19a688bafc3e4405056e996761a49b40f4bc11a284799bf370b7
-  data.tar.gz: 321783d91739fb623f511d0bb0cff16341f0095282e76ffac91389c5d5b00219fb801775a9908ea0da760dd354fab053a12a687be83e3cb58453eac137b3660d
+  metadata.gz: 42b879ff2bc2dff5106025e0639bfc6b3f87e63e8de628cd88e2d8e2ca9e22f6396aadfae57e469816b4f0e44c39d6ae30b26d6a6217d3894fd2bcc2067985ae
+  data.tar.gz: a8b99ee0c3edbbade8f4812c3b02353b99c24acaaaa6e29f2bf4d63eee0b205a5bab079adc124f417544ec81bce5463b3c5707ba4383871063513eb2eb5ad826

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

@@ -15,15 +15,12 @@ require 'finagle-thrift/trace'
 require 'finagle-thrift/tracer'
 require 'zipkin-tracer/config'
 require 'zipkin-tracer/tracer_factory'
+require 'zipkin-tracer/rack/zipkin_env'
 
 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
-    B3_REQUIRED_HEADERS = %w[HTTP_X_B3_TRACEID HTTP_X_B3_PARENTSPANID HTTP_X_B3_SPANID HTTP_X_B3_SAMPLED].freeze
-    B3_OPT_HEADERS = %w[HTTP_X_B3_FLAGS].freeze
-
     def initialize(app, config = nil)
       @app = app
       @config = Config.new(app, config).freeze
@@ -37,7 +34,7 @@ module ZipkinTracer
         if !trace_id.sampled? || !routable_request?(env)
           @app.call(env)
         else
-          @tracer.with_new_span(trace_id, zipkin_env.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
@@ -55,7 +52,7 @@ module ZipkinTracer
     end
 
     def trace!(span, zipkin_env, &block)
-      #if called by a service, the caller already added the information
+      # 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?
       span.record(Trace::Annotation::SERVER_RECV)
       span.record('whitelisted') if zipkin_env.force_sample?
@@ -68,69 +65,5 @@ module ZipkinTracer
     def trace_request_information(span, env)
       span.record_tag(Trace::BinaryAnnotation::PATH, env['PATH_INFO'])
     end
-
-    # Environment with Zipkin information in it
-    class ZipkinEnv
-      attr_reader :env
-
-      def initialize(env, config)
-        @env    = env
-        @config = config
-      end
-
-      def trace_id(default_flags = Trace::Flags::EMPTY)
-        trace_parameters = if called_with_zipkin_headers?
-                             @env.values_at(*B3_REQUIRED_HEADERS)
-                           else
-                             new_id = Trace.generate_id
-                             [new_id, nil, new_id, nil]
-                           end
-        trace_parameters[3] = sampled_header_value(trace_parameters[3])
-        trace_parameters += @env.values_at(*B3_OPT_HEADERS) # always check flags
-        trace_parameters[4] = (trace_parameters[4] || default_flags).to_i
-
-        Trace::TraceId.new(*trace_parameters)
-      end
-
-      def called_with_zipkin_headers?
-        @called_with_zipkin_headers ||= B3_REQUIRED_HEADERS.all? { |key| @env.has_key?(key) }
-      end
-
-      def force_sample?
-        @force_sample ||= @config.whitelist_plugin && @config.whitelist_plugin.call(@env)
-      end
-
-      private
-
-      def new_sampled_header_value(sampled)
-         case [@config.sampled_as_boolean, sampled]
-         when [true, true]
-           'true'
-         when [true, false]
-           'false'
-         when [false, true]
-           '1'
-         when [false, false]
-           '0'
-         end
-      end
-
-      def current_trace_sampled?
-        rand < @config.sample_rate
-      end
-
-      def sampled_header_value(parent_trace_sampled)
-        if parent_trace_sampled  # A service upstream decided this goes in all the way
-          parent_trace_sampled
-        else
-          new_sampled_header_value(force_sample? || current_trace_sampled? && !filtered?)
-        end
-      end
-
-      def filtered?
-        @config.filter_plugin && !@config.filter_plugin.call(@env)
-      end
-    end
-
   end
 end

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

@@ -0,0 +1,72 @@
+module ZipkinTracer
+  # This class manages the Zipkin related information in the Rack environment.
+  # It is only used by the rack middleware.
+  class ZipkinEnv
+    attr_reader :env
+
+    def initialize(env, config)
+      @env    = env
+      @config = config
+    end
+
+    def trace_id(default_flags = Trace::Flags::EMPTY)
+      trace_id, span_id, parent_span_id = retrieve_or_generate_ids
+      sampled = sampled_header_value(@env['HTTP_X_B3_SAMPLED'])
+      flags = (@env['HTTP_X_B3_FLAGS'] || default_flags).to_i
+      Trace::TraceId.new(trace_id, parent_span_id, span_id, sampled, flags)
+    end
+
+    def called_with_zipkin_headers?
+      @called_with_zipkin_headers ||= B3_REQUIRED_HEADERS.all? { |key| @env.key?(key) }
+    end
+
+    def force_sample?
+      @force_sample ||= @config.whitelist_plugin && @config.whitelist_plugin.call(@env)
+    end
+
+    private
+
+    B3_REQUIRED_HEADERS = %w(HTTP_X_B3_TRACEID HTTP_X_B3_SPANID).freeze
+    B3_OPT_HEADERS = %w(HTTP_X_B3_PARENTSPANID HTTP_X_B3_SAMPLED HTTP_X_B3_FLAGS).freeze
+
+    def retrieve_or_generate_ids
+      if called_with_zipkin_headers?
+        trace_id, span_id = @env.values_at(*B3_REQUIRED_HEADERS)
+        parent_span_id = @env['HTTP_X_B3_PARENTSPANID']
+      else
+        trace_id = span_id = Trace.generate_id
+        parent_span_id = nil
+      end
+      [trace_id, span_id, parent_span_id]
+    end
+
+    def new_sampled_header_value(sampled)
+      case [@config.sampled_as_boolean, sampled]
+      when [true, true]
+        'true'
+      when [true, false]
+        'false'
+      when [false, true]
+        '1'
+      when [false, false]
+        '0'
+      end
+    end
+
+    def current_trace_sampled?
+      rand < @config.sample_rate
+    end
+
+    def sampled_header_value(parent_trace_sampled)
+      if parent_trace_sampled  # A service upstream decided this goes in all the way
+        parent_trace_sampled
+      else
+        new_sampled_header_value(force_sample? || current_trace_sampled? && !filtered?)
+      end
+    end
+
+    def filtered?
+      @config.filter_plugin && !@config.filter_plugin.call(@env)
+    end
+  end
+end

data/lib/zipkin-tracer/version.rb

@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module ZipkinTracer
-  VERSION = '0.19.0'.freeze
+  VERSION = '0.19.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.19.1
 platform: ruby
 authors:
 - Franklin Hu
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-26 00:00:00.000000000 Z
+date: 2016-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -159,6 +159,7 @@ files:
 - lib/zipkin-tracer/faraday/zipkin-tracer.rb
 - lib/zipkin-tracer/hostname_resolver.rb
 - lib/zipkin-tracer/rack/zipkin-tracer.rb
+- lib/zipkin-tracer/rack/zipkin_env.rb
 - lib/zipkin-tracer/trace.rb
 - lib/zipkin-tracer/trace_client.rb
 - lib/zipkin-tracer/tracer_factory.rb