lightstep 0.13.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 412b678787b505c5c97155f3d702adf01e8ebd60254fb793a07e8ae4da2cd7fa
-  data.tar.gz: bdd33820334d2306ce78b7e84928e4be5193211d0c359bba02b4032ed3c6fc42
+  metadata.gz: '0851600222a0920c097ddd71156bf77dbc9cc36858bc8335c8700b86e66c8b53'
+  data.tar.gz: 2b4d578ac10f3a5663fe687e3e3ff867d694e05b6bf436c32d7f3ed47bbbc069
 SHA512:
-  metadata.gz: 8d1395123221d74ce722e748dc21951f8462103dd505edc42f3f04c32f3f9eed524358a684085cb8ba55acd35dc3909102447cb0133700f8b91016687bf0ba00
-  data.tar.gz: 597593ee87d988b10f9c79fc80ddfa5e4b3f05290e5033873aeb1e7655d6562dacb5f81410a3d0db62d2a418958e9165557e17f062f188db4602c2e3c09a0b44
+  metadata.gz: 29ee1f57af4d7237db8f9b1dbceaba0e9d2b5769246a839a6c9ec1140aaae82b0b8ddcad55a13474f12192ed6980aa42f8e7a36ba051115469b1c4f2cd634249
+  data.tar.gz: 4dcbc11a5652ace492498b0889db92f790b90d80ad88d3e3ed94b0f6a102941fdc4c8cc10d82d0c2c7d5546f63f8c643ce78cf6287c7fb39c746ce42dbf16471

data/.circleci/config.yml

@@ -1,31 +1,40 @@
 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
+  test-ruby-30:
+    docker:
+      - image: circleci/ruby:3.0
+    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
+      - test-ruby-30

data/.gitignore

@@ -9,3 +9,4 @@ coverage/
 *~
 lightstep-tracer*.gem
 lightstep*.gem
+.idea/

data/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+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.17.0 
+### Changed
+- Add support for Ruby 3.0 ([#99](https://github.com/lightstep/lightstep-tracer-ruby/pull/99))
+
+## v0.16.1
+### Changed
+- Bump json from 2.2.0 to 2.5.1 ([#98](https://github.com/lightstep/lightstep-tracer-ruby/pull/98))
+- Bump rack from 2.0.7 to 2.2.3 ([#95](https://github.com/lightstep/lightstep-tracer-ruby/pull/98))
+- Update rake requirement from ~> 11.3 to ~> 13.0 ([#94](https://github.com/lightstep/lightstep-tracer-ruby/pull/98))
+
+## 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 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
+- Updated to opentracing-ruby 0.5.0
+- Now delegates Lightstep#active_span to the tracer
+- Now supports passing a block to #start_span
+- The block forms of #start_span and #start active_span now return the result of executing the block
+
+### Changed
+- Tracer#extract now supports symbols in carrier
+
+### Deprecated
+- Span#log (reflecting deprecation in opentracing 0.4.0)
+
+### Removed
+
+### Fixed
+- Fix handling of non-string tag values in `start_span`.
+
+### Security
+

data/CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# LightStep Community Contributing Guide
+
+First, 🎉 **thanks for contributing!** 🎉
+
+## Issues
+
+You're encouraged to log issues for any questions or problems you might have. When in doubt, log an issue. The exception to this rule is [security disclosures](#reporting-security-issues).
+
+Generally speaking, the more context you can provide, the better. Please add information such as what **version** you're using, **stack traces** and/or **logs** (to the extent that you're able to share them), and whatever else you think may be relevant. Project maintainers may ask for additional clarification, logs, and other pertinent metadata before we can address your issue.
+
+For bug submission, we especially appreciate **details on how to reproduce the bug** to the extent you're able to provide them, e.g., an isolated repo or [gist](https://gist.github.com).
+
+### Reporting Security Issues
+
+If you find a security issue, please **do not** file a public issue for it. Instead, send your report to us privately at [security@lightstep.com](mailto:security@lightstep.com).
+
+## Contributions
+
+All contributions big and small are welcome, from typo corrections to bug fixes to suggested improvements!
+
+Any changes to project resources in this repository must be made through a pull request. This includes, but is not limited to, changes affecting:
+
+- Documentation
+- Source code
+- Binaries
+- Sample projects or other examples
+
+No pull request can be merged without at least one review from a maintainer.
+
+By default, contributions are accepted once no committers object to the PR. Specific contributors may be suggested or required to review a pull request based on repository settings.
+
+In the event of objections or disagreement, everyone involved should seek to arrive at a consensus around the expressed objections. These can take the form of addressing concerns through changes, compromising around the change, or withdrawing it entirely.
+
+## Development
+
+### Testing
+
+To run the tests:
+
+```
+make test
+```
+
+## Submitting a Pull Request
+
+_Note that this section should be treated as a general guideline and replaced with language/repo specific instructions_
+
+1. [Fork the repository.](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
+1. Create a new branch.
+1. Add tests for your change.
+1. [Run the tests](#testing) to make sure that they don't already pass. If they do (and you're not backfilling test coverage), please modify them.
+1. Implement the change such that your new tests pass.
+1. [Commit and push your changes.](https://guides.github.com/introduction/flow/)
+1. [Submit your pull request.](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
+1. Adjust your pull request based on feedback.
+1. Get it merged! 🎉
+
+We're happy to help with any questions you may have on the git or GitHub side, e.g., how to push a branch to your fork. Just create an issue and we'll try to help answer them :)

data/Gemfile.lock

@@ -1,40 +1,41 @@
 PATH
   remote: .
   specs:
-    lightstep (0.13.0)
+    lightstep (0.17.0)
       concurrent-ruby (~> 1.0)
-      opentracing (~> 0.4.1)
+      opentracing (~> 0.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     bump (0.6.1)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.3)
-    docile (1.3.1)
-    json (2.1.0)
-    opentracing (0.4.1)
-    rack (2.0.5)
-    rake (11.3.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    docile (1.3.2)
+    json (2.5.1)
+    opentracing (0.5.0)
+    rack (2.2.3)
+    rake (13.0.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    simplecov (0.16.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    simplecov (0.17.0)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     timecop (0.8.1)
+    webrick (1.7.0)
 
 PLATFORMS
   ruby
@@ -43,10 +44,11 @@ DEPENDENCIES
   bump (~> 0.5)
   lightstep!
   rack (~> 2.0)
-  rake (~> 11.3)
+  rake (~> 13.0)
   rspec (~> 3.0)
   simplecov (~> 0.16)
   timecop (~> 0.8.0)
+  webrick (~> 1.7)
 
 BUNDLED WITH
-   1.16.6
+   2.2.3

data/Makefile

@@ -14,10 +14,10 @@ benchmark:
 	ruby benchmark/threading/thread_test.rb
 
 bump-version:
-	# ruby -e 'require "bump"; Bump::Bump.run("patch")'
+	ruby -e 'require "bump"; Bump::Bump.run("$(RELEASE_TYPE)")'
 	make build	# rebuild after version increment
 	git tag `ruby scripts/version.rb`
-	# git push
+	git push
 	git push --tags
 
 publish: build test benchmark bump-version

data/README.md

@@ -1,6 +1,6 @@
 # lightstep-tracer-ruby
 
-[![Gem Version](https://badge.fury.io/rb/lightstep-tracer.svg)](https://badge.fury.io/rb/lightstep-tracer) [![Circle CI](https://circleci.com/gh/lightstep/lightstep-tracer-ruby.svg?style=shield)](https://circleci.com/gh/lightstep/lightstep-tracer-ruby) [![MIT license](http://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT) [![Code Climate](https://codeclimate.com/github/lightstep/lightstep-tracer-ruby/badges/gpa.svg)](https://codeclimate.com/github/lightstep/lightstep-tracer-ruby)
+[![Gem Version](https://badge.fury.io/rb/lightstep.svg)](https://badge.fury.io/rb/lightstep) [![Circle CI](https://circleci.com/gh/lightstep/lightstep-tracer-ruby.svg?style=shield)](https://circleci.com/gh/lightstep/lightstep-tracer-ruby) [![MIT license](http://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT) [![Code Climate](https://codeclimate.com/github/lightstep/lightstep-tracer-ruby/badges/gpa.svg)](https://codeclimate.com/github/lightstep/lightstep-tracer-ruby)
 
 The LightStep distributed tracing library for Ruby.
 
@@ -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.rb

@@ -15,6 +15,8 @@ module LightStep
 
   def_delegator :instance, :configure
   def_delegator :instance, :start_span
+  def_delegator :instance, :start_active_span
+  def_delegator :instance, :active_span
   def_delegator :instance, :disable
   def_delegator :instance, :enable
   def_delegator :instance, :flush

data/lib/lightstep/propagation.rb

@@ -0,0 +1,25 @@
+#frozen_string_literal: true
+
+require 'lightstep/propagation/lightstep_propagator'
+require 'lightstep/propagation/b3_propagator'
+
+module LightStep
+  module Propagation
+    PROPAGATOR_MAP = {
+      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 One of :lightstep or :b3
+      # @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,29 @@
+#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'
+      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.id_truncated? ? ctx.trace_id128 : ctx.trace_id64
+      end
+
+      def sampled_flag_from_ctx(ctx)
+        ctx.sampled? ? '1' : '0'
+      end
+
+      def sampled_flag_from_carrier(carrier)
+        TRUE_VALUES.include?(carrier[self.class::CARRIER_SAMPLED])
+      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

@@ -42,7 +42,7 @@ module LightStep
     )
 
       @tags = Concurrent::Hash.new
-      @tags.update(tags) unless tags.nil?
+      @tags.update(tags.each { |k, v| tags[k] = v.to_s }) unless tags.nil?
       @log_records = Concurrent::Array.new
       @dropped_logs = Concurrent::AtomicFixnum.new
       @max_log_records = max_log_records
@@ -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)
+        @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,8 @@ 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})
       )
       self
@@ -94,6 +100,8 @@ 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
       )
     end
@@ -105,22 +113,35 @@ module LightStep
       context.baggage[key]
     end
 
+    # @deprecated Use {#log_kv} instead.
     # Add a log entry to this span
     # @param event [String] event name for the log
     # @param timestamp [Time] time of the log
-    # @param fields [Hash] Additional information to log
+    # @param fields [Hash{Symbol=>Object}] Additional information to log
     def log(event: nil, timestamp: Time.now, **fields)
+      warn 'Span#log is deprecated. Please use Span#log_kv instead.'
       return unless tracer.enabled?
 
       fields = {} if fields.nil?
       unless event.nil?
 	fields[:event] = event.to_s
       end
+
+      log_kv(timestamp: timestamp, **fields)
+    end
+
+    # Add a log entry to this span
+    # @param timestamp [Time] time of the log
+    # @param fields [Hash{Symbol=>Object}] Additional information to log
+    def log_kv(timestamp: Time.now, **fields)
+      return unless tracer.enabled?
+
+      fields = {} if fields.nil?
       record = {
         timestamp_micros: LightStep.micros(timestamp),
-        fields: fields.to_a.map {|key, value|
-          {Key: key.to_s, Value: value.to_s}
-        },
+        fields: fields.to_a.map do |key, value|
+          { Key: key.to_s, Value: value.to_s }
+        end
       }
 
       log_records.push(record)

data/lib/lightstep/span_context.rb

@@ -1,12 +1,45 @@
+# 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_id_upper64, :sampled, :baggage
+    alias_method :trace_id64, :trace_id
+    alias_method :sampled?, :sampled
+
+    ZERO_PADDING = '0' * 16
 
-    def initialize(id:, trace_id:, baggage: {})
+    def initialize(id:, trace_id:, trace_id_upper64: nil, sampled: true, baggage: {})
       @id = id.freeze
-      @trace_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[16..-1]
+    end
+
+    # 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

@@ -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,18 +15,33 @@ 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
     # provided. A component_name is always required.
     # @param component_name [String] Component name to use for the tracer
     # @param access_token [String] The project access token when pushing to LightStep
-    # @param transport [LightStep::Transport] How the data should be transported
+    # @param transport [LightStep::Transport::Base] How the data should be transported
     # @param tags [Hash] Tracer-level tags
+    # @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.
-    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
@@ -83,10 +99,12 @@ module LightStep
     #   References#CHILD_OF reference to the ScopeManager#active.
     # @param finish_on_close [Boolean] whether span should automatically be
     #   finished when Scope#close is called
-    # @yield [Scope] If an optional block is passed to start_active it will
+    # @yield [Scope] If an optional block is passed to start_active_span it will
     #   yield the newly-started Scope. If `finish_on_close` is true then the
     #   Span will be finished automatically after the block is executed.
-    # @return [Scope] The newly-started and activated Scope
+    # @return [Scope, Object] If passed an optional block, start_active_span
+    #   returns the block's return value, otherwise it returns the newly-started
+    #   and activated Scope
     def start_active_span(operation_name,
                           child_of: nil,
                           references: nil,
@@ -109,8 +127,11 @@ module LightStep
 
       scope_manager.activate(span: span, finish_on_close: finish_on_close).tap do |scope|
         if block_given?
-          yield scope
-          scope.close
+          begin
+            return yield scope
+          ensure
+            scope.close
+          end
         end
       end
     end
@@ -138,13 +159,19 @@ module LightStep
     # @param tags [Hash] Tags to assign to the Span at start time
     # @param ignore_active_scope [Boolean] whether to create an implicit
     #   References#CHILD_OF reference to the ScopeManager#active.
-    # @return [Span]
+    # @yield [Span] If passed an optional block, start_span will yield the
+    #   newly-created span to the block. The span will be finished automatically
+    #   after the block is executed.
+    # @return [Span, Object] If passed an optional block, start_span will return
+    #  the block's return value, otherwise it returns the newly-started Span
+    #  instance, which has not been automatically registered via the
+    #  ScopeManager
     def start_span(operation_name, child_of: nil, references: nil, start_time: nil, tags: nil, ignore_active_scope: false)
       if child_of.nil? && references.nil? && !ignore_active_scope
         child_of = active_span
       end
 
-      Span.new(
+      span_options = {
         tracer: self,
         operation_name: operation_name,
         child_of: child_of,
@@ -152,25 +179,27 @@ module LightStep
         start_micros: start_time.nil? ? LightStep.micros(Time.now) : LightStep.micros(start_time),
         tags: tags,
         max_log_records: max_log_records,
-      )
+      }
+
+      Span.new(**span_options).tap do |span|
+        if block_given?
+          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
@@ -178,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
@@ -226,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?
 
@@ -237,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(
@@ -247,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.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/transport/http_json.rb

@@ -4,12 +4,7 @@ require 'lightstep/transport/base'
 module LightStep
   module Transport
     # HTTPJSON is a transport that sends reports via HTTP in JSON format.
-    # It is thread-safe, however it is *not* fork-safe. When forking, all items
-    # in the queue will be copied and sent in duplicate.
-    #
-    # When forking, you should first `disable` the tracer, then `enable` it from
-    # within the fork (and in the parent post-fork). See
-    # `examples/fork_children/main.rb` for an example.
+    # It is thread-safe.
     class HTTPJSON < Base
       LIGHTSTEP_HOST = 'collector.lightstep.com'.freeze
       LIGHTSTEP_PORT = 443

data/lib/lightstep/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightStep
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.17.0'
 end

data/lightstep.gemspec

@@ -6,7 +6,7 @@ require 'lightstep/version'
 Gem::Specification.new do |spec|
   spec.name          = 'lightstep'
   spec.version       = LightStep::VERSION
-  spec.authors       = ['bcronin']
+  spec.authors       = ['lightstep']
   spec.email         = ['support@lightstep.com']
 
   spec.summary       = 'LightStep OpenTracing Ruby bindings'
@@ -16,10 +16,15 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
+  spec.metadata    = {
+    "changelog_uri" => "https://github.com/lightstep/lightstep-tracer-ruby/blob/master/CHANGELOG.md",
+  }
+
   spec.add_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_dependency 'opentracing', '~> 0.4.1'
-  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_dependency 'opentracing', '~> 0.5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rack', '~> 2.0'
+  spec.add_development_dependency 'webrick', '~> 1.7' # for examples/
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'bump', '~> 0.5'
   spec.add_development_dependency 'simplecov', '~> 0.16'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightstep
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.17.0
 platform: ruby
 authors:
-- bcronin
-autorequire: 
+- lightstep
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
-description: 
+description:
 email:
 - support@lightstep.com
 executables: []
@@ -133,6 +147,8 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -144,13 +160,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
@@ -167,8 +185,9 @@ files:
 homepage: https://github.com/lightstep/lightstep-tracer-ruby
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/lightstep/lightstep-tracer-ruby/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -183,9 +202,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: LightStep OpenTracing Ruby bindings
 test_files: []

data/circle.yml

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