zipkin-tracer 0.40.1 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fb27433f11b9d5dfc9cc09817d1305d95b2445ab2f38b2e214e3ada541f8fed
-  data.tar.gz: '09d6e7cf7a2c34116e6d583c8143dbad1026638947167d8274ad8f4094c2368d'
+  metadata.gz: fe7fb284e2e5c8aef9203ab72d41403481835e5def3b07d847e80d21ed88a653
+  data.tar.gz: d4e8dedf195a458910af20a913f9c29256df653056cd848e6a00140be212a5ba
 SHA512:
-  metadata.gz: a6d424dd4b62b267c21aa57bf3ea245f3fab6e006128da2de8d32a013587aa0691240451c908263e81c7de50dd382f068376faa35c2b8ca84b15176cd27db35a
-  data.tar.gz: 7ecaf86d01df64132cd59aa58b22010a88a687d6f7813fd252b5c5369b8b914da54f2e97aabb8f5011e8ce44bb797aa0fae8d051ca20e3c16ff48720390e2946
+  metadata.gz: a8212bd6eec326a0066b5a9074a0567efd92f7ad5bbad9f88a5d7ecc0d5a607f25aaa96f9fba829fdc574c5fefb9e726763fd4a838f8551d35e744620c07e50a
+  data.tar.gz: b7f334ab931fdc97d379ed46d199d54860dfbaf7413afa5ade8c99a9c048552338f6d3655849e6855783b54d08ef6231804368271fd79672d63e654c88371ee5

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.41.0
+* Add support for writing B3 single header.
+* Omit ParentSpanId header for root spans.
+
+# 0.40.1
+* Fix to pass `async` option to the HTTP sender.
+
 # 0.40.0
 * Add support for reading B3 single header.
 

data/README.md

@@ -24,6 +24,7 @@ use ZipkinTracer::RackHandler, config
 * `:trace_id_128bit` - 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)
 * `:async` - By default senders will flush traces asynchronously. Set to `false` to make that process synchronous. Only supported by the HTTP, RabbitMQ, and SQS senders.
 * `:logger` - The default logger for Rails apps is `Rails.logger`, else it is `STDOUT`. Use this option to pass a custom logger.
+* `:write_b3_single_format` - When set to true, only writes a single b3 header for outbound propagation.
 
 #### Sender specific
 * `:json_api_host` - Hostname with protocol of a zipkin api instance (e.g. `https://zipkin.example.com`) to use the HTTP sender

data/lib/zipkin-tracer.rb

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

data/lib/zipkin-tracer/config.rb

@@ -8,7 +8,7 @@ module ZipkinTracer
     attr_reader :service_name, :sample_rate, :sampled_as_boolean, :trace_id_128bit, :async, :logger,
       :json_api_host, :zookeeper, :kafka_producer, :kafka_topic, :sqs_queue_name, :sqs_region, :log_tracing,
       :annotate_plugin, :filter_plugin, :whitelist_plugin, :rabbit_mq_connection, :rabbit_mq_exchange,
-      :rabbit_mq_routing_key
+      :rabbit_mq_routing_key, :write_b3_single_format
 
     def initialize(app, config_hash)
       config = config_hash || Application.config(app)
@@ -53,9 +53,13 @@ module ZipkinTracer
       # 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]
+      # When set to true, only writes a single b3 header for outbound propagation.
+      @write_b3_single_format =
+        config[:write_b3_single_format].nil? ? DEFAULTS[:write_b3_single_format] : config[:write_b3_single_format]
 
       Trace.sample_rate = @sample_rate
       Trace.trace_id_128bit = @trace_id_128bit
+      Trace.write_b3_single_format = @write_b3_single_format
 
       Trace.default_endpoint = Trace::Endpoint.local_endpoint(
         domain_service_name(@service_name)
@@ -91,7 +95,8 @@ module ZipkinTracer
     DEFAULTS = {
       sample_rate: 0.1,
       sampled_as_boolean: true,
-      trace_id_128bit: false
+      trace_id_128bit: false,
+      write_b3_single_format: false
     }
 
     def present?(str)

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

@@ -3,6 +3,8 @@ require 'excon'
 
 module ZipkinTracer
   class ExconHandler < Excon::Middleware::Base
+    include B3HeaderHelper
+
     def initialize(_)
       super
     end
@@ -15,10 +17,7 @@ module ZipkinTracer
       trace_id = TraceGenerator.new.next_trace_id
 
       TraceContainer.with_trace_id(trace_id) do
-        b3_headers.each do |method, header|
-          datum[:headers][header] = trace_id.send(method).to_s
-        end
-
+        set_b3_header(datum[:headers], trace_id)
         trace!(datum, trace_id) if Trace.tracer && trace_id.sampled?
       end
 
@@ -36,16 +35,6 @@ module ZipkinTracer
 
     private
 
-    def b3_headers
-      {
-        trace_id: 'X-B3-TraceId',
-        parent_id: 'X-B3-ParentSpanId',
-        span_id: 'X-B3-SpanId',
-        sampled: 'X-B3-Sampled',
-        flags: 'X-B3-Flags'
-      }
-    end
-
     def remote_endpoint(url, service_name)
       Trace::Endpoint.remote_endpoint(url, service_name) # The endpoint we are calling.
     end

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

@@ -4,6 +4,8 @@ require 'uri'
 module ZipkinTracer
   # Faraday middleware. It will add CR/CS annotations to outgoing connections done by Faraday
   class FaradayHandler < ::Faraday::Middleware
+    include B3HeaderHelper
+
     def initialize(app, service_name = nil)
       @app = app
       @service_name = service_name
@@ -12,9 +14,7 @@ module ZipkinTracer
     def call(env)
       trace_id = TraceGenerator.new.next_trace_id
       TraceContainer.with_trace_id(trace_id) do
-        b3_headers.each do |method, header|
-          env[:request_headers][header] = trace_id.send(method).to_s
-        end
+        set_b3_header(env[:request_headers], trace_id)
         if Trace.tracer && trace_id.sampled?
           trace!(env, trace_id)
         else
@@ -25,16 +25,6 @@ module ZipkinTracer
 
     private
 
-    def b3_headers
-      {
-        trace_id: 'X-B3-TraceId',
-        parent_id: 'X-B3-ParentSpanId',
-        span_id: 'X-B3-SpanId',
-        sampled: 'X-B3-Sampled',
-        flags: 'X-B3-Flags'
-      }
-    end
-
     def trace!(env, trace_id)
       response = nil
       # handle either a URI object (passed by Faraday v0.8.x in testing), or something string-izable

data/lib/zipkin-tracer/trace.rb

@@ -8,7 +8,7 @@ module Trace
   # Most of these are set by the config class and then used around.
   # TODO: Move this out of the Trace module , take out that extend self and be happier
   extend self
-  attr_accessor :trace_id_128bit
+  attr_accessor :trace_id_128bit, :write_b3_single_format
 
   # This method is deprecated, please use TraceGenerator.current
   # Note that this method will always return a trace, it will

data/lib/zipkin-tracer/version.rb

@@ -1,3 +1,3 @@
 module ZipkinTracer
-  VERSION = '0.40.1'.freeze
+  VERSION = '0.41.0'.freeze
 end

data/lib/zipkin-tracer/zipkin_b3_header_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ZipkinTracer
+  module B3HeaderHelper
+    private
+
+    B3_SINGLE_HEADER = 'b3'
+
+    def set_b3_header(headers, trace_id)
+      if Trace.write_b3_single_format
+        headers[B3_SINGLE_HEADER] = B3SingleHeaderFormat.create_header(trace_id)
+      else
+        b3_headers.each do |method, header|
+          header_value = trace_id.send(method).to_s
+          headers[header] = header_value unless header_value.empty?
+        end
+      end
+    end
+
+    def b3_headers
+      {
+        trace_id: 'X-B3-TraceId',
+        parent_id: 'X-B3-ParentSpanId',
+        span_id: 'X-B3-SpanId',
+        sampled: 'X-B3-Sampled',
+        flags: 'X-B3-Flags'
+      }
+    end
+  end
+end

data/lib/zipkin-tracer/zipkin_b3_single_header_format.rb

@@ -5,6 +5,10 @@ module ZipkinTracer
   # 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
+    SAMPLED = '1'
+    NOT_SAMPLED = '0'
+    DEBUG = 'd'
+
     def self.parse_from_header(b3_single_header)
       if b3_single_header.size == 1
         flag = b3_single_header
@@ -16,13 +20,19 @@ module ZipkinTracer
 
     def self.parse_sampled(flag)
       case flag
-      when '1', '0'
+      when SAMPLED, NOT_SAMPLED
         flag
       end
     end
 
     def self.parse_flags(flag)
-      flag == 'd' ? Trace::Flags::DEBUG : Trace::Flags::EMPTY
+      flag == DEBUG ? Trace::Flags::DEBUG : Trace::Flags::EMPTY
+    end
+
+    def self.create_header(trace_id)
+      flag = trace_id.debug? ? DEBUG : (trace_id.sampled? ? SAMPLED : NOT_SAMPLED)
+      parent_id_with_hyphen = "-#{trace_id.parent_id}" unless trace_id.parent_id.nil?
+      "#{trace_id.trace_id}-#{trace_id.span_id}-#{flag}#{parent_id_with_hyphen}"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.40.1
+  version: 0.41.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -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_header_helper.rb
 - lib/zipkin-tracer/zipkin_b3_single_header_format.rb
 - lib/zipkin-tracer/zipkin_http_sender.rb
 - lib/zipkin-tracer/zipkin_kafka_sender.rb