opentracing-instrumentation 0.1.0

data/lib/opentracing/instrumentation/thrift/traced_protocol.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require 'thrift'
+
+module OpenTracing
+  module Instrumentation
+    module Thrift
+      # TracedProtocol wrap any raw Thrift protocol instance.
+      # Not thread safe!
+      #
+      # Usage (without multiplexed):
+      #   buffered_transport = ::Thrift::BufferedTransport.new(transport)
+      #   protocol = ::Thrift::BinaryProtocol.new(buffered_transport)
+      #   traced_protocol = \
+      #     OpenTracing::Instrumentation::Thrift::TracedProtocol.new(protocol)
+      #
+      # Usage (multiplexed):
+      #   buffered_transport = ::Thrift::BufferedTransport.new(transport)
+      #   protocol = ::Thrift::BinaryProtocol.new(buffered_transport)
+      #   traced_protocol =
+      #     OpenTracing::Instrumentation::Thrift::TracedProtocol
+      #       .new(protocol)
+      #   multiplexed_protocol =
+      #     ::Thrift::MultiplexedProtocol
+      #       .new(traced_protocol, 'OrderService')
+      class TracedProtocol < ::Thrift::BaseProtocol
+        extend Forwardable
+
+        include ::Thrift::ProtocolDecorator
+
+        attr_reader :protocol
+
+        def initialize(protocol, config: Config.new)
+          @protocol = protocol
+          @config = config
+        end
+
+        def write_message_begin(name, type, seqid)
+          request_tags = build_request_tags(name, type)
+          self.write_scope = tracer.start_active_span(
+            write_operation_name,
+            tags: request_tags,
+          )
+          handler_error(write_scope.span, type)
+
+          protocol.write_message_begin(name, type, seqid)
+        end
+
+        def write_message_end
+          super
+          write_scope.close
+        end
+
+        def read_message_begin
+          self.read_scope = tracer.start_active_span(read_operation_name)
+
+          name, type, rseqid = super
+
+          tags = build_request_tags(name, type)
+          write_span_tags(read_scope.span, tags)
+          handler_error(read_scope.span, type)
+
+          [name, type, rseqid]
+        end
+
+        def read_message_end
+          super
+          read_scope.close
+        end
+
+        private
+
+        def_delegators :@config,
+                       :tracer,
+                       :write_operation_name,
+                       :read_operation_name
+
+        attr_accessor :write_scope,
+                      :read_scope
+
+        METHOD_PART = 'method'
+        SERVICE_NAME_PART = 'service_name'
+        NAME_PATTER = /((?<service_name>\w+):)?(?<method>\w+)/.freeze
+        MESSAGE_TYPES = {
+          ::Thrift::MessageTypes::CALL => 'CALL',
+          ::Thrift::MessageTypes::REPLY => 'REPLY',
+          ::Thrift::MessageTypes::EXCEPTION => 'EXCEPTION',
+          ::Thrift::MessageTypes::ONEWAY => 'ONEWAY',
+        }.freeze
+
+        def parse_name(name)
+          name_matches = NAME_PATTER.match(name)
+          method = name_matches[METHOD_PART]
+          service_name = name_matches[SERVICE_NAME_PART]
+          [service_name, method]
+        end
+
+        def write_span_tags(span, tags)
+          tags.each do |tag, value|
+            span.set_tag(tag, value)
+          end
+        end
+
+        def build_request_tags(name, type)
+          service_name, method = parse_name(name)
+          {
+            'thrift.method' => method,
+            'thrift.service_name' => service_name,
+            'thrift.type' => MESSAGE_TYPES[type],
+            'thrift.multiplexed' => !service_name.nil?,
+            'thrift.protocol' => protocol_name,
+            'thrift.transport' => transport_name,
+          }.compact
+        end
+
+        def protocol_name
+          protocol.class.to_s
+        end
+
+        def build_transport_name(transport)
+          inner_transport = transport.instance_variable_get(:@transport)
+
+          if inner_transport
+            inner_transport_name = build_transport_name(inner_transport)
+            "#{transport.class}(#{inner_transport_name})"
+          else
+            transport.class.to_s
+          end
+        end
+
+        def transport_name
+          return @transport_name if defined?(@transport_name)
+
+          @transport_name = build_transport_name(@protocol.trans)
+        end
+
+        def handler_error(span, type)
+          return if type != ::Thrift::MessageTypes::EXCEPTION
+
+          span.set_tag('error', true)
+        end
+      end
+    end
+  end
+end

data/lib/opentracing/instrumentation/thrift/traced_protocol_factory.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'opentracing/instrumentation/thrift/traced_protocol'
+
+module OpenTracing
+  module Instrumentation
+    module Thrift
+      # Factory of TracedProtocol. Can be used thrift processor
+      #
+      # Usage (config.ru):
+      #   multiplexed_processor = Thrift::MultiplexedProcessor.new
+      #   binary_protocol_factory =
+      #     OpenTracing::Instrumentation::Thrift::TracedProtocolFactory.new(
+      #       Thrift::BinaryProtocolAcceleratedFactory.new,
+      #     )
+      #   json_protocol_factory =
+      #     OpenTracing::Instrumentation::Thrift::TracedProtocolFactory.new(
+      #       Thrift::JsonProtocolFactory.new,
+      #     )
+      #   protocol_factoreis_map = {
+      #     binary_protocol_factory => ['application/x-thrift'],
+      #     json_protocol_factory => ['application/json'],
+      #   }
+      #   thrift_app =
+      #     ::MultiprotocolThriftRackApp.new(
+      #       multiplexed_processor,
+      #       protocol_factoreis_map,
+      #     )
+      #   run thrift_app
+      class TracedProtocolFactory < ::Thrift::BaseProtocolFactory
+        def initialize(protocol_factory, config: Config.new)
+          @protocol_factory = protocol_factory
+          @config = config
+        end
+
+        def get_protocol(trans)
+          protocol = protocol_factory.get_protocol(trans)
+          TracedProtocol.new(protocol, config: config)
+        end
+
+        private
+
+        attr_reader :protocol_factory,
+                    :config
+      end
+    end
+  end
+end

data/lib/opentracing/instrumentation/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OpenTracing
+  module Instrumentation
+    VERSION = File.read(File.expand_path('../../../GEM_VERSION', __dir__)).strip
+  end
+end

data/opentracing-instrumentation.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opentracing/instrumentation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'opentracing-instrumentation'
+  spec.version       = OpenTracing::Instrumentation::VERSION
+  spec.authors       = ['Fedorenko Dmitrij']
+  spec.email         = ['job@fedorenko-d.ru']
+
+  spec.summary       = 'OpenTracing instrumentation for popular ruby libraries'
+  spec.description   = 'OpenTracing instrumentation for Mongo, Faraday, Rack and PORO'
+  spec.homepage      = 'https://gitlab.com/c0va23/ruby-opentracing-instrumentation.'
+  spec.license       = 'MIT'
+
+  # 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_runtime_dependency 'json', '~> 2.0'
+  spec.add_runtime_dependency 'opentracing', '~> 0.5.0'
+
+  spec.add_development_dependency 'bson', '~> 4.0'
+  spec.add_development_dependency 'bundler', File.read('.BUNDLER_VERSION').strip
+  spec.add_development_dependency 'faraday', '~> 0.9.2'
+  spec.add_development_dependency 'rack', '~> 2.2.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redis', '~> 3.3.5'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.80.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.38.1'
+  spec.add_development_dependency 'thrift', '~> 0.11.0'
+end

metadata

@@ -0,0 +1,255 @@
+--- !ruby/object:Gem::Specification
+name: opentracing-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fedorenko Dmitrij
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: bson
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !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: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.38.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.38.1
+- !ruby/object:Gem::Dependency
+  name: thrift
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: OpenTracing instrumentation for Mongo, Faraday, Rack and PORO
+email:
+- job@fedorenko-d.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".BUNDLER_VERSION"
+- ".drone.jsonnet"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- ".ruby-version"
+- GEM_VERSION
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/opentracing/instrumentation.rb
+- lib/opentracing/instrumentation/common.rb
+- lib/opentracing/instrumentation/common/error_writer.rb
+- lib/opentracing/instrumentation/faraday.rb
+- lib/opentracing/instrumentation/faraday/response_logger.rb
+- lib/opentracing/instrumentation/faraday/trace_middleware.rb
+- lib/opentracing/instrumentation/mongo.rb
+- lib/opentracing/instrumentation/mongo/direct_sanitazer.rb
+- lib/opentracing/instrumentation/mongo/query_sanitazer.rb
+- lib/opentracing/instrumentation/mongo/trace_subscriber.rb
+- lib/opentracing/instrumentation/object_wrapper.rb
+- lib/opentracing/instrumentation/rack.rb
+- lib/opentracing/instrumentation/rack/http_tagger.rb
+- lib/opentracing/instrumentation/rack/trace_middleware.rb
+- lib/opentracing/instrumentation/redis.rb
+- lib/opentracing/instrumentation/redis/config.rb
+- lib/opentracing/instrumentation/redis/span_builder.rb
+- lib/opentracing/instrumentation/redis/tracing_driver_wrapper.rb
+- lib/opentracing/instrumentation/sidekiq.rb
+- lib/opentracing/instrumentation/sidekiq/client_middleware.rb
+- lib/opentracing/instrumentation/sidekiq/job_tagger.rb
+- lib/opentracing/instrumentation/sidekiq/server_middleware.rb
+- lib/opentracing/instrumentation/sinatra.rb
+- lib/opentracing/instrumentation/sinatra/trace_middleware.rb
+- lib/opentracing/instrumentation/thrift.rb
+- lib/opentracing/instrumentation/thrift/config.rb
+- lib/opentracing/instrumentation/thrift/traced_protocol.rb
+- lib/opentracing/instrumentation/thrift/traced_protocol_factory.rb
+- lib/opentracing/instrumentation/version.rb
+- opentracing-instrumentation.gemspec
+homepage: https://gitlab.com/c0va23/ruby-opentracing-instrumentation.
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: OpenTracing instrumentation for popular ruby libraries
+test_files: []