ilove-tracing 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4be119c8bc6ab1a3cdec05a0784a4149143fe269970cace3c12a1e0af6df8e2a
+  data.tar.gz: 9d4d1b918e6d64a3a2ee88ee023616b397d9006d9f143682acbf7f8e43b7d2a5
+SHA512:
+  metadata.gz: 842832d1f09cb3635b663c06d9c98762b9a0a4dbb906244b9a73ca17a7d9b38d1a2f3091401e946732198838f1c4306bf09aa919642c4fc2beabfda378c8f859
+  data.tar.gz: 16a2ede0dccfea191271afcf915ad5450feea5c4ed27909b593bd05a671e7ae5bab7d56920e753138cb0c6f291add17c0bbe5576d74c20756f706e71848b5ed8

data/.circleci/config.yml

@@ -0,0 +1,46 @@
+version: 2.1
+
+parameters:
+  project_name:
+    type: string
+    default: ilove-tracing
+  ruby_image:
+    type: string
+    default: circleci/ruby:2.6.5
+
+jobs:
+  test_app_code:
+    parameters:
+      cache_name:
+        type: string
+        default: << pipeline.parameters.project_name >>-cache-{{ checksum "<< pipeline.parameters.project_name >>.gemspec" }}
+    working_directory: ~/src
+    docker:
+      - image: << pipeline.parameters.ruby_image >>
+    steps:
+      - checkout
+      - setup_remote_docker:
+          docker_layer_caching: true
+      - restore_cache:
+          keys:
+            - << parameters.cache_name >>
+      - run:
+          name: Bundle install
+          command: bundle install --path ~/.bundler
+      - save_cache:
+          key: << parameters.cache_name >>
+          paths:
+            - ~/.bundler
+      - run:
+          name: Rspec
+          command: bundle exec rspec --out /tmp/test-results/rspec.xml
+
+workflows:
+  version: 2
+  app:
+    jobs:
+      - test_app_code:
+          filters:
+            tags:
+              only: /.*/
+

data/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+* @uno4ki
+.circleci/ @pcheliniy
+*.rb @severgroup-tt/ruby
+

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.3

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# 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).
+
+## 0.1.0 - 2020-03-05
+
+### Added
+ * Tracing of
+     - Rack http requests
+     - ActiveRecord sql
+     - Twrip service calls
+     - Faraday outgoing requests 
+ * Pass request id from incoming to outgoing requests

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at a.zimin@talenttech.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,169 @@
+PATH
+  remote: .
+  specs:
+    ilove-tracing (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      mail (>= 2.7.1)
+    actionmailer (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.2.1)
+      actionview (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      globalid (>= 0.3.6)
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activestorage (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      marcel (~> 0.3.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    google-protobuf (3.11.4-universal-darwin)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    multipart-post (2.1.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.8)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.2.1)
+      actioncable (= 6.0.2.1)
+      actionmailbox (= 6.0.2.1)
+      actionmailer (= 6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actiontext (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      bundler (>= 1.3.0)
+      railties (= 6.0.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    twirp (1.4.1)
+      faraday (~> 0)
+      google-protobuf (~> 3.0, >= 3.0.0)
+    twirp_rails (0.3.0)
+      railties (~> 6.0)
+      twirp (~> 1)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  ilove-tracing!
+  rails (~> 6.0)
+  rake (>= 12.3.3)
+  rspec (~> 3.0)
+  twirp_rails (~> 0.3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alexandr Zimin
+
+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,86 @@
+# I love tracing
+
+Help to trace rack based applications and microservices. Create opentracing spans on:
+ - [Rack http requests](#tracing-rack-http-requests)
+ - [ActiveRecord sql](#tracing-activerecord-sql)
+ - [Twrip service calls](#tracing-twrip_rails-service-calls)
+ - [Faraday outgoing requests](#tracing-faraday-outgoing-requests)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ilove-tracing'
+gem 'opentracing'
+
+gem 'jaeger-client' # or other opentracing client implementation
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Create and customize the initializer file:
+
+```sh
+$ rails g tracing:init
+```
+
+This creates `initializers/ilove-tracing.rb` file. 
+
+_N.B. If you not use Rails - copy it from gem sources 
+`cp $(bundle show ilove-tracing)/lib/generators/tracing/init/templates/ilove_tracing.rb ./`_ 
+
+## Tracing Rack http requests
+
+Tracer creates opentracing span named `incoming http request` with parent of incoming http context.
+
+## Tracing ActiveRecord SQL
+
+Creates span of all executed queries named `sql.active_record`. Tags sql.name, sql.statement, sql.statement_name.
+
+## Tracing twrip_rails service calls
+
+Instrument all twirp services mounted by twirp_rails. Creates span named `twirp call` on incoming twirp calls. 
+Tags: `service`, `method`. 
+
+To trace twirp services without twirp_rails call 
+```ruby
+require 'ilove/tracing/twirp.rb'
+
+ILove::Tracing::Twirp.trace_service(service)
+```
+
+## Tracing faraday outgoing requests
+
+Instrument all faraday outgoing requests. Creates span named `outgoing http request`. 
+Inject active span to request headers. 
+Tags: `url`, `method`. 
+
+_N.B. This option uses monkey patch of `Faraday::ConnectionOptions` to inject middleware to all faraday 
+(and twirp clients) requests._
+
+## Pass request_id header from incoming requests to outgoing requests.
+
+If this options turned on (default if `config.enabled?`) then header `X-Request-Id` from incoming http requests passed to outgoing.
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/severgroup-tt/ilove-tracing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ilove::Tracing project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ilove-tracing/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ilove-tracing.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ilove/tracing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ilove-tracing'
+  spec.version       = ILove::Tracing::VERSION
+  spec.authors       = ['Alexandr Zimin']
+  spec.email         = ['a.zimin@talenttech.ru']
+
+  spec.summary       = 'Opentracing plugins to instrument rails, twirp_rails, faraday, active_record.'
+  spec.description   = 'Opentracing plugins to instrument rails, twirp_rails, faraday, active_record.'
+  spec.homepage      = 'http://github.com/severgroup-tt/ilove-tracing'
+  spec.license       = 'MIT'
+
+  # 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'] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'http://github.com/severgroup-tt/ilove-tracing'
+    spec.metadata['changelog_uri'] = 'http://github.com/severgroup-tt/ilove-tracing/blob/master/CHANGELOG.md'
+  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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0")
+                     .reject { |f| f.match(%r{^(bin|doc|test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rails', '~> 6.0'
+  spec.add_development_dependency 'twirp_rails', '~> 0.3.0'
+end

data/lib/generators/tracing/init/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate init
+
+    This will create:
+        what/will/it/create

data/lib/generators/tracing/init/init_generator.rb

@@ -0,0 +1,10 @@
+module Tracing
+  class InitGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    desc 'This generator creates an initializer file at config/initializers'
+    def create_initializer_file
+      copy_file 'ilove_tracing.rb', 'config/initializers/ilove_tracing.rb'
+    end
+  end
+end

data/lib/generators/tracing/init/templates/ilove_tracing.rb

@@ -0,0 +1,39 @@
+ILove::Tracing.configure do |config|
+  # Enable tracing (default false - tracing disabled)
+  config.enabled = ENV['JAEGER_HOST'].present?
+
+  # Service name (with rails Rails.application.class.parent_name else nil)
+  # config.service_name = Rails.application.class.parent_name
+
+  # Tracing client :jaeger, :none or initialized client instance (default :jaeger)
+  # config.client = :jaeger
+
+  # Tracing client params (client initializer arguments)
+  # config.client_params do
+  #   {
+  #     host: ENV.fetch('JAEGER_HOST') { 'localhost' },
+  #     port: ENV.fetch('JAEGER_PORT') { 6831 },
+  #     service_name: config.service_name
+  #   }
+  # end
+
+  # Trace all rack http requests (default true)
+  # if it tuned off - cross application tracing doesnt work
+  # config.trace_incoming_requests = true
+
+  # Trace all http faraday requests (default true)
+  # if it tuned off - cross application tracing doesnt work
+  # config.trace_outgoing_requests = true
+
+  # Trace twirp incoming requests (default true)
+  # config.trace_twirp_requests = true
+
+  # Trace sql queries (default true)
+  # config.trace_sql = true
+
+  # Pass request id from incoming requests to outgoing requests (default true)
+  # config.pass_request_id = true
+
+  # request id header name (default 'X-Request-Id')
+  # config.request_id_header = 'X-Request-Id'
+end

data/lib/ilove/tracing.rb

@@ -0,0 +1,140 @@
+require 'ilove/tracing/version'
+require 'active_support/dependencies'
+
+module ILove
+  module Tracing
+    class Configuration
+      def self.config_param(symbol, default_value = nil, &block)
+        raise 'wrong args' if !default_value.nil? && block_given?
+
+        if block_given?
+          class_variable_set("@@#{symbol}_default", block)
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+            def #{symbol}_default
+              instance_eval &@@#{symbol}_default
+            end
+          RUBY
+        else
+          class_variable_set("@@#{symbol}_default", default_value)
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+            def #{symbol}_default
+              @@#{symbol}_default
+            end
+          RUBY
+        end
+
+        class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+          def #{symbol}
+            @#{symbol} ||= #{symbol}_default
+          end
+        RUBY
+
+        class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+          def #{symbol}?
+            #{symbol}
+          end
+
+          def #{symbol}=(value)
+            @#{symbol} = value
+          end
+        RUBY
+      end
+
+
+      # Enable tracing (false), if it false - tracing disabled
+      config_param :enabled, false
+
+      # Service name (with rails Rails.application.class.parent_name else nil)
+      config_param(:service_name) { defined?(Rails) ? Rails.application.class.parent_name : nil }
+
+      # Tracing client (:jaeger) - :jaeger, :none or initialized client instance
+      config_param :client, :jaeger
+
+      # Tracing client params
+      # host: ENV.fetch('JAEGER_HOST') { 'localhost' },
+      # port: ENV.fetch('JAEGER_PORT') { 6831 },
+      # service_name: service_name
+      config_param(:client_params) do
+        {
+          host: ENV.fetch('JAEGER_HOST') { 'localhost' },
+          port: ENV.fetch('JAEGER_PORT') { 6831 },
+          service_name: service_name
+        }
+      end
+
+      # Trace all rack http requests (true)
+      # if it tuned off - cross application tracing doesnt work
+      config_param :trace_incoming_requests, true
+
+      # Trace all http faraday requests (true)
+      # if it tuned off - cross application tracing doesnt work
+      config_param :trace_outgoing_requests, true
+
+      # Trace twirp incoming requests (true)
+      config_param :trace_twirp_requests, true
+
+      # Trace sql queries (true)
+      config_param :trace_sql, true
+
+      # Pass request id from incoming requests to outgoing requests (true)
+      config_param :pass_request_id, true
+
+      # Pass request id from incoming requests to outgoing requests (true)
+      config_param :request_id_header, 'X-Request-Id'
+    end
+
+    def self.configuration
+      @cfg
+    end
+
+    def self.configure(&_block)
+      @cfg = Configuration.new
+      yield @cfg
+      setup @cfg
+    end
+
+    def self.setup(cfg)
+      return unless cfg.enabled?
+
+      require_relative 'tracing/client'
+
+      ILove::Tracing::Client.setup cfg
+
+      if cfg.trace_incoming_requests?
+        require_relative 'tracing/incoming_requests'
+
+        ILove::Tracing::IncomingRequests.setup cfg
+      end
+
+      if cfg.trace_outgoing_requests?
+        require_relative 'tracing/outgoing_requests'
+
+        ILove::Tracing::OutgoingRequests.setup cfg
+      end
+
+      if cfg.trace_twirp_requests?
+        require_relative 'tracing/twirp'
+
+        ILove::Tracing::Twirp.setup cfg
+      end
+
+      if cfg.trace_sql?
+        require_relative 'tracing/sql'
+
+        ILove::Tracing::Sql.setup cfg
+      end
+
+      if cfg.pass_request_id?
+        require_relative 'tracing/request_id'
+
+        ILove::Tracing::RequestId.setup cfg
+      end
+
+      if cfg.pass_request_id? || cfg.trace_outgoing_requests?
+        ILove::Tracing::FaradayMiddleware.setup cfg
+      end
+    end
+
+    class Error < StandardError; end
+  end
+end

data/lib/ilove/tracing/client.rb

@@ -0,0 +1,20 @@
+module ILove
+  module Tracing
+    module Client
+      def self.setup(cfg)
+        case cfg.client
+        when :jaeger
+          require('jaeger/client') rescue raise("Add gem 'jaeger-client' to Gemfile")
+
+          OpenTracing.global_tracer = Jaeger::Client.build(cfg.client_params)
+        when :none
+          nil
+        when Symbol
+          raise "Unknown client #{cfg.client}"
+        else
+          OpenTracing.global_tracer = cfg.client
+        end
+      end
+    end
+  end
+end

data/lib/ilove/tracing/faraday_middleware.rb

@@ -0,0 +1,32 @@
+module ILove
+  module Tracing
+    module FaradayMiddleware
+      @@active_middleware = Set.new
+
+      def self.active_middleware
+        @@active_middleware
+      end
+
+      def self.add_active_middleware(middleware)
+        @@active_middleware << middleware
+      end
+
+      module FaradayConnectionOptions
+        def new_builder(block)
+          super.tap do |builder|
+            ILove::Tracing::FaradayMiddleware.active_middleware.each do |middleware|
+              builder.insert(0, middleware)
+            end
+          end
+        end
+      end
+
+      def self.setup(cfg)
+        return if active_middleware.empty?
+        raise 'Faraday is not defined, can not add required outgoing middleware' unless defined?(Faraday)
+
+        Faraday::ConnectionOptions.prepend(FaradayConnectionOptions)
+      end
+    end
+  end
+end

data/lib/ilove/tracing/incoming_requests.rb

@@ -0,0 +1,28 @@
+module ILove
+  module Tracing
+    module IncomingRequests
+      class TraceRackMiddleware
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          extracted_ctx = OpenTracing.global_tracer.extract(OpenTracing::FORMAT_RACK, env)
+          span = OpenTracing.start_span('incoming http request', child_of: extracted_ctx)
+          scope = OpenTracing.scope_manager.activate span
+
+          @app.call(env)
+        ensure
+          scope.close
+        end
+      end
+
+
+      def self.setup(cfg)
+        raise 'incoming requests tracing requires rails' unless defined?(Rails)
+
+        Rails.application.middleware.unshift TraceRackMiddleware
+      end
+    end
+  end
+end

data/lib/ilove/tracing/outgoing_requests.rb

@@ -0,0 +1,27 @@
+require_relative 'faraday_middleware'
+
+module ILove
+  module Tracing
+    module OutgoingRequests
+      class FaradayTraceMiddleware < Faraday::Middleware
+        def call(env)
+          scope = OpenTracing.start_active_span 'outgoing http request',
+                                                child_of: OpenTracing.active_span,
+                                                tags: { url: env.url, method: env.method }
+
+          OpenTracing.inject scope.span.context, OpenTracing::FORMAT_RACK, env[:request_headers]
+
+          @app.call(env).on_complete do
+            scope.close
+          end
+        end
+      end
+
+      def self.setup(cfg)
+        raise 'Cannot trace outgoing request without Faraday' unless defined?(Faraday)
+
+        ILove::Tracing::FaradayMiddleware.add_active_middleware FaradayTraceMiddleware
+      end
+    end
+  end
+end

data/lib/ilove/tracing/request_id.rb

@@ -0,0 +1,54 @@
+require_relative 'faraday_middleware'
+
+module ILove
+  module Tracing
+    module RequestId
+      def self.cfg
+        @@cfg
+      end
+
+      def self.request_id
+        Thread.current[:request_id]
+      end
+
+      def self.request_id=(val)
+        Thread.current[:request_id] = val
+      end
+
+      class RequestIdRackMiddleware
+        def initialize(app)
+          @app = app
+        end
+
+        def rack_header_name
+          @@rack_header_name ||= 'HTTP_' + ILove::Tracing::RequestId.cfg.request_id_header.gsub(/-/, '_').upcase
+        end
+
+        def call(env)
+          ILove::Tracing::RequestId.request_id = env[rack_header_name]
+
+          @app.call(env)
+        ensure
+          ILove::Tracing::RequestId.request_id = nil
+        end
+      end
+
+      class RequestIdFaradayMiddleware < Faraday::Middleware
+        def call(env)
+          env.request_headers[ILove::Tracing::RequestId.cfg.request_id_header] = ILove::Tracing::RequestId.request_id
+
+          @app.call(env)
+        end
+      end
+
+      def self.setup(cfg)
+        raise 'pass request id requires rails' unless defined?(::Rails)
+        raise 'pass request id requires faraday' unless defined?(::Faraday)
+
+        @@cfg = cfg
+        Rails.application.middleware.unshift RequestIdRackMiddleware
+        ILove::Tracing::FaradayMiddleware.add_active_middleware RequestIdFaradayMiddleware
+      end
+    end
+  end
+end

data/lib/ilove/tracing/sql.rb

@@ -0,0 +1,22 @@
+module ILove
+  module Tracing
+    module Sql
+      def self.setup(_cfg)
+        raise 'Cannot trace sql without ActiveSupport' unless defined?(::ActiveSupport)
+
+        ActiveSupport::Notifications.subscribe('sql.active_record') do |_name, start, finish, _id, payload|
+          span = OpenTracing.start_span 'sql.active_record',
+                                        start_time: start,
+                                        child_of: OpenTracing.active_span,
+                                        tags: {
+                                          'sql.statement' => payload[:sql],
+                                          'sql.statement_name' => payload[:statement_name],
+                                          'sql.name' => payload[:name]
+                                        }
+
+          span.finish end_time: finish
+        end
+      end
+    end
+  end
+end

data/lib/ilove/tracing/twirp.rb

@@ -0,0 +1,49 @@
+module ILove
+  module Tracing
+    module Twirp
+      def self.setup(cfg)
+        raise 'Cannot trace twirp without twirp_rails gem' unless defined?(::TwirpRails)
+
+        ::TwirpRails::Routes::Helper.on_create_service do |service|
+          trace_service service
+        end
+      end
+
+      def self.trace_service(service)
+        scope = nil
+
+        service.before do |_rack_env, env|
+          method_name = env[:rpc_method]
+
+          scope = OpenTracing.start_active_span 'twirp call',
+                                                child_of: OpenTracing.active_span,
+                                                tags: { service: service.full_name, method: method_name }
+        end
+
+        service.on_error do |err, _env|
+          if scope
+            scope.span.set_tag :error_code, err.code
+            scope.span.set_tag :error_msg, err.msg
+            scope.close
+            scope = nil
+          end
+        end
+
+        service.on_success do |_env|
+          if scope
+            scope.close
+            scope = nil
+          end
+        end
+
+        service.exception_raised do |e, _env|
+          if scope
+            scope.span.set_tag :exception, e.class.name
+            scope.close
+            scope = nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ilove/tracing/version.rb

@@ -0,0 +1,5 @@
+module ILove
+  module Tracing
+    VERSION = "0.2.0"
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: ilove-tracing
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alexandr Zimin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: twirp_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: Opentracing plugins to instrument rails, twirp_rails, faraday, active_record.
+email:
+- a.zimin@talenttech.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".github/CODEOWNERS"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ilove-tracing.gemspec
+- lib/generators/tracing/init/USAGE
+- lib/generators/tracing/init/init_generator.rb
+- lib/generators/tracing/init/templates/ilove_tracing.rb
+- lib/ilove/tracing.rb
+- lib/ilove/tracing/client.rb
+- lib/ilove/tracing/faraday_middleware.rb
+- lib/ilove/tracing/incoming_requests.rb
+- lib/ilove/tracing/outgoing_requests.rb
+- lib/ilove/tracing/request_id.rb
+- lib/ilove/tracing/sql.rb
+- lib/ilove/tracing/twirp.rb
+- lib/ilove/tracing/version.rb
+homepage: http://github.com/severgroup-tt/ilove-tracing
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/severgroup-tt/ilove-tracing
+  source_code_uri: http://github.com/severgroup-tt/ilove-tracing
+  changelog_uri: http://github.com/severgroup-tt/ilove-tracing/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Opentracing plugins to instrument rails, twirp_rails, faraday, active_record.
+test_files: []