zipkin-tracer 0.27.2.1 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b9286e346ac3ab6cb9cded254eeb3df0117241e4c07d252f3e5c9b15f7067c2
-  data.tar.gz: aa0102da08828fb648582fe55b907630a6d73631480d816dd59ea475fd31ffd6
+  metadata.gz: 1fd814c00e7d43bd9fbd4678181407182904b369759f480c4334060f0de76a7b
+  data.tar.gz: 207b8aba87d59166639646babb7c86d174a9880bca955e0e4a3e7d67ed40f49c
 SHA512:
-  metadata.gz: ffc2fdfa24cf887da6e588490f4b9329bf971f10d61923f36b89a12942c602147b8700beec988a94882767c27764116f5c6eb5584bf03777c4d4c938ff282828
-  data.tar.gz: bfc03ce3b379fa40e8da2a30029f3780a6681306848f6e11a468c24d2eb03f443bd4694dc8a1bccbf11a1ac6e7e355637b6b492ead9b54a3f5d022deebb2f6bd
+  metadata.gz: bd5ff092a5b46f170a6978cdf5e88c2239e35abafb7b7c8d00a29cf9eaa007549dc18a15eb4e3172ec3152e4a2a12d589173e42f7d7fc405384defd8505ea6b2
+  data.tar.gz: f9fece44e302cac6ede9a0023b5ab68683bef98cd300bc978998d403d9a8f528068c4f184fb3e69dcb4fae1c22bf5f47f26b7e6749bf2bba09a3c47df1445300

data/lib/zipkin-tracer/config.rb

@@ -9,7 +9,7 @@ module ZipkinTracer
       :zookeeper, :sample_rate, :logger, :log_tracing,
       :annotate_plugin, :filter_plugin, :whitelist_plugin,
       :sampled_as_boolean, :record_on_server_receive,
-      :kafka_producer, :kafka_topic
+      :kafka_producer, :kafka_topic, :trace_id_128bit
 
     def initialize(app, config_hash)
       config = config_hash || Application.config(app)
@@ -46,7 +46,14 @@ module ZipkinTracer
       # 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])
 
+      # When set to true, high 8-bytes will be prepended to trace_id.
+      # The upper 4-bytes are epoch seconds and the lower 4-bytes are random.
+      # This makes it convertible to Amazon X-Ray trace ID format v1.
+      # (See http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-request-tracing.html)
+      @trace_id_128bit = config[:trace_id_128bit].nil? ? DEFAULTS[:trace_id_128bit] : config[:trace_id_128bit]
+
       Trace.sample_rate = @sample_rate
+      Trace.trace_id_128bit = @trace_id_128bit
     end
 
     def adapter
@@ -68,7 +75,8 @@ module ZipkinTracer
     DEFAULTS = {
       sample_rate: 0.1,
       service_port: 80,
-      sampled_as_boolean: true
+      sampled_as_boolean: true,
+      trace_id_128bit: false
     }
 
     def parse_tags(tag_names)

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

@@ -34,7 +34,8 @@ module ZipkinTracer
         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
+        span_id = Trace.generate_id
+        trace_id = TraceGenerator.new.generate_id_from_span_id(span_id)
         parent_span_id = nil
       end
       [trace_id, span_id, parent_span_id]

data/lib/zipkin-tracer/trace.rb

@@ -3,6 +3,7 @@ require 'zipkin-tracer/zipkin_tracer_base'
 # Module with a mix of functions and overwrites from the finagle implementation:
 # https://github.com/twitter/finagle/blob/finagle-6.39.0/finagle-thrift/src/main/ruby/lib/finagle-thrift/trace.rb
 module Trace
+  attr_accessor :trace_id_128bit
 
   # We need this to access the tracer from the Faraday middleware.
   def self.tracer
@@ -19,7 +20,7 @@ module Trace
     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)
+      @trace_id = Trace.trace_id_128bit ? TraceId128Bit.from_value(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
@@ -44,6 +45,39 @@ module Trace
     end
   end
 
+  # This class is the 128-bit version of the SpanId class:
+  # https://github.com/twitter/finagle/blob/finagle-6.39.0/finagle-thrift/src/main/ruby/lib/finagle-thrift/trace.rb#L102
+  class TraceId128Bit < SpanId
+    HEX_REGEX_16 = /^[a-f0-9]{16}$/i
+    HEX_REGEX_32 = /^[a-f0-9]{32}$/i
+    MAX_SIGNED_I128 = (2 ** 128 / 2) -1
+    MASK = (2 ** 128) - 1
+
+    def self.from_value(v)
+      if v.is_a?(String) && v =~ HEX_REGEX_16
+        SpanId.new(v.hex)
+      elsif v.is_a?(String) && v =~ HEX_REGEX_32
+        new(v.hex)
+      elsif v.is_a?(Numeric)
+        new(v)
+      elsif v.is_a?(SpanId)
+        v
+      end
+    end
+
+    def initialize(value)
+      @value = value
+      @i128 = if @value > MAX_SIGNED_I128
+        -1 * ((@value ^ MASK) + 1)
+      else
+        @value
+      end
+    end
+
+    def to_s; '%032x' % @value; end
+    def to_i; @i128; 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/trace_generator.rb

@@ -12,20 +12,38 @@ module ZipkinTracer
 
     def generate_trace_id
       span_id = generate_id
-      Trace::TraceId.new(span_id, nil, span_id, should_sample?.to_s, Trace::Flags::EMPTY)
+      Trace::TraceId.new(generate_id_from_span_id(span_id), nil, span_id, should_sample?.to_s, Trace::Flags::EMPTY)
     end
 
     def should_sample?
       rand < (Trace.sample_rate || DEFAULT_SAMPLE_RATE)
     end
 
+    def generate_id_from_span_id(span_id)
+      Trace.trace_id_128bit ? generate_id_128bit(span_id) : span_id
+    end
+
     private
 
     def generate_id
       rand(TRACE_ID_UPPER_BOUND)
     end
 
+    def generate_id_128bit(span_id)
+      trace_id_low_64bit = '%016x' % span_id
+      "#{trace_id_epoch_seconds}#{trace_id_high_32bit}#{trace_id_low_64bit}".hex
+    end
+
+    def trace_id_epoch_seconds
+      '%08x' % Time.now.to_i
+    end
+
+    def trace_id_high_32bit
+      '%08x' % rand(TRACE_ID_HIGH_32BIT_UPPER_BOUND)
+    end
+
     TRACE_ID_UPPER_BOUND = 2**64
+    TRACE_ID_HIGH_32BIT_UPPER_BOUND = 2**32
     DEFAULT_SAMPLE_RATE = 0.001
   end
 end

data/lib/zipkin-tracer/version.rb

@@ -1,3 +1,3 @@
 module ZipkinTracer
-  VERSION = '0.27.2.1'.freeze
+  VERSION = '0.28.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.27.2.1
+  version: 0.28.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -207,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby tracing via Zipkin