lightstep 0.15.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3dd55736997047494f81d964b3af41ae7d46df3d
-  data.tar.gz: 2cb5bd4f73f16d8a7ec05347f73574c660b57bde
+SHA256:
+  metadata.gz: 5e9f8988ff2ee9b867440d0fee9aa30357df0aed33e5daa92c48e338ad386624
+  data.tar.gz: dea73009fd576d64f80efac982533e8b1291bb8c45cf580430f36bd188eac60f
 SHA512:
-  metadata.gz: 3cd1f14fc114101da63e675f0e5e5e3317b09ded56822d2a65bafafd1666ab44205c5e1759287ce6887bd8e48ea6b62547aff747e57c62d86da4fd3feb9bb002
-  data.tar.gz: cd21715f9042383212e30701971ce48bae5954427786ad57adfecabecf1d27795b46a33877e2adfa179736f985278a9f39d827b93f870921d9ee36d6b62f27a1
+  metadata.gz: be197fd10bfd6fc23bbc41e1016749ce7bac73149e57830a83ffc81a4bbed964e4dcdbb326cfde1dd2e75335e9ece218e77749536c5cb7ec6f246762013266aa
+  data.tar.gz: 84d6dcbfbddb2b3fe7bfc4c88bbd43435ca8a50ae818b07752a7961dfa173d492f80ff0b4c0e95e1460cd32a3385a6a41288af0f5e13ce35df838ba3bca6c4fd

data/.circleci/config.yml

@@ -1,31 +1,32 @@
 version: 2
 
 jobs:
-  test:
+  test-ruby-24:
+    docker:
+      - image: circleci/ruby:2.4-stretch
+    steps:
+      - checkout
+      - run: gem install --no-document bundler && bundle install --jobs=3 --retry=3
+      - run: bundle exec rake
+  test-ruby-25:
     docker:
-      - image: circleci/ruby:2
+      - image: circleci/ruby:2.5-stretch
     steps:
       - checkout
-      - restore_cache:
-          keys:
-            - gem-cache-v2-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
-            - gem-cache-v2-{{ .Branch }}-
-            - gem-cache-v2-
-      - run:
-          name: "set up environment"
-          command: |
-            echo 'export BUNDLE_PATH="$HOME/project/.bundler_cache"' >> $BASH_ENV
-            source $BASH_ENV
-      - run: bundle
-      - save_cache:
-          paths:
-            - ~/project/.bundler_cache
-          key: gem-cache-v2-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
-      - run: make test
+      - run: gem install --no-document bundler && bundle install --jobs=3 --retry=3
+      - run: bundle exec rake
+  test-ruby-26:
+    docker:
+      - image: circleci/ruby:2.6-stretch
+    steps:
+      - checkout
+      - run: gem install --no-document bundler && bundle install --jobs=3 --retry=3
+      - run: bundle exec rake
 
 workflows:
   version: 2
   test:
     jobs:
-      - test
-
+      - test-ruby-24
+      - test-ruby-25
+      - test-ruby-26

data/CHANGELOG.md

@@ -4,7 +4,15 @@ 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).
 
-## [Unreleased]
+## 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
+- In-progress B3 support
+
+## v0.15.0
 ### Added
 - A Changelog
 - Now supports Span#log_kv

data/Gemfile.lock

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

data/lib/lightstep/propagation.rb

@@ -0,0 +1,24 @@
+#frozen_string_literal: true
+
+require 'lightstep/propagation/lightstep_propagator'
+require 'lightstep/propagation/b3_propagator'
+
+module LightStep
+  module Propagation
+    PROPAGATOR_MAP = {
+      lightstep: LightStepPropagator
+    }
+
+    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
+      # @return [Propagator]
+      def [](propagator_name)
+        klass = PROPAGATOR_MAP[propagator_name.to_sym] || LightStepPropagator
+        klass.new
+      end
+    end
+  end
+end

data/lib/lightstep/propagation/b3_propagator.rb

@@ -0,0 +1,26 @@
+#frozen_string_literal: true
+
+module LightStep
+  module Propagation
+    class B3Propagator < LightStepPropagator
+      CARRIER_TRACER_STATE_PREFIX = 'x-b3-'
+      CARRIER_SPAN_ID = 'x-b3-spanid'
+      CARRIER_TRACE_ID = 'x-b3-traceid'
+      CARRIER_SAMPLED = 'x-b3-sampled'
+
+      private
+
+      def trace_id_from_ctx(ctx)
+        ctx.trace_id16
+      end
+
+      def sampled_flag_from_ctx(ctx)
+        ctx.sampled? ? '1' : '0'
+      end
+
+      def sampled_flag_from_carrier(carrier)
+        carrier[self.class::CARRIER_SAMPLED] == '1' ? true : false
+      end
+    end
+  end
+end

data/lib/lightstep/propagation/lightstep_propagator.rb

@@ -0,0 +1,127 @@
+#frozen_string_literal: true
+
+module LightStep
+  module Propagation
+    class LightStepPropagator
+      CARRIER_TRACER_STATE_PREFIX = 'ot-tracer-'
+      CARRIER_SPAN_ID = 'ot-tracer-spanid'
+      CARRIER_TRACE_ID = 'ot-tracer-traceid'
+      CARRIER_SAMPLED = 'ot-tracer-sampled'
+      CARRIER_BAGGAGE_PREFIX = 'ot-baggage-'
+
+      # Inject a SpanContext into the given carrier
+      #
+      # @param spancontext [SpanContext]
+      # @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY]
+      # @param carrier [Carrier] A carrier object of the type dictated by the specified `format`
+      def inject(span_context, format, carrier)
+        case format
+        when OpenTracing::FORMAT_TEXT_MAP
+          inject_to_text_map(span_context, carrier)
+        when OpenTracing::FORMAT_BINARY
+          warn 'Binary inject format not yet implemented'
+        when OpenTracing::FORMAT_RACK
+          inject_to_rack(span_context, carrier)
+        else
+          warn 'Unknown inject format'
+        end
+      end
+
+      # Extract a SpanContext from a carrier
+      # @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]
+      # @param carrier [Carrier] A carrier object of the type dictated by the specified `format`
+      # @return [SpanContext] the extracted SpanContext or nil if none could be found
+      def extract(format, carrier)
+        case format
+        when OpenTracing::FORMAT_TEXT_MAP
+          extract_from_text_map(carrier)
+        when OpenTracing::FORMAT_BINARY
+          warn 'Binary join format not yet implemented'
+          nil
+        when OpenTracing::FORMAT_RACK
+          extract_from_rack(carrier)
+        else
+          warn 'Unknown join format'
+          nil
+        end
+      end
+
+      private
+
+      def inject_to_text_map(span_context, carrier)
+        if trace_id = trace_id_from_ctx(span_context)
+          carrier[self.class::CARRIER_TRACE_ID] = trace_id
+        end
+        carrier[self.class::CARRIER_SPAN_ID] = span_context.id
+        carrier[self.class::CARRIER_SAMPLED] = sampled_flag_from_ctx(span_context)
+
+        span_context.baggage.each do |key, value|
+          carrier[self.class::CARRIER_BAGGAGE_PREFIX + key] = value
+        end
+      end
+
+      def extract_from_text_map(carrier)
+        # If the carrier does not have both the span_id and trace_id key
+        # skip the processing and just return a normal span
+        if !carrier.has_key?(self.class::CARRIER_SPAN_ID) || !carrier.has_key?(self.class::CARRIER_TRACE_ID)
+          return nil
+        end
+
+        baggage = carrier.reduce({}) do |baggage, (key, value)|
+          if key.start_with?(self.class::CARRIER_BAGGAGE_PREFIX)
+            plain_key = key.to_s[self.class::CARRIER_BAGGAGE_PREFIX.length..key.to_s.length]
+            baggage[plain_key] = value
+          end
+          baggage
+        end
+
+        SpanContext.new(
+          id: carrier[self.class::CARRIER_SPAN_ID],
+          trace_id: carrier[self.class::CARRIER_TRACE_ID],
+          sampled: sampled_flag_from_carrier(carrier),
+          baggage: baggage,
+        )
+      end
+
+      def inject_to_rack(span_context, carrier)
+        if trace_id = trace_id_from_ctx(span_context)
+          carrier[self.class::CARRIER_TRACE_ID] = trace_id
+        end
+        carrier[self.class::CARRIER_SPAN_ID] = span_context.id
+        carrier[self.class::CARRIER_SAMPLED] = sampled_flag_from_ctx(span_context)
+
+        span_context.baggage.each do |key, value|
+          if key =~ /[^A-Za-z0-9\-_]/
+            # TODO: log the error internally
+            next
+          end
+          carrier[self.class::CARRIER_BAGGAGE_PREFIX + key] = value
+        end
+      end
+
+      def extract_from_rack(env)
+        extract_from_text_map(env.reduce({}){|memo, (raw_header, value)|
+          header = raw_header.to_s.gsub(/^HTTP_/, '')
+          header.tr!('_', '-')
+          header.downcase!
+
+          memo[header] = value if header.start_with?(self.class::CARRIER_TRACER_STATE_PREFIX,
+                                                     self.class::CARRIER_BAGGAGE_PREFIX)
+          memo
+        })
+      end
+
+      def trace_id_from_ctx(ctx)
+        ctx.trace_id
+      end
+
+      def sampled_flag_from_ctx(_)
+        'true'
+      end
+
+      def sampled_flag_from_carrier(_)
+        true
+      end
+    end
+  end
+end

data/lib/lightstep/span.rb

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

data/lib/lightstep/span_context.rb

@@ -1,12 +1,31 @@
+#frozen_string_literal: true
+
 module LightStep
   # SpanContext holds the data for a span that gets inherited to child spans
   class SpanContext
-    attr_reader :id, :trace_id, :baggage
+    attr_reader :id, :trace_id, :trace_id16, :sampled, :baggage
+    alias_method :sampled?, :sampled
+
+    ZERO_PADDING = '0' * 16
 
-    def initialize(id:, trace_id:, baggage: {})
+    def initialize(id:, trace_id:, sampled: true, baggage: {})
       @id = id.freeze
-      @trace_id = trace_id.freeze
+      @trace_id16 = pad_id(trace_id).freeze
+      @trace_id = truncate_id(trace_id).freeze
+      @sampled = sampled
       @baggage = baggage.freeze
     end
+
+    private
+
+    def truncate_id(id)
+      return id unless id && id.size == 32
+      id[0...16]
+    end
+
+    def pad_id(id)
+      return id unless id && id.size == 16
+      "#{id}#{ZERO_PADDING}"
+    end
   end
 end

data/lib/lightstep/tracer.rb

@@ -5,6 +5,7 @@ require 'opentracing'
 
 require 'lightstep/span'
 require 'lightstep/reporter'
+require 'lightstep/propagation'
 require 'lightstep/transport/http_json'
 require 'lightstep/transport/nil'
 require 'lightstep/transport/callback'
@@ -14,6 +15,11 @@ module LightStep
     class Error < LightStep::Error; end
     class ConfigurationError < LightStep::Tracer::Error; end
 
+    DEFAULT_MAX_LOG_RECORDS = 1000
+    MIN_MAX_LOG_RECORDS = 1
+    DEFAULT_MAX_SPAN_RECORDS = 1000
+    MIN_MAX_SPAN_RECORDS = 1
+
     attr_reader :access_token, :guid
 
     # Initialize a new tracer. Either an access_token or a transport must be
@@ -22,10 +28,20 @@ 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
+    #   to use
     # @return LightStep::Tracer
     # @raise LightStep::ConfigurationError if the group name or access token is not a valid string.
-    def initialize(component_name:, access_token: nil, transport: nil, tags: {})
-      configure(component_name: component_name, access_token: access_token, transport: transport, tags: tags)
+    def initialize(component_name:,
+                   access_token: nil,
+                   transport: nil,
+                   tags: {},
+                   propagator: :lightstep)
+      configure(component_name: component_name,
+                access_token: access_token,
+                transport: transport,
+                tags: tags,
+                propagator: propagator)
     end
 
     def max_log_records
@@ -111,7 +127,9 @@ module LightStep
 
       scope_manager.activate(span: span, finish_on_close: finish_on_close).tap do |scope|
         if block_given?
-          return yield(scope).tap do
+          begin
+            return yield scope
+          ensure
             scope.close
           end
         end
@@ -165,29 +183,23 @@ module LightStep
 
       Span.new(span_options).tap do |span|
         if block_given?
-          return yield(span).tap do
+          begin
+            return yield span
+          ensure
             span.finish
           end
         end
       end
     end
 
+
     # Inject a SpanContext into the given carrier
     #
     # @param spancontext [SpanContext]
     # @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY]
     # @param carrier [Carrier] A carrier object of the type dictated by the specified `format`
     def inject(span_context, format, carrier)
-      case format
-      when OpenTracing::FORMAT_TEXT_MAP
-        inject_to_text_map(span_context, carrier)
-      when OpenTracing::FORMAT_BINARY
-        warn 'Binary inject format not yet implemented'
-      when OpenTracing::FORMAT_RACK
-        inject_to_rack(span_context, carrier)
-      else
-        warn 'Unknown inject format'
-      end
+      @propagator.inject(span_context, format, carrier)
     end
 
     # Extract a SpanContext from a carrier
@@ -195,18 +207,7 @@ module LightStep
     # @param carrier [Carrier] A carrier object of the type dictated by the specified `format`
     # @return [SpanContext] the extracted SpanContext or nil if none could be found
     def extract(format, carrier)
-      case format
-      when OpenTracing::FORMAT_TEXT_MAP
-        extract_from_text_map(carrier)
-      when OpenTracing::FORMAT_BINARY
-        warn 'Binary join format not yet implemented'
-        nil
-      when OpenTracing::FORMAT_RACK
-        extract_from_rack(carrier)
-      else
-        warn 'Unknown join format'
-        nil
-      end
+      @propagator.extract(format, carrier)
     end
 
     # @return true if the tracer is enabled
@@ -243,7 +244,11 @@ module LightStep
 
     protected
 
-    def configure(component_name:, access_token: nil, transport: nil, tags: {})
+    def configure(component_name:,
+                  access_token: nil,
+                  transport: nil, tags: {},
+                  propagator: :lightstep)
+
       raise ConfigurationError, "component_name must be a string" unless component_name.is_a?(String)
       raise ConfigurationError, "component_name cannot be blank"  if component_name.empty?
 
@@ -254,6 +259,8 @@ module LightStep
       raise ConfigurationError, "you must provide an access token or a transport" if transport.nil?
       raise ConfigurationError, "#{transport} is not a LightStep transport class" if !(LightStep::Transport::Base === transport)
 
+      @propagator = Propagation[propagator]
+
       @guid = LightStep.guid
 
       @reporter = LightStep::Reporter.new(
@@ -264,75 +271,5 @@ module LightStep
         tags: tags
       )
     end
-
-    private
-
-    CARRIER_TRACER_STATE_PREFIX = 'ot-tracer-'.freeze
-    CARRIER_BAGGAGE_PREFIX = 'ot-baggage-'.freeze
-
-    CARRIER_SPAN_ID = (CARRIER_TRACER_STATE_PREFIX + 'spanid').freeze
-    CARRIER_TRACE_ID = (CARRIER_TRACER_STATE_PREFIX + 'traceid').freeze
-    CARRIER_SAMPLED = (CARRIER_TRACER_STATE_PREFIX + 'sampled').freeze
-
-    DEFAULT_MAX_LOG_RECORDS = 1000
-    MIN_MAX_LOG_RECORDS = 1
-    DEFAULT_MAX_SPAN_RECORDS = 1000
-    MIN_MAX_SPAN_RECORDS = 1
-
-    def inject_to_text_map(span_context, carrier)
-      carrier[CARRIER_SPAN_ID] = span_context.id
-      carrier[CARRIER_TRACE_ID] = span_context.trace_id unless span_context.trace_id.nil?
-      carrier[CARRIER_SAMPLED] = 'true'
-
-      span_context.baggage.each do |key, value|
-        carrier[CARRIER_BAGGAGE_PREFIX + key] = value
-      end
-    end
-
-    def extract_from_text_map(carrier)
-      # If the carrier does not have both the span_id and trace_id key
-      # skip the processing and just return a normal span
-      if !carrier.has_key?(CARRIER_SPAN_ID) || !carrier.has_key?(CARRIER_TRACE_ID)
-        return nil
-      end
-
-      baggage = carrier.reduce({}) do |baggage, tuple|
-        key, value = tuple
-        if key.start_with?(CARRIER_BAGGAGE_PREFIX)
-          plain_key = key.to_s[CARRIER_BAGGAGE_PREFIX.length..key.to_s.length]
-          baggage[plain_key] = value
-        end
-        baggage
-      end
-      SpanContext.new(
-        id: carrier[CARRIER_SPAN_ID],
-        trace_id: carrier[CARRIER_TRACE_ID],
-        baggage: baggage,
-      )
-    end
-
-    def inject_to_rack(span_context, carrier)
-      carrier[CARRIER_SPAN_ID] = span_context.id
-      carrier[CARRIER_TRACE_ID] = span_context.trace_id unless span_context.trace_id.nil?
-      carrier[CARRIER_SAMPLED] = 'true'
-
-      span_context.baggage.each do |key, value|
-        if key =~ /[^A-Za-z0-9\-_]/
-          # TODO: log the error internally
-          next
-        end
-        carrier[CARRIER_BAGGAGE_PREFIX + key] = value
-      end
-    end
-
-    def extract_from_rack(env)
-      extract_from_text_map(env.reduce({}){|memo, tuple|
-        raw_header, value = tuple
-        header = raw_header.to_s.gsub(/^HTTP_/, '').tr('_', '-').downcase
-
-        memo[header] = value if header.start_with?(CARRIER_TRACER_STATE_PREFIX, CARRIER_BAGGAGE_PREFIX)
-        memo
-      })
-    end
   end
 end

data/lib/lightstep/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightstep
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.15.1
 platform: ruby
 authors:
 - lightstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -145,13 +145,15 @@ files:
 - benchmark/threading/thread_test.rb
 - bin/console
 - bin/setup
-- circle.yml
 - example.rb
 - examples/fork_children/main.rb
 - examples/rack/hello.rb
 - examples/rack/inject_extract.rb
 - lib/lightstep.rb
 - lib/lightstep/global_tracer.rb
+- lib/lightstep/propagation.rb
+- lib/lightstep/propagation/b3_propagator.rb
+- lib/lightstep/propagation/lightstep_propagator.rb
 - lib/lightstep/reporter.rb
 - lib/lightstep/scope.rb
 - lib/lightstep/scope_manager.rb
@@ -185,8 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: LightStep OpenTracing Ruby bindings

data/circle.yml

@@ -1,3 +0,0 @@
-machine:
-  ruby:
-    version: 2.2.3