lightstep 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e9f8988ff2ee9b867440d0fee9aa30357df0aed33e5daa92c48e338ad386624
-  data.tar.gz: dea73009fd576d64f80efac982533e8b1291bb8c45cf580430f36bd188eac60f
+  metadata.gz: 2fbca3799da8034df47aa8f310c16da459bcf5492500330576c81c4f0df63615
+  data.tar.gz: 7711d6bdac49561ab320f9a0f77de98fd9d6b2140daf0506ac3c51f0ec5da0cb
 SHA512:
-  metadata.gz: be197fd10bfd6fc23bbc41e1016749ce7bac73149e57830a83ffc81a4bbed964e4dcdbb326cfde1dd2e75335e9ece218e77749536c5cb7ec6f246762013266aa
-  data.tar.gz: 84d6dcbfbddb2b3fe7bfc4c88bbd43435ca8a50ae818b07752a7961dfa173d492f80ff0b4c0e95e1460cd32a3385a6a41288af0f5e13ce35df838ba3bca6c4fd
+  metadata.gz: e7943954fd04df21d5d7cf3fc5153374bf8e1f6d49a836da52b193bd727b3c0d4e085bd4612867f2ca4df259d6bc48e6a315626986298b2911309125e2bc07cd
+  data.tar.gz: e6f70b42fd03866cd00b845727a1765e0d04a49e67bd2c1da61cb23402eeda6d0a3443786d51bd3a7523a69eaecdfc875b429cb981f6e01bb541498fd60c7686

data/CHANGELOG.md

@@ -4,9 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v0.16.0
+### Added
+- The tracer now supports B3 context propagation. Propagation can be set by using the `propagator` keyword argument to `LightStep.configure`. Valid values are `:lightstep` (default), and `:b3`.
+
 ## v0.15.1
 ### Fixed
-- The tracer now supports B3 context propagation. Propagation can be set by using the `propagator` keyword argument to `LightStep.configure`. Valid values are `:lightstep` (default), and `:b3`.
 - The tracer now closes the active scope or finishes the active span even if an error is raised from the yielded code.
 
 ### Unreleased

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lightstep (0.15.1)
+    lightstep (0.16.0)
       concurrent-ruby (~> 1.0)
       opentracing (~> 0.5.0)
 

data/README.md

@@ -27,6 +27,9 @@ Or install it yourself as:
     # Initialize the singleton tracer
     LightStep.configure(component_name: 'lightstep/ruby/example', access_token: 'your_access_token')
 
+    # Specify a propagation format (options are :lightstep (default) and :b3)
+    LightStep.configure(component_name: 'lightstep/ruby/example', access_token: 'your_access_token', propagator: :b3)
+
     # Create a basic span and attach a log to the span
     span = LightStep.start_span('my_span')
     span.log(event: 'hello world', count: 42)

data/lib/lightstep/propagation.rb

@@ -6,14 +6,15 @@ require 'lightstep/propagation/b3_propagator'
 module LightStep
   module Propagation
     PROPAGATOR_MAP = {
-      lightstep: LightStepPropagator
+      lightstep: LightStepPropagator,
+      b3: B3Propagator
     }
 
     class << self
       # Constructs a propagator instance from the given propagator name. If the
       # name is unknown returns the LightStepPropagator as a default
       #
-      # @param [Symbol, String] propagator_name
+      # @param [Symbol, String] propagator_name One of :lightstep or :b3
       # @return [Propagator]
       def [](propagator_name)
         klass = PROPAGATOR_MAP[propagator_name.to_sym] || LightStepPropagator

data/lib/lightstep/propagation/b3_propagator.rb

@@ -7,11 +7,14 @@ module LightStep
       CARRIER_SPAN_ID = 'x-b3-spanid'
       CARRIER_TRACE_ID = 'x-b3-traceid'
       CARRIER_SAMPLED = 'x-b3-sampled'
+      TRUE_VALUES = %w[1 true].freeze
 
       private
 
+      # propagate the full 128-bit trace id if the original id was 128-bit,
+      # use the 64 bit id otherwise
       def trace_id_from_ctx(ctx)
-        ctx.trace_id16
+        ctx.id_truncated? ? ctx.trace_id128 : ctx.trace_id64
       end
 
       def sampled_flag_from_ctx(ctx)
@@ -19,7 +22,7 @@ module LightStep
       end
 
       def sampled_flag_from_carrier(carrier)
-        carrier[self.class::CARRIER_SAMPLED] == '1' ? true : false
+        TRUE_VALUES.include?(carrier[self.class::CARRIER_SAMPLED])
       end
     end
   end

data/lib/lightstep/span.rb

@@ -56,7 +56,11 @@ module LightStep
       ref = ref.context if (Span === ref)
 
       if SpanContext === ref
-        @context = SpanContext.new(id: LightStep.guid, trace_id: ref.trace_id, sampled: ref.sampled?)
+        @context = SpanContext.new(
+          id: LightStep.guid,
+          trace_id: ref.trace_id,
+          trace_id_upper64: ref.trace_id_upper64,
+          sampled: ref.sampled?)
         set_baggage(ref.baggage)
         set_tag(:parent_span_guid, ref.id)
       else
@@ -83,6 +87,7 @@ module LightStep
       @context = SpanContext.new(
         id: context.id,
         trace_id: context.trace_id,
+        trace_id_upper64: context.trace_id_upper64,
         sampled: context.sampled?,
         baggage: context.baggage.merge({key => value})
       )
@@ -95,6 +100,7 @@ module LightStep
       @context = SpanContext.new(
         id: context.id,
         trace_id: context.trace_id,
+        trace_id_upper64: context.trace_id_upper64,
         sampled: context.sampled?,
         baggage: baggage
       )

data/lib/lightstep/span_context.rb

@@ -3,29 +3,43 @@
 module LightStep
   # SpanContext holds the data for a span that gets inherited to child spans
   class SpanContext
-    attr_reader :id, :trace_id, :trace_id16, :sampled, :baggage
+    attr_reader :id, :trace_id, :trace_id_upper64, :sampled, :baggage
+    alias_method :trace_id64, :trace_id
     alias_method :sampled?, :sampled
 
     ZERO_PADDING = '0' * 16
 
-    def initialize(id:, trace_id:, sampled: true, baggage: {})
+    def initialize(id:, trace_id:, trace_id_upper64: nil, sampled: true, baggage: {})
       @id = id.freeze
-      @trace_id16 = pad_id(trace_id).freeze
       @trace_id = truncate_id(trace_id).freeze
+      @trace_id_upper64 = trace_id_upper64 || extended_bits(trace_id).freeze
       @sampled = sampled
       @baggage = baggage.freeze
     end
 
+    # Lazily initializes and returns a 128-bit representation of a 64-bit trace id
+    def trace_id128
+      @trace_id128 ||= "#{trace_id_upper64 || ZERO_PADDING}#{trace_id}"
+    end
+
+    # Returns true if the original trace_id was 128 bits
+    def id_truncated?
+      !@trace_id_upper64.nil?
+    end
+
     private
 
+    # Truncates an id to 64 bits
     def truncate_id(id)
       return id unless id && id.size == 32
-      id[0...16]
+      id[16..-1]
     end
 
-    def pad_id(id)
-      return id unless id && id.size == 16
-      "#{id}#{ZERO_PADDING}"
+    # Returns the most significant 64 bits of a 128 bit id or nil if the id
+    # is 64 bits
+    def extended_bits(id)
+      return unless id && id.size == 32
+      id[0...16]
     end
   end
 end

data/lib/lightstep/tracer.rb

@@ -28,7 +28,7 @@ module LightStep
     # @param access_token [String] The project access token when pushing to LightStep
     # @param transport [LightStep::Transport] How the data should be transported
     # @param tags [Hash] Tracer-level tags
-    # @param propagator [Propagator] :lightstep is the only supported option
+    # @param propagator [Propagator] Symbol one of :lightstep, :b3 indicating the propagator
     #   to use
     # @return LightStep::Tracer
     # @raise LightStep::ConfigurationError if the group name or access token is not a valid string.

data/lib/lightstep/version.rb

@@ -1,3 +1,3 @@
 module LightStep
-  VERSION = '0.15.1'.freeze
+  VERSION = '0.16.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightstep
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.0
 platform: ruby
 authors:
 - lightstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2019-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby