rails_distributed_tracing 0.0.2 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 932ad0b65a26e5aef89cea57fd62cd2c21668c299709ffa1b9ad831b8644876a
-  data.tar.gz: '09e8453fb7cbea081ebc58e2961ee5a9f02afdb7de799818ddbf5bdbbd1bbf07'
+  metadata.gz: abe92b91367b21afe0d77aec53d6da1ee5e9603dfdff83d3e688cb88a838ede1
+  data.tar.gz: 6eefcd8908103da02b797d49fd9e6111ad370b12d7c6e40ac924614873c80d5a
 SHA512:
-  metadata.gz: 0b81bce1195aaaa5be5d780ade44a851c94984d03001165fb92ccfe19ac5d180a442856cde346c259c677e96d6cebcd4d82712227067c739f94792a568a46c0c
-  data.tar.gz: 6843bb9073886b8ba3f6ad30c2483a04f875e8c99a06ca8c120c50f43265e70e40e65ab1c0cf1720a81a537b122a8e540d450d1253757534883c366fb769b5e1
+  metadata.gz: 335b44ade75fdd58e21b463bb7414f05944de229bb1feed0f94e92e1aa32c72b512de08cbcf22e2e6a72c606c07a83d42ff2c88c679d588998efbe77a20fa37a
+  data.tar.gz: f2f949f706b90c500f8ac7b20d604fc6bd4a558f1ea0c2607023b60b6a836e279cda5767c5cfe179190ba7b87d9e9352dc67f1b3368b1de58ed82f5da78cebaa

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.4.0
+  - ruby
+
+before_install:
+  - rvm install 2.4.0
+  - rvm use 2.4.0
+
+script:
+- "bundle exec rspec"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Ajit Singh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# rails_distributed_tracing
+Distributed tracing for rails microservices
+
+[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=102)](https://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/rails_distributed_tracing.svg)](https://badge.fury.io/rb/rails_distributed_tracing)
+![Gem Downloads](http://ruby-gem-downloads-badge.herokuapp.com/rails_distributed_tracing?type=total)
+[![Build Status](https://travis-ci.org/ajitsing/rails_distributed_tracing.svg?branch=master)](https://travis-ci.org/ajitsing/rails_distributed_tracing)
+[![Twitter Follow](https://img.shields.io/twitter/follow/Ajit5ingh.svg?style=social)](https://twitter.com/Ajit5ingh)
+
+## Installation
+Add this line to Gemfile of your microservice:
+```ruby
+gem 'rails_distributed_tracing'
+```
+
+## Configuration
+Add request id tag to log tags in `application.rb`. This config will make sure that the logs are tagged with a request id.
+If the service is origin service, `DistributedTracing.request_id_tag` will create a new request id else it will reuse the request id passed from the origin service.
+
+```ruby
+require 'rails_distributed_tracing'
+
+class Application < Rails::Application
+  config.log_tags = [DistributedTracing.request_id_tag]
+end
+```
+
+## Passing request id tag to downstream services
+To make the distributed tracing work every service has to the request id to all its downstream services. 
+For example lets assume that we have 3 services:   
+`OriginService`, `SecondService` and `ThirdService` .  
+
+Now a request comes to `OriginService`, the above config will create a new request_id for that request.
+When `OriginService` makes a request to `SecondService` it should pass the same requst_id to it,
+so that the request can be traced. The same should happen when `SecondService` calls the `ThirdService`.   
+
+The bottomline is whenever there is a communication between two services, 
+source service should always pass the request id to the destination service.
+
+## How to pass request id tag to downstream services
+When a request id is generated `rails_distributed_tracing` holds that request id till the request returns the response. You can access that request_id anywhere in your application code with the help of below APIs.
+
+```ruby
+DistributedTracing.current_request_id
+```
+
+or you can directly get it as a request header
+
+```ruby
+DistributedTracing.request_id_header
+#=> {'Request-ID' => '8ed7e37b-94e8-4875-afb4-6b4cf1783817'}
+```
+
+The gem will automatically pick the `Request-ID` header from your request and use it as log tag.
+
+Note: Make sure that you always pass the current request id and not the stale one.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/ajitsing/rails_distributed_tracing/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## License
+```LICENSE
+MIT License
+
+Copyright (c) 2018 Ajit Singh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+

data/lib/rails_distributed_tracing.rb

@@ -1,2 +1,5 @@
 project_root = File.dirname(File.absolute_path(__FILE__))
-Dir.glob(project_root + '/rails_distributed_tracing/**/*.rb', &method(:require))
+Dir.glob(project_root + '/rails_distributed_tracing/*.rb', &method(:require))
+
+require 'rails_distributed_tracing/plugins/faraday' if defined?(Faraday::Middleware)
+require 'rails_distributed_tracing/plugins/sidekiq' if defined?(Sidekiq)

data/lib/rails_distributed_tracing/distributed_tracing.rb

@@ -1,20 +1,20 @@
-require_relative './request_id_store'
+require 'rails_distributed_tracing/trace_id_store'
 
 module DistributedTracing
-  REQUEST_HEADER_KEY = 'Request-ID'
+  TRACE_ID = 'Request-ID'.freeze
 
-  def self.request_id_tag
+  def self.log_tag
     lambda do |request|
-      request_id = request.headers[REQUEST_HEADER_KEY] || request.request_id
-      RequestIDStore.request_id = request_id
+      request_id = request.headers[TRACE_ID] || request.request_id
+      TraceIdStore.trace_id = request_id
     end
   end
 
-  def self.request_id_header
-    {REQUEST_HEADER_KEY => RequestIDStore.request_id}
+  def self.trace_id
+    TraceIdStore.trace_id
   end
 
-  def self.current_request_id
-    RequestIDStore.request_id
+  def self.trace_id=(id)
+    TraceIdStore.trace_id = id
   end
 end

data/lib/rails_distributed_tracing/plugins/faraday.rb

@@ -0,0 +1,8 @@
+module DistributedTracing
+  class FaradayMiddleware < ::Faraday::Middleware
+    def call(env)
+      env[:request_headers].merge!({DistributedTracing::TRACE_ID => DistributedTracing.trace_id})
+      @app.call(env)
+    end
+  end
+end

data/lib/rails_distributed_tracing/plugins/sidekiq.rb

@@ -0,0 +1,29 @@
+module DistributedTracing
+  module SidekiqMiddleware
+    class Client
+      def call(worker_class, job, queue, redis_pool)
+        job[DistributedTracing::TRACE_ID] = trace_id
+        yield
+      end
+
+      private
+      def trace_id
+        DistributedTracing.trace_id || SecureRandom.uuid
+      end
+    end
+
+    class Server
+      def call(worker, job, queue)
+        logger = worker.logger
+
+        if logger.respond_to?(:tagged)
+          DistributedTracing.trace_id = job[DistributedTracing::TRACE_ID]
+          logger.tagged(DistributedTracing.trace_id) {yield}
+          DistributedTracing.trace_id= nil
+        else
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/rails_distributed_tracing/trace_id_store.rb

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

data/lib/rails_distributed_tracing/version.rb

@@ -1,3 +1,3 @@
 module DistributedTracing
-  VERSION = '0.0.2'
+  VERSION = '1.0'
 end

data/spec/lib/distributed_tracing_spec.rb

@@ -7,16 +7,16 @@ describe DistributedTracing do
       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)
+      expect(DistributedTracing.log_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({DistributedTracing::REQUEST_HEADER_KEY => request_id})
+      expect(request).to receive(:headers).and_return({DistributedTracing::TRACE_ID => request_id})
 
-      expect(DistributedTracing.request_id_tag.call(request)).to eq(request_id)
+      expect(DistributedTracing.log_tag.call(request)).to eq(request_id)
     end
   end
 
@@ -25,24 +25,11 @@ describe DistributedTracing do
       request = double('request')
       request_id = '00bfc934-b429-4606-b0c8-318ffa82e884'
 
-      expect(request).to receive(:headers).and_return({DistributedTracing::REQUEST_HEADER_KEY => request_id})
+      expect(request).to receive(:headers).and_return({DistributedTracing::TRACE_ID => request_id})
 
-      DistributedTracing.request_id_tag.call(request)
+      DistributedTracing.log_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({DistributedTracing::REQUEST_HEADER_KEY => request_id})
-
-      DistributedTracing.request_id_tag.call(request)
-
-      expect(DistributedTracing.request_id_header).to eq({DistributedTracing::REQUEST_HEADER_KEY => request_id})
+      expect(DistributedTracing.trace_id).to eq(request_id)
     end
   end
 end

data/spec/lib/plugins/faraday_spec.rb

@@ -0,0 +1,18 @@
+module Faraday; end
+class Faraday::Middleware
+  attr_accessor :app
+end
+
+load 'lib/rails_distributed_tracing.rb'
+
+describe DistributedTracing::FaradayMiddleware do
+  it 'should add trace id header to request headers' do
+    DistributedTracing::TraceIdStore.trace_id = '00bfc934-b429-4606-b0c8-318ffa82e884'
+    middleware = DistributedTracing::FaradayMiddleware.new
+    middleware.app = double(:app)
+
+    expect(middleware.app).to receive(:call).with({request_headers: {DistributedTracing::TRACE_ID => DistributedTracing.trace_id}})
+
+    middleware.call({request_headers: {}})
+  end
+end

data/spec/lib/plugins/sidekiq_spec.rb

@@ -0,0 +1,55 @@
+module Sidekiq; end
+
+load 'lib/rails_distributed_tracing.rb'
+
+describe DistributedTracing::SidekiqMiddleware do
+  describe DistributedTracing::SidekiqMiddleware::Client do
+    it 'should add trace id parameter to job' do
+      DistributedTracing::TraceIdStore.trace_id = '00bfc934-b429-4606-b0c8-318ffa82e884'
+      middleware = DistributedTracing::SidekiqMiddleware::Client.new
+
+      job = {}
+      middleware.call(nil, job, nil, nil) {}
+
+      expect(job).to eq({DistributedTracing::TRACE_ID => DistributedTracing.trace_id})
+    end
+
+    it 'should add random trace id parameter to job when request id is not present' do
+      middleware = DistributedTracing::SidekiqMiddleware::Client.new
+
+      job = {}
+      middleware.call(nil, job, nil, nil) {}
+
+      expect(job[DistributedTracing::TRACE_ID]).to_not be_nil
+    end
+  end
+
+  describe DistributedTracing::SidekiqMiddleware::Server do
+    let(:worker) {double(:worker)}
+    let(:logger) {double(:logger)}
+    let(:trace_id) {'00bfc934-b429-4606-b0c8-318ffa82e884'}
+
+    it 'should log trace id as tag for tagger logger' do
+      middleware = DistributedTracing::SidekiqMiddleware::Server.new
+      job = {DistributedTracing::TRACE_ID => trace_id}
+
+      expect(worker).to receive(:logger).and_return(logger)
+
+      expect(DistributedTracing).to receive(:trace_id=).with(trace_id).ordered
+      expect(logger).to receive(:tagged).with(trace_id).ordered
+      expect(DistributedTracing).to receive(:trace_id=).with(nil).ordered
+
+      middleware.call(worker, job, nil) {}
+    end
+
+    it 'should skip trace id logging for a non tagged logger' do
+      middleware = DistributedTracing::SidekiqMiddleware::Server.new
+      job = {DistributedTracing::TRACE_ID => trace_id}
+
+      expect(worker).to receive(:logger).and_return(double(:logger))
+      expect(logger).to_not receive(:tagged)
+
+      middleware.call(worker, job, nil) {}
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_distributed_tracing
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: '1.0'
 platform: ruby
 authors:
 - Ajit Singh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-17 00:00:00.000000000 Z
+date: 2018-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,14 +46,21 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
+- README.md
 - lib/rails_distributed_tracing.rb
 - lib/rails_distributed_tracing/distributed_tracing.rb
-- lib/rails_distributed_tracing/request_id_store.rb
+- lib/rails_distributed_tracing/plugins/faraday.rb
+- lib/rails_distributed_tracing/plugins/sidekiq.rb
+- lib/rails_distributed_tracing/trace_id_store.rb
 - lib/rails_distributed_tracing/version.rb
 - rails_distributed_tracing.gemspec
 - spec/lib/distributed_tracing_spec.rb
+- spec/lib/plugins/faraday_spec.rb
+- spec/lib/plugins/sidekiq_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ajitsing/rails_distributed_tracing
 licenses:
@@ -83,4 +90,6 @@ summary: Microservices distributed tracing The gem generates a request id which
   of this gem.
 test_files:
 - spec/lib/distributed_tracing_spec.rb
+- spec/lib/plugins/faraday_spec.rb
+- spec/lib/plugins/sidekiq_spec.rb
 - spec/spec_helper.rb

data/lib/rails_distributed_tracing/request_id_store.rb

@@ -1,15 +0,0 @@
-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