lightstep 0.12.0 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4061236d2e72a5a8af39a92ee36074193a9dfe0bd48032cdecdfcc3d01054557
-  data.tar.gz: ff20651fafa157cfeeecc789c73fb4a0c5dc4abbe910ef048625a39286251f6f
+  metadata.gz: 7b24dcdbee847cd07bfca4f5f6f5752c49eb951323d9c3c0356ad081f68483a0
+  data.tar.gz: b22da20413d082e19038a7a571aeb47fbfb8f304f70a3c4559ee765ec06c58bc
 SHA512:
-  metadata.gz: 0f7b6a24656af8708d935b7afa2e47f5f7ee3fcd768518679450326140b6ead0ef1191718a487f3bed035eec99f8a263edc1d04b1fb18ea9c05b126ad23a0f88
-  data.tar.gz: 23bb222bae518baa0bf4151883b9cc525cc6226d485fff7bce7cc13c12b4d7ea3a41821ba30bec0f7a19438b1a2bed039aabed27a947799613f9cf91e8eaff6b
+  metadata.gz: dfd268464c0c33e05ef86d250952dca6801b5f355011269d66d68bb98e205b9c9bb09b58ace4beb86af37455b69e21f1e2cabad8e38a6223ed6da63751cf1c47
+  data.tar.gz: 1e8df7a7ab819528448a1967585c7cc50816a77fa521b27dc75bf3f9d2174b4423679eae59b6f1cca01b05c4bff4bd3dd4db8551c1199001631074c7f1478a61

data/.circleci/config.yml

@@ -0,0 +1,32 @@
+version: 2
+
+jobs:
+  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.5-stretch
+    steps:
+      - checkout
+      - 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-ruby-24
+      - test-ruby-25
+      - test-ruby-26

data/.gitignore

@@ -1,6 +1,5 @@
 .bundle/
 .yardoc
-Gemfile.lock
 _yardoc/
 coverage/
 /doc/
@@ -8,6 +7,6 @@ coverage/
 /spec/reports/
 /tmp/
 *~
-Gemfile.lock
 lightstep-tracer*.gem
 lightstep*.gem
+.idea/

data/.rubocop.yml

@@ -0,0 +1,48 @@
+AllCops:
+  Exclude:
+    - spec/**/*
+    - .bundle/**/*
+    - bin/**/*
+    - vendor/**/*
+    - tmp/**/*
+    - log/**/*
+    - Rakefile
+    - lightstep.gemspec
+
+Lint/AmbiguousOperator:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 147
+
+Metrics/BlockNesting:
+  Max: 4
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 406
+
+Metrics/CyclomaticComplexity:
+  Max: 24
+
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 88
+
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 1000
+
+Performance/RedundantBlockCall:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+# 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).
+
+## 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

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    lightstep (0.16.1)
+      concurrent-ruby (~> 1.0)
+      opentracing (~> 0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bump (0.6.1)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.3)
+    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.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bump (~> 0.5)
+  lightstep!
+  rack (~> 2.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.16)
+  timecop (~> 0.8.0)
+
+BUNDLED WITH
+   2.0.2

data/Makefile

@@ -14,10 +14,10 @@ benchmark:
 	ruby benchmark/threading/thread_test.rb
 
 bump-version:
-	# ruby -e 'require "bump"; Bump::Bump.run("minor")'
-	# make build	# rebuild after version increment
+	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/example.rb

@@ -11,7 +11,7 @@ LightStep.configure(component_name: 'lightstep/ruby/example', access_token: acce
 puts 'Starting operation...'
 span = LightStep.start_span('my_span')
 thread1 = Thread.new do
-  for i in 1..10
+  (1..10).each do |i|
     sleep(0.15)
     puts "Logging event #{i}..."
     span.log(event: 'hello world', count: i)
@@ -19,7 +19,7 @@ thread1 = Thread.new do
 end
 thread2 = Thread.new do
   current = 1
-  for i in 1..16
+  (1..16).each do |i|
     child = LightStep.start_span('my_child', child_of: span.span_context)
     sleep(0.1)
     current *= 2

data/examples/rack/inject_extract.rb

@@ -60,7 +60,7 @@ end
 
 loop do
   begin
-    p Net::HTTP.get(URI("http://localhost:9001/"))
+    p Net::HTTP.get(URI("http://127.0.0.1:9001/"))
     break
   rescue Errno::ECONNREFUSED
     sleep 0.05

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
@@ -45,3 +47,5 @@ end
 
 require 'lightstep/tracer'
 require 'lightstep/global_tracer'
+require 'lightstep/scope'
+require 'lightstep/scope_manager'

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