vestige 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19accfcc39cbff1dfd2abeeda518b8acd1204a9e
+  data.tar.gz: 5f564253bcf79090757f964456bbbd7a741c6bd3
+SHA512:
+  metadata.gz: 50dd291006b14a4fd0e84a8419444c4920973ae51b6026d2c0e966e3514bb73865e934579e7a8807ec001b15a1313d52fc2ca9ae3c47eeaf725219ad5b592ea2
+  data.tar.gz: 427c7853f0aa6547bbd4b181e7910889fb2ce4f2396d4098cc8cfc4db6a39a096079207f4d8edd88b46716e74fafa4f413a91db2f712b9dca90023f244b9bd53

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vestige.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pavel Penkov
+
+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,72 @@
+# Vestige
+
+Distributed tracing for Rails applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vestige'
+```
+
+## Usage
+
+Vestige relies on `ActionDispatch::RequestId` middleware to generate request id, saves it to thread local variable accessible as `Vestige.trace_id` and forwards it to different API clients to enable cross-application tracing. At the moment it's tightly coupled with Rails and supports Sidekiq, delayed_job and Faraday.
+
+### Sidekiq
+
+Add client and server middlewares to `config/initializers/sidekiq.rb`
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.logger.formatter = Vestige::Sidekiq::Formatter.new
+
+  config.server_middleware do |chain|
+    chain.add Vestige::Sidekiq::Server
+  end
+
+  config.client_middleware do |chain| # Fan-out support
+    chain.add Vestige::Sidekiq::Client
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.logger.formatter = Vestige::Sidekiq::Formatter.new
+
+  config.client_middleware do |chain|
+    chain.add Vestige::Sidekiq::Client
+  end
+end
+```
+
+### delayed_job
+
+Run `rails g vestige:delayed_job:install && rake db:migrate` to add `trace_id` column. Add plugin to `config/initializers/delayed_job.rb`
+
+```ruby
+Delayed::Worker.plugins << Vestige::DelayedJob::Plugin
+```
+
+### Faraday
+
+Add middleware to Faraday stack
+
+```ruby
+connection = Faraday.new("http://example.com") do |conn|
+  conn.request :vestige
+  conn.response :logger, Rails.logger
+end
+```
+
+### Net::HTTP
+
+Call `Vestige.patch_net_http!` in initializer
+
+You'll probably want to tag Rails log as well by adding `config.log_tags = [:uuid]` to `config/application.rb`
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vestige"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vestige.rb

@@ -0,0 +1,28 @@
+require "vestige/version"
+require "vestige/rack"
+require "vestige/net_http_patch"
+require "vestige/railtie" if defined?(Rails.application)
+
+%w(delayed_job sidekiq faraday).each do |lib|
+  begin
+    require lib
+    require "vestige/#{lib}"
+  rescue LoadError
+  end
+end
+
+module Vestige
+  TRACE_ID_KEY = "vestige_trace_id".freeze
+
+  def self.trace_id
+    Thread.current[TRACE_ID_KEY]
+  end
+
+  def self.trace_id=(trace_id)
+    Thread.current[TRACE_ID_KEY] = trace_id
+  end
+
+  def self.patch_net_http!
+    Net::HTTPGenericRequest.prepend(NetHttpPatch)
+  end
+end

data/lib/vestige/delayed_job.rb

@@ -0,0 +1,26 @@
+module Vestige
+  module DelayedJob
+    class Plugin < ::Delayed::Plugin
+      callbacks do |lifecycle|
+        lifecycle.around(:invoke_job) do |job, *args, &block|
+          begin
+            Vestige.trace_id = job.trace_id
+            if Rails.logger.respond_to?(:tagged)
+              Rails.logger.tagged(Vestige.trace_id, "delayed_job") { block.call(job, *args) }
+            else
+              block.call(job, *args)
+            end
+          ensure
+            Vestige.trace_id = nil
+          end
+        end
+
+        lifecycle.before(:enqueue) do |job, *_args, &_block|
+          job.trace_id = Vestige.trace_id
+        end
+      end
+    end
+  end
+end
+
+Delayed::Worker.plugins << Vestige::DelayedJob::Plugin

data/lib/vestige/faraday.rb

@@ -0,0 +1,14 @@
+module Vestige
+  class Faraday < ::Faraday::Middleware
+    X_REQUEST_ID = "X-Request-Id".freeze
+
+    def call(env)
+      env[:request_headers].merge!(X_REQUEST_ID => Vestige.trace_id)
+      @app.call(env)
+    end
+  end
+end
+
+if Faraday::Middleware.respond_to?(:register_middleware)
+  Faraday::Request.register_middleware(vestige: lambda { Vestige::Faraday })
+end

data/lib/vestige/generators/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module Vestige
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include ::ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Add request id column to delayed jobs"
+
+      def copy_migrations
+        migration_template "add_trace_id_to_delayed_jobs.rb", "db/migrate/add_trace_id_to_delayed_jobs.rb"
+      end
+    end
+  end
+end

data/lib/vestige/generators/templates/add_trace_id_to_delayed_jobs.rb

@@ -0,0 +1,7 @@
+class AddTraceIdToDelayedJobs < ActiveRecord::Migration
+  def change
+    change_table :delayed_jobs do |t|
+      t.string :trace_id
+    end
+  end
+end

data/lib/vestige/net_http_patch.rb

@@ -0,0 +1,10 @@
+module Vestige
+  module NetHttpPatch
+    X_REQUEST_ID = 'x-request-id'.freeze
+
+    def initialize_http_header(initheader)
+      super
+      @header[X_REQUEST_ID] = Vestige.trace_id unless (@header.key?(X_REQUEST_ID) || Vestige.trace_id.nil?)
+    end
+  end
+end

data/lib/vestige/rack.rb

@@ -0,0 +1,12 @@
+module Vestige
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Vestige.trace_id = env['action_dispatch.request_id']
+      @app.call(env)
+    end
+  end
+end

data/lib/vestige/railtie.rb

@@ -0,0 +1,12 @@
+module Vestige
+  class Railtie < ::Rails::Railtie
+    initializer "vestige.configure_rails_initialization" do
+      require_relative 'rack'
+      ::Rails.application.middleware.insert_after(::ActionDispatch::RequestId, Rack)
+    end
+
+    generators do
+      require_relative "generators/install_generator"
+    end
+  end
+end

data/lib/vestige/sidekiq.rb

@@ -0,0 +1,36 @@
+module Vestige
+  module Sidekiq
+    class Client
+      def call(_worker_class, job, _queue, _redis_pool = nil)
+        job[TRACE_ID_KEY] = Vestige.trace_id
+        yield
+      end
+    end
+
+    class Server
+      def initialize(logger = nil)
+        @logger = logger
+      end
+
+      def call(_worker, msg, _queue)
+        Vestige.trace_id = msg[TRACE_ID_KEY]
+        current_logger.respond_to?(:tagged) ? current_logger.tagged(Vestige.trace_id, "sidekiq") { yield } : yield
+      ensure
+        Vestige.trace_id = nil
+      end
+
+      private
+
+      def current_logger
+        @logger || (Rails.logger if defined?(Rails.application)) || Sidekiq.logger
+      end
+    end
+
+    class Formatter
+      def call(severity, timestamp, _progname, msg)
+        tag = Vestige.trace_id ? "[#{Vestige.trace_id}] " : ''
+        "#{tag}#{timestamp.utc.iso8601} #{::Process.pid} TID-#{Thread.current.object_id.to_s(36)} #{severity}: #{msg}\n"
+      end
+    end
+  end
+end

data/lib/vestige/version.rb

@@ -0,0 +1,3 @@
+module Vestige
+  VERSION = "0.1.0"
+end

data/vestige.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vestige/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vestige"
+  spec.version       = Vestige::VERSION
+  spec.authors       = ["Pavel Penkov"]
+  spec.email         = ["ebonfortress@gmail.com"]
+
+  spec.summary       = "Distributed tracing for Rails applications"
+  spec.description   = "Distributed tracing for Rails applications"
+  spec.homepage      = "https://github.com/PavelPenkov/vestige"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: vestige
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel Penkov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Distributed tracing for Rails applications
+email:
+- ebonfortress@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vestige.rb
+- lib/vestige/delayed_job.rb
+- lib/vestige/faraday.rb
+- lib/vestige/generators/install_generator.rb
+- lib/vestige/generators/templates/add_trace_id_to_delayed_jobs.rb
+- lib/vestige/net_http_patch.rb
+- lib/vestige/rack.rb
+- lib/vestige/railtie.rb
+- lib/vestige/sidekiq.rb
+- lib/vestige/version.rb
+- vestige.gemspec
+homepage: https://github.com/PavelPenkov/vestige
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Distributed tracing for Rails applications
+test_files: []
+has_rdoc: