opentracing-instrumentation 0.1.14 → 0.2.0

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module OpenTracing
+  module Instrumentation
+    module Thrift
+      # Config of ThriftProcessor
+      class TracedProcessorConfig
+        # @return [OpenTracing::Tracer]
+        attr_accessor :tracer
+
+        # @return [Boolean] enabled wrap protocol into TracedProtocol
+        attr_accessor :trace_protocol
+
+        # @return [TracedProcessorOperationNameBuilder]
+        attr_accessor :operation_name_builder
+
+        # @return [TracedProcessorTagsBuilder]
+        attr_accessor :tags_builder
+
+        # @return [Common::ErrorWriter]
+        attr_accessor :error_writer
+
+        # @return [Logger] used for log errors. If nil (by default), then logging disabled,
+        attr_accessor :logger
+
+        def initialize
+          @tracer = OpenTracing.global_tracer
+          @trace_protocol = true
+          @operation_name_builder = TracedProcessorOperationNameBuilder.new
+          @tags_builder = TracedProcessorTagsBuilder.new
+          @error_writer = Common::ErrorWriter.new
+          @logger = nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OpenTracing
+  module Instrumentation
+    module Thrift
+      # Thrift processor trace operation name builder
+      class TracedProcessorOperationNameBuilder
+        DEFAULT_OPERATION_NAME_TEMPALTE = \
+          'thrift_processor(%<name>s)'
+
+        # @param operation_name_tempalte [String]
+        def initialize(
+          operation_name_template: DEFAULT_OPERATION_NAME_TEMPALTE
+        )
+          @operation_name_template = operation_name_template
+        end
+
+        # @param name [String] method name
+        # @param type [Integer] type of message
+        # @param seq_id [Integer] numberr of message
+        # @return [String] operation name
+        def build(name, type, seq_id)
+          format_args = build_format_args(name, type, seq_id)
+          format(operation_name_template, **format_args)
+        end
+
+        private
+
+        attr_reader :operation_name_template
+
+        def build_format_args(name, type, seq_id)
+          {
+            name: name,
+            type: MESSAGE_TYPES[type],
+            seq_id: seq_id,
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenTracing
+  module Instrumentation
+    module Thrift
+      # Tags builder for TracedProcessor
+      class TracedProcessorTagsBuilder < TracedProtocolTagsBuilder
+        DEFAULT_STATIC_TAGS = {
+          'span.kind' => 'server',
+          'component' => 'thrift',
+        }.freeze
+
+        def initialize(static_tags: DEFAULT_STATIC_TAGS)
+          super()
+          @static_tags = static_tags
+        end
+
+        def build_tags(protocol, name, type)
+          static_tags
+            .merge(build_protocol_tags(protocol))
+            .merge(build_message_tags(name, type))
+        end
+
+        private
+
+        attr_reader :static_tags
+      end
+    end
+  end
+end

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

@@ -33,26 +33,32 @@ module OpenTracing
           super(protocol)
           @config = config.dup
           yield @config if block_given?
-          @static_tags = config.tags_builder.build_static_tags(protocol)
+          @protocol_tags = config.tags_builder.build_protocol_tags(protocol)
+        end
+
+        def ==(other)
+          protocol == other.protocol &&
+            config == other.config &&
+            protocol_tags == other.protocol_tags
         end
 
         def write_message_begin(name, type, seqid)
-          self.write_scope = \
-            safe_start_active_span(WRITE_DIRECTION, name, type)
+          self.write_span = \
+            safe_start_span(WRITE_DIRECTION, name, type)
 
           # Call protocol instaed super, beacaus ProtocolDecorator do not
           # pass arguments to protocol.write_message_begin
           protocol.write_message_begin(name, type, seqid)
         rescue StandardError => e
-          write_error(write_scope&.span, e)
-          safe_close_span(write_scope)
+          write_error(write_span, e)
+          safe_close_span(write_span)
           raise e
         end
 
         def write_message_end
           super
         ensure
-          safe_close_span(write_scope)
+          safe_close_span(write_span)
         end
 
         def read_message_begin
@@ -60,9 +66,9 @@ module OpenTracing
 
           name, type, rseqid = super
 
-          self.read_scope = \
-            safe_start_active_span(READ_DIRECTION, name, type,
-                                   start_time: start_time)
+          self.read_span = \
+            safe_start_span(READ_DIRECTION, name, type,
+                            start_time: start_time)
 
           [name, type, rseqid]
         end
@@ -70,25 +76,28 @@ module OpenTracing
         def read_message_end
           super
         ensure
-          safe_close_span(read_scope)
+          safe_close_span(read_span)
         end
 
-        private
+        protected
 
-        attr_reader :static_tags
-        attr_reader :protocol
+        attr_reader :protocol_tags,
+                    :protocol,
+                    :config
 
-        def_delegators :@config,
+        private
+
+        def_delegators :config,
                        :tracer,
                        :tags_builder,
                        :operation_name_builder,
                        :error_writer,
                        :logger
 
-        attr_accessor :write_scope,
-                      :read_scope
+        attr_accessor :write_span,
+                      :read_span
 
-        def safe_start_active_span(
+        def safe_start_span(
           direction,
           name,
           type,
@@ -97,7 +106,7 @@ module OpenTracing
           operation_name = build_operation_name(direction, name, type)
           request_tags = build_tags(name, type)
 
-          tracer.start_active_span(
+          tracer.start_span(
             operation_name,
             tags: request_tags,
             start_time: start_time,
@@ -106,10 +115,10 @@ module OpenTracing
           logger&.error(e)
         end
 
-        def safe_close_span(scope)
-          return if scope.nil?
+        def safe_close_span(span)
+          return if span.nil?
 
-          scope.close
+          span.finish
         rescue StandardError => e
           logger&.error(e)
         end
@@ -131,7 +140,7 @@ module OpenTracing
         end
 
         def build_tags(name, type)
-          static_tags
+          protocol_tags
             .merge(tags_builder.build_message_tags(name, type))
             .compact
         end

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

@@ -24,6 +24,13 @@ module OpenTracing
           @error_writer = error_writer
           @logger = logger
         end
+
+        def ==(other)
+          tracer == other.tracer &&
+            tags_builder == other.tags_builder &&
+            operation_name_builder == other.operation_name_builder &&
+            error_writer == other.error_writer
+        end
       end
     end
   end

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

@@ -29,6 +29,7 @@ module OpenTracing
       #   run thrift_app
       class TracedProtocolFactory < ::Thrift::BaseProtocolFactory
         def initialize(protocol_factory, config: TracedProtocolConfig.new)
+          super()
           @protocol_factory = protocol_factory
           @config = config
         end

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

@@ -10,8 +10,6 @@ module OpenTracing
         DEFAULT_OPERATION_NAME_PATTERN = \
           'thrift(direction=%<direction>s, name=%<name>s, type=%<type>s)'
 
-        attr_reader :operation_name_pattern
-
         # @param operation_name_pattern [String]
         def initialize(
           operation_name_pattern: DEFAULT_OPERATION_NAME_PATTERN
@@ -28,6 +26,14 @@ module OpenTracing
           format(operation_name_pattern, **format_args)
         end
 
+        def ==(other)
+          operation_name_pattern == other.operation_name_pattern
+        end
+
+        protected
+
+        attr_reader :operation_name_pattern
+
         private
 
         def build_format_args(direction, name, type)

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

@@ -17,7 +17,7 @@ module OpenTracing
           }.merge(error_tags(type))
         end
 
-        def build_static_tags(protocol)
+        def build_protocol_tags(protocol)
           transport = protocol.trans
           {
             'thrift.protocol' => build_protocol_name(protocol),
@@ -25,9 +25,13 @@ module OpenTracing
           }
         end
 
+        def ==(other)
+          self.class == other.class
+        end
+
         private
 
-        NAME_PATTER = /((?<service_name>\w+):)?(?<method>\w+)/.freeze
+        NAME_PATTER = /(?:(?<service_name>\w+):)?(?<method>\w+)/.freeze
         SERVICE_NAME_PART = 'service_name'
         METHOD_PART = 'method'
 

data/opentracing-instrumentation.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = "> #{File.read('.ruby-version').strip}"
+
   spec.add_runtime_dependency 'json'
   spec.add_runtime_dependency 'opentracing', '~> 0.5.0'
 
@@ -37,9 +39,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.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-performance', '~> 1.5.2'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.38.1'
-  spec.add_development_dependency 'rubocop-thread_safety', '~> 0.3.4'
+  spec.add_development_dependency 'rubocop', '~> 1.15.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.11.3'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.3.0'
+  spec.add_development_dependency 'rubocop-thread_safety', '~> 0.4.2'
   spec.add_development_dependency 'thrift', '~> 0.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentracing-instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.2.0
 platform: ruby
 authors:
 - Fedorenko Dmitrij
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2021-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -184,56 +184,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.0
+        version: 1.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.0
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 1.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 1.11.3
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.38.1
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.38.1
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rubocop-thread_safety
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 0.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: thrift
   requirement: !ruby/object:Gem::Requirement
@@ -261,6 +261,7 @@ files:
 - ".gitlab-ci.yml"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - GEM_VERSION
 - Gemfile
 - Gemfile.lock
@@ -284,6 +285,7 @@ files:
 - lib/opentracing/instrumentation/bunny/regexp_routing_key_sanitazer.rb
 - lib/opentracing/instrumentation/common.rb
 - lib/opentracing/instrumentation/common/error_writer.rb
+- lib/opentracing/instrumentation/common/operation_name_builder.rb
 - lib/opentracing/instrumentation/faraday.rb
 - lib/opentracing/instrumentation/faraday/response_logger.rb
 - lib/opentracing/instrumentation/faraday/trace_middleware.rb
@@ -298,6 +300,7 @@ files:
 - lib/opentracing/instrumentation/mongo/direct_sanitazer.rb
 - lib/opentracing/instrumentation/mongo/operation_name_builder.rb
 - lib/opentracing/instrumentation/mongo/query_sanitazer.rb
+- lib/opentracing/instrumentation/mongo/sample_safety_argument_checker.rb
 - lib/opentracing/instrumentation/mongo/trace_subscriber.rb
 - lib/opentracing/instrumentation/object_wrapper.rb
 - lib/opentracing/instrumentation/rack.rb
@@ -320,6 +323,10 @@ files:
 - lib/opentracing/instrumentation/sinatra.rb
 - lib/opentracing/instrumentation/sinatra/trace_middleware.rb
 - lib/opentracing/instrumentation/thrift.rb
+- lib/opentracing/instrumentation/thrift/traced_processor.rb
+- lib/opentracing/instrumentation/thrift/traced_processor_config.rb
+- lib/opentracing/instrumentation/thrift/traced_processor_operation_name_builder.rb
+- lib/opentracing/instrumentation/thrift/traced_processor_tags_builder.rb
 - lib/opentracing/instrumentation/thrift/traced_protocol.rb
 - lib/opentracing/instrumentation/thrift/traced_protocol_config.rb
 - lib/opentracing/instrumentation/thrift/traced_protocol_factory.rb
@@ -331,23 +338,23 @@ homepage: https://gitlab.com/c0va23/ruby-opentracing-instrumentation.
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: OpenTracing instrumentation for popular ruby libraries
 test_files: []