ygrene_istio_tracing 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 667117a1dbd6ed934cab51547d6d9577fcea2099906d1813fc0dbf743a1d872d
+  data.tar.gz: 8bfa727b291c112b1c634110d713fc852dd61056db82f8ef390b974b69cc1fd9
+SHA512:
+  metadata.gz: 88d7f68cf1025ffe4626b60353a3ae98167a9936a829f2447309c2bc3a772f9e0528ce57e783ef12c086b399f8a446c0d66f871a0184af859626721c283135c9
+  data.tar.gz: a5ad51f752f35faaeec3f41e32d3334c9b942be07dca72b52c3f851b8738159bc34b4ef1f60a37d2bfa2c57db4cfb750d076d1ddc99964358146cb50e708d5d0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in istio.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    ygrene_istio_tracing (1.0.0)
+      typhoeus (~> 1.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.2)
+      actionview (= 5.2.2)
+      activesupport (= 5.2.2)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.2)
+      activesupport (= 5.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.3)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    httparty (0.16.3)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.2.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    public_suffix (3.0.3)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.2)
+      actionpack (= 5.2.2)
+      activesupport (= 5.2.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      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-rails (3.8.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  httparty (~> 0.16.3)
+  rack
+  rake (~> 10.0)
+  rspec-rails
+  webmock (~> 3.3.0)
+  ygrene_istio_tracing!
+
+BUNDLED WITH
+   1.16.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Wantedly, Inc., Ygrene Energy Fund
+
+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,23 @@
+# Ygrene Istio Tracing Gem
+
+Rails instrumentation gem for Istio service mesh (https://istio.io/).
+
+This gem lets your Rails services propagate b3 http headers for distributed tracing with Istio.
+It propigates headers to Net::Http and Typhoeus(uses libcurl)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ygrene_istio_tracing'
+```
+## Usage
+
+Installed into the rails-setup gem for ygrene usage.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'istio'
+
+# 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(__FILE__)

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/istio.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'istio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ygrene_istio_tracing'
+  spec.version       = Istio::VERSION
+  spec.authors       = ['Austin Adams']
+  spec.email         = ['me@austbot.com']
+
+  spec.summary       = 'Ruby gem for Istio service mesh (https://istio.io/)'
+  spec.description   = 'This gem lets your rails app propagate http headers for distributed tracing with Istio.'
+  spec.homepage      = 'https://github.com/ygrene/ygrene-istio-tracing'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'typhoeus', '~> 1.3.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails'
+
+  spec.add_development_dependency 'webmock', ['~>3.3.0']
+  spec.add_development_dependency 'httparty', ['~>0.16.3']
+end

data/lib/istio/tracing/context.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Istio
+  module Tracing
+    class NotSetError < ::StandardError
+      def initialize
+        super('Context is not set for this thread')
+      end
+    end
+
+    class Context
+      VAR_NAME = :_istio_tracing_context_
+
+      class << self
+        def current
+          Thread.current.thread_variable_get(VAR_NAME) || raise(NotSetError)
+        end
+
+        def with_given_context(ctx)
+          Thread.current.thread_variable_set(VAR_NAME, ctx)
+          yield
+        ensure
+          remove_current
+        end
+
+        def exists_current?
+          !!Thread.current.thread_variable_get(VAR_NAME)
+        end
+
+        def build_current(headers)
+          Thread.current.thread_variable_set(VAR_NAME, Context.new(headers))
+        end
+
+        def remove_current
+          Thread.current.thread_variable_set(VAR_NAME, nil)
+        end
+      end
+
+      attr_reader :headers
+
+      def initialize(headers)
+        @headers = headers
+      end
+    end
+  end
+end

data/lib/istio/tracing/header.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Istio
+  module Tracing
+    PROPAGATION_HEADERS = %w[
+      x-request-id
+      x-b3-traceid
+      x-b3-spanid
+      x-b3-parentspanid
+      x-b3-sampled
+      x-b3-flags
+      x-ot-span-context
+      X-REQUEST-ID
+      X-B3-TRACEID
+      X-B3-SPANID
+      X-B3-PARENTSPANID
+      X-B3-SAMPLED
+      X-B3-FLAGS
+      X-OT-SPAN-CONTEXT
+    ].freeze
+  end
+end

data/lib/istio/tracing/http.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'typhoeus'
+
+module Istio
+  module NetHttp
+    module ClassInterceptor
+      def new(*options)
+        o = super(*options)
+        o
+      end
+    end
+    module InstanceInterceptor
+      def initialize(*options)
+        super(*options)
+      end
+
+      def request(req, *args, &block)
+        return super unless Context.exists_current?
+
+        headers = Context.current.headers
+        PROPAGATION_HEADERS.each do |h|
+          req[h] = headers[h] if headers[h].present?
+        end
+        super
+      end
+    end
+  end
+end
+
+::Net::HTTP.singleton_class.prepend Istio::NetHttp::ClassInterceptor
+::Net::HTTP.prepend Istio::NetHttp::InstanceInterceptor
+
+module Typhoeus
+  Typhoeus.before do |req|
+    return req unless Istio::Tracing::Context.exists_current?
+
+    headers = Istio::Tracing::Context.current.headers
+    Istio::Tracing::PROPAGATION_HEADERS.each do |h|
+      req.options[:headers][h] = headers[h] unless headers[h]&.nil?
+    end
+    req
+  end
+end

data/lib/istio/tracing/rack.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Istio
+  module Tracing
+    class RackMiddleware
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        Context.build_current(extract_http_headers(env))
+        @app.call(env)
+      ensure
+        Context.remove_current
+      end
+
+      def extract_http_headers(env)
+        env.select { |k, _v| PROPAGATION_HEADERS.include?(k.downcase) }
+      end
+    end
+  end
+end

data/lib/istio/tracing/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module Istio
+  module Tracing
+    class Railtie < ::Rails::Railtie
+      initializer 'istio.tracing.rack_middleware' do |app|
+        app.middleware.use(::Istio::Tracing::RackMiddleware)
+      end
+    end
+  end
+end

data/lib/istio/tracing.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'istio/tracing/context'
+require 'istio/tracing/header'
+require 'istio/tracing/http'
+require 'istio/tracing/rack'
+
+begin
+  require 'rails/railtie'
+  require 'istio/tracing/railtie'
+rescue LoadError
+end

data/lib/istio/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Istio
+  VERSION = '1.0.0'
+end

data/lib/istio.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'istio/version'
+require 'istio/tracing'

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: ygrene_istio_tracing
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Austin Adams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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: rspec-rails
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.3
+description: This gem lets your rails app propagate http headers for distributed tracing
+  with Istio.
+email:
+- me@austbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- istio.gemspec
+- lib/istio.rb
+- lib/istio/tracing.rb
+- lib/istio/tracing/context.rb
+- lib/istio/tracing/header.rb
+- lib/istio/tracing/http.rb
+- lib/istio/tracing/rack.rb
+- lib/istio/tracing/railtie.rb
+- lib/istio/version.rb
+homepage: https://github.com/ygrene/ygrene-istio-tracing
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: Ruby gem for Istio service mesh (https://istio.io/)
+test_files: []