rails_distributed_tracing 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69fd5cb81a640cea786690e9d8bf4dc7284e08b0289e93d797fde7851fd36381
+  data.tar.gz: 0e9b942df72816af28e35588ac79c53b304193cf3c279f37db02d72039fc860a
+SHA512:
+  metadata.gz: 42c81c54a82559fc0b023c7aca86763ca256d910c1d18f4680cdb04d8a73783a9c0da0f9af5c3344a6dd40f57fc284d532a6c8f181eaccde6779dbd4c6cfefc0
+  data.tar.gz: 7d853b27c618c90302296846d195fcdd1bae0bfd44f73410ae2683398f05ec476fb403974de664ca8794487223f93da9e1c1df00530f8a5f9e3bcbda9b7cb4c0

data/.gitignore

@@ -0,0 +1 @@
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+
+BUNDLED WITH
+   1.16.1

data/lib/rails_distributed_tracing.rb

@@ -0,0 +1,2 @@
+project_root = File.dirname(File.absolute_path(__FILE__))
+Dir.glob(project_root + '/rails_distributed_tracing/**/*.rb', &method(:require))

data/lib/rails_distributed_tracing/distributed_tracing.rb

@@ -0,0 +1,18 @@
+require_relative './request_id_store'
+
+module DistributedTracing
+  def self.request_id_tag
+    lambda do |request|
+      request_id = request.headers['Request-ID'] || request.request_id
+      RequestIDStore.request_id = request_id
+    end
+  end
+
+  def self.request_id_header
+    {'Request-ID' => RequestIDStore.request_id}
+  end
+
+  def self.current_request_id
+    RequestIDStore.request_id
+  end
+end

data/lib/rails_distributed_tracing/request_id_store.rb

@@ -0,0 +1,15 @@
+module DistributedTracing
+  class RequestIDStore
+    def self.request_id=(id)
+      @request_id = id
+    end
+
+    def self.request_id
+      @request_id
+    end
+
+    def self.clear!
+      @request_id = nil
+    end
+  end
+end

data/lib/rails_distributed_tracing/version.rb

@@ -0,0 +1,3 @@
+module DistributedTracing
+  VERSION = '0.0.1'
+end

data/rails_distributed_tracing.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative './lib/rails_distributed_tracing/version.rb'
+
+Gem::Specification.new do |s|
+  s.name                        =   'rails_distributed_tracing'
+  s.version                     =   DistributedTracing::VERSION
+  s.summary                     =   "Microservices distributed tracing\nThe gem generates a request id which can be added as a tag in rails logs.\nChild services will reuse this tag with the help of this gem."
+  s.authors                     =   ['Ajit Singh']
+  s.email                       =   'jeetsingh.ajit@gamil.com'
+  s.license                     =   'MIT'
+  s.homepage                    =   'https://github.com/ajitsing/rails_distributed_tracing'
+
+  s.files                       =   `git ls-files -z`.split("\x0")
+  s.executables                 =   s.files.grep(%r{^bin/}) { |f| File.basename(f)  }
+  s.test_files                  =   s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths               =   ["lib"]
+
+  s.add_development_dependency      "bundler", "~> 1.5"
+  s.add_development_dependency      'rspec'
+end

data/spec/lib/distributed_tracing_spec.rb

@@ -0,0 +1,48 @@
+describe DistributedTracing do
+  describe '#request_id_tag' do
+    it 'should return request id from request object' do
+      request = double('request')
+      request_id = 'f914eb91-c550-48c4-af35-d14db95bd49f'
+
+      expect(request).to receive(:request_id).and_return(request_id)
+      expect(request).to receive(:headers).and_return({})
+
+      expect(DistributedTracing.request_id_tag.call(request)).to eq(request_id)
+    end
+
+    it 'should return request id from header' do
+      request = double('request')
+      request_id = '00bfc934-b429-4606-b0c8-318ffa82e884'
+
+      expect(request).to receive(:headers).and_return({'Request-ID' => request_id})
+
+      expect(DistributedTracing.request_id_tag.call(request)).to eq(request_id)
+    end
+  end
+
+  describe '#current_request_id' do
+    it 'should return current request id' do
+      request = double('request')
+      request_id = '00bfc934-b429-4606-b0c8-318ffa82e884'
+
+      expect(request).to receive(:headers).and_return({'Request-ID' => request_id})
+
+      DistributedTracing.request_id_tag.call(request)
+
+      expect(DistributedTracing.current_request_id).to eq(request_id)
+    end
+  end
+
+  describe '#request_id_header' do
+    it 'should return request id in a header' do
+      request = double('request')
+      request_id = '00bfc934-b429-4606-b0c8-318ffa82e884'
+
+      expect(request).to receive(:headers).and_return({'Request-ID' => request_id})
+
+      DistributedTracing.request_id_tag.call(request)
+
+      expect(DistributedTracing.request_id_header).to eq({'Request-ID' => request_id})
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,103 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require './lib/rails_distributed_tracing'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rails_distributed_tracing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ajit Singh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: jeetsingh.ajit@gamil.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- lib/rails_distributed_tracing.rb
+- lib/rails_distributed_tracing/distributed_tracing.rb
+- lib/rails_distributed_tracing/request_id_store.rb
+- lib/rails_distributed_tracing/version.rb
+- rails_distributed_tracing.gemspec
+- spec/lib/distributed_tracing_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ajitsing/rails_distributed_tracing
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Microservices distributed tracing The gem generates a request id which can
+  be added as a tag in rails logs. Child services will reuse this tag with the help
+  of this gem.
+test_files:
+- spec/lib/distributed_tracing_spec.rb
+- spec/spec_helper.rb