zipkin-tracer 0.39.2 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b824d605a7ca0b7a7022d356e70361ad627a633883d252119bc6b66c10196577
-  data.tar.gz: d9446b59c3dabef034d47b81c2b98bee94bb03dc0a8cb3fa5c73888b6d7ce0a6
+  metadata.gz: 89503d98e1ff564251c21bcd3f80b3e03f166ed440ddc2515a19b5feea4bf8a4
+  data.tar.gz: ac25d751311eac11ef50f7c2fcae652b1e7dc2c32c036150d9dce898a514a2ba
 SHA512:
-  metadata.gz: fe9a5451b3534373e95a624fa46cdb431f4e8e1de69330115d806dec45e0bcf5c7f86f6c6309b4bc87bb9549bee1cf49973be95ebc945e417e49c94d3c1bc23f
-  data.tar.gz: 5cea09da7bbcb379b5e96903639b52a70dd046cc8e62df771667c5d7e062256678fe747bc5ecc107a9ada69832f17e84b5301a68a2b5f662d3341102c74165e9
+  metadata.gz: 5a8edaaf8193c5ad52e3840b354813960b4fbe81e731ab1c220cb3d2e2bf50f6b3e0d258916584a186bbdb4aac8520e538ddc92154c3ce74d8877050256d4230
+  data.tar.gz: 465f582f1ec8438c6ca8d03546229f2fdad1b8975264dc55cf0cbcdd9984095cfad90834a64c6c9ecde55222e6e0495bb69a25d9cb9cb202a36046f3bed300ba

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.40.0
+* Add support for reading B3 single header.
+
 # 0.39.2
 * Make Faraday 0.13 the minimum requirement.
 

data/lib/zipkin-tracer.rb

@@ -5,6 +5,7 @@ require 'zipkin-tracer/trace_client'
 require 'zipkin-tracer/trace_container'
 require 'zipkin-tracer/trace_generator'
 require 'zipkin-tracer/trace_wrapper'
+require 'zipkin-tracer/zipkin_b3_single_header_format'
 
 begin
   require 'faraday'

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

@@ -10,33 +10,44 @@ module ZipkinTracer
     end
 
     def trace_id(default_flags = Trace::Flags::EMPTY)
-      trace_id, span_id, parent_span_id, shared = retrieve_or_generate_ids
-      sampled = sampled_header_value(@env['HTTP_X_B3_SAMPLED'])
-      flags = (@env['HTTP_X_B3_FLAGS'] || default_flags).to_i
+      trace_id, span_id, parent_span_id, sampled, flags, shared = retrieve_or_generate_ids
+      sampled = sampled_header_value(sampled)
+      flags = (flags || default_flags).to_i
       Trace::TraceId.new(trace_id, parent_span_id, span_id, sampled, flags, shared)
     end
 
+    def called_with_zipkin_b3_single_header?
+      @called_with_zipkin_b3_single_header ||= @env.key?(B3_SINGLE_HEADER)
+    end
+
     def called_with_zipkin_headers?
       @called_with_zipkin_headers ||= B3_REQUIRED_HEADERS.all? { |key| @env.key?(key) }
     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
+    B3_SINGLE_HEADER = 'HTTP_B3'.freeze
+    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']
+      if called_with_zipkin_b3_single_header?
+        trace_id, span_id, parent_span_id, sampled, flags =
+          B3SingleHeaderFormat.parse_from_header(@env[B3_SINGLE_HEADER])
         shared = true
-      else
+      elsif called_with_zipkin_headers?
+        trace_id, span_id, parent_span_id, sampled, flags = @env.values_at(*B3_REQUIRED_HEADERS, *B3_OPT_HEADERS)
+        shared = true
+      end
+
+      unless trace_id
         span_id = TraceGenerator.new.generate_id
         trace_id = TraceGenerator.new.generate_id_from_span_id(span_id)
         parent_span_id = nil
         shared = false
       end
-      [trace_id, span_id, parent_span_id, shared]
+
+      [trace_id, span_id, parent_span_id, sampled, flags, shared]
     end
 
     def new_sampled_header_value(sampled)

data/lib/zipkin-tracer/version.rb

@@ -1,3 +1,3 @@
 module ZipkinTracer
-  VERSION = '0.39.2'.freeze
+  VERSION = '0.40.0'.freeze
 end

data/lib/zipkin-tracer/zipkin_b3_single_header_format.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ZipkinTracer
+  # This format corresponds to the propagation key "b3" (or "B3").
+  # b3: {x-b3-traceid}-{x-b3-spanid}-{if x-b3-flags 'd' else x-b3-sampled}-{x-b3-parentspanid}
+  # For details, see: https://github.com/openzipkin/b3-propagation
+  class B3SingleHeaderFormat
+    def self.parse_from_header(b3_single_header)
+      if b3_single_header.size == 1
+        flag = b3_single_header
+      else
+        trace_id, span_id, flag, parent_span_id = b3_single_header.split('-')
+      end
+      [trace_id, span_id, parent_span_id, parse_sampled(flag), parse_flags(flag)]
+    end
+
+    def self.parse_sampled(flag)
+      case flag
+      when '1', '0'
+        flag
+      end
+    end
+
+    def self.parse_flags(flag)
+      flag == 'd' ? Trace::Flags::DEBUG : Trace::Flags::EMPTY
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.39.2
+  version: 0.40.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-26 00:00:00.000000000 Z
+date: 2019-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -225,6 +225,7 @@ files:
 - lib/zipkin-tracer/trace_wrapper.rb
 - lib/zipkin-tracer/tracer_factory.rb
 - lib/zipkin-tracer/version.rb
+- lib/zipkin-tracer/zipkin_b3_single_header_format.rb
 - lib/zipkin-tracer/zipkin_http_sender.rb
 - lib/zipkin-tracer/zipkin_kafka_sender.rb
 - lib/zipkin-tracer/zipkin_logger_sender.rb