zipkin-tracer 0.18.6 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 640394dff893e81ed21749a900121b2ba2e4e561
-  data.tar.gz: b8c43ed22fedb058687ffe896568bc5b449c60f0
+  metadata.gz: fada20597d32e18a27712d3031e895f28212c637
+  data.tar.gz: b57584551882c44615be24783c3ea30fb9e8604b
 SHA512:
-  metadata.gz: ee7ac9cf049925e4df24488c43878638455bb83d620a0b800f6bcf8b304149b769c726b1fcad33a317b1aed1ac1ef73a701f158ced48b6845f4b6b6f8ad124c9
-  data.tar.gz: 7df178c307215876cae40df7d8ade1e67676bf1c58c68a105f6bb2542a1048e6de71d584eeae5f9a40b420250ee3f77ccfeccc718f9630628cf20c626ecee7f6
+  metadata.gz: 906d2105340d18be042320a3a7d1168e1efb417dd1dc1099fb62a16954c7791aef587e4823df19a688bafc3e4405056e996761a49b40f4bc11a284799bf370b7
+  data.tar.gz: 321783d91739fb623f511d0bb0cff16341f0095282e76ffac91389c5d5b00219fb801775a9908ea0da760dd354fab053a12a687be83e3cb58453eac137b3660d

data/lib/zipkin-tracer/config.rb

@@ -6,20 +6,39 @@ module ZipkinTracer
   class Config
     attr_reader :service_name, :service_port, :json_api_host,
       :zookeeper, :sample_rate, :logger, :log_tracing,
-      :annotate_plugin, :filter_plugin, :whitelist_plugin
+      :annotate_plugin, :filter_plugin, :whitelist_plugin,
+      :sampled_as_boolean
 
     def initialize(app, config_hash)
       config = config_hash || Application.config(app)
+      # The name of the current service
       @service_name      = config[:service_name]
+      # The port where the current service is running
       @service_port      = config[:service_port]      || DEFAULTS[:service_port]
+      # The address of the Zipkin server which we will send traces to
       @json_api_host     = config[:json_api_host]
+      # Zookeeper information
       @zookeeper         = config[:zookeeper]
+      # Percentage of traces which by default this service traces (as float, 1.0 means 100%)
       @sample_rate       = config[:sample_rate]       || DEFAULTS[:sample_rate]
+      # A block of code which can be called to do extra annotations of traces
       @annotate_plugin   = config[:annotate_plugin]   # call for trace annotation
       @filter_plugin     = config[:filter_plugin]     # skip tracing if returns false
       @whitelist_plugin  = config[:whitelist_plugin]  # force sampling if returns true
+      # A block of code which can be called to skip traces. Skip tracing if returns false
+      @filter_plugin     = config[:filter_plugin]
+      # 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
+      @sampled_as_boolean = config[:sampled_as_boolean] || DEFAULTS[:sampled_as_boolean]
+      # The current default is true for compatibility but services are encouraged to move on.
+      if @sampled_as_boolean
+        @logger && @logger.warn("Using a boolean in the Sampled header is deprecated. Consider setting sampled_as_boolean to false")
+      end
     end
 
     def adapter
@@ -38,7 +57,8 @@ module ZipkinTracer
 
     DEFAULTS = {
       sample_rate: 0.1,
-      service_port: 80
+      service_port: 80,
+      sampled_as_boolean: true
     }
 
     def present?(str)

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

@@ -83,9 +83,9 @@ module ZipkinTracer
                              @env.values_at(*B3_REQUIRED_HEADERS)
                            else
                              new_id = Trace.generate_id
-                             [new_id, nil, new_id]
+                             [new_id, nil, new_id, nil]
                            end
-        trace_parameters[3] = should_trace?(trace_parameters[3])
+        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
 
@@ -102,15 +102,28 @@ module ZipkinTracer
 
       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 should_trace?(parent_trace_sampled)
+      def sampled_header_value(parent_trace_sampled)
         if parent_trace_sampled  # A service upstream decided this goes in all the way
-          parent_trace_sampled == 'true'
+          parent_trace_sampled
         else
-          force_sample? || current_trace_sampled? && !filtered?
+          new_sampled_header_value(force_sample? || current_trace_sampled? && !filtered?)
         end
       end
 

data/lib/zipkin-tracer/trace.rb

@@ -15,6 +15,37 @@ module Trace
     self.pop
   end
 
+  # A TraceId contains all the information of a given trace id
+  # This class is defined in finagle-thrift. We are overwriting it here
+  class TraceId
+    attr_reader :trace_id, :parent_id, :span_id, :sampled, :flags
+
+    def initialize(trace_id, parent_id, span_id, sampled, flags)
+      @trace_id = SpanId.from_value(trace_id)
+      @parent_id = parent_id.nil? ? nil : SpanId.from_value(parent_id)
+      @span_id = SpanId.from_value(span_id)
+      @sampled = sampled
+      @flags = flags
+    end
+
+    def next_id
+      TraceId.new(@trace_id, @span_id, Trace.generate_id, @sampled, @flags)
+    end
+
+    # the debug flag is used to ensure the trace passes ALL samplers
+    def debug?
+      @flags & Flags::DEBUG == Flags::DEBUG
+    end
+
+    def sampled?
+      debug? || ['1', 'true'].include?(@sampled)
+    end
+
+    def to_s
+      "TraceId(trace_id = #{@trace_id.to_s}, parent_id = #{@parent_id.to_s}, span_id = #{@span_id.to_s}, sampled = #{@sampled.to_s}, flags = #{@flags.to_s})"
+    end
+  end
+
   # A span may contain many annotations
   # This class is defined in finagle-thrift. We are adding extra methods here
   class Span

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.18.6'.freeze
+  VERSION = '0.19.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.18.6
+  version: 0.19.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2016-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -35,14 +35,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement