opentracing-instrumentation 0.1.8 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b58db3616510f2c097cf2586f113a23c28c0ca8232c828f3577f64e09aecdcce
-  data.tar.gz: 3a32e28eae0e9d698ac5f229453d981ac4ed01c3fc78533c89090615759030fc
+  metadata.gz: 6dd80093ca0c1a8cfc5b97e6c20e72440581970dee1941d97e77c9bb2c3ee449
+  data.tar.gz: ecf8fab0778ab5df7764a05495f84d2336a48c2ca382242727b26b9bd052e9dd
 SHA512:
-  metadata.gz: e46ac60a7008279377c14229b7dc7e61cdd14afb63f340e45de25005f1c5259a122c90d35c7493ef5daed703e113dcdbba45ec1604bcb9129999904df7258d6f
-  data.tar.gz: 442f72513f70e1323ed0a04b1a0e1c35e6d903593aadc11a9997b4da1bd395aedf9378065ce102ba703aa9cfdf8ece29a8ec13bf5703849367543a2ebdf5773b
+  metadata.gz: 03ca24d62c6c254e158bffabecc961dc7c945862f418f7324e6790538649d194c83a5373a9dacb28bcf4fc5153e0b298a3b65e04fbba69c3347297281e327a73
+  data.tar.gz: 5ec70cad41f48ab7f4c3f5875f8e743dd492d12fa13a583e1abfb5e1a64bd32278e0347b37d9844f4c0399a850037be235af63423983627e5fcfd461ef372622

data/.rubocop.yml

@@ -1,5 +1,7 @@
 require:
   - rubocop-rspec
+  - rubocop-performance
+  - rubocop-thread_safety
 
 Layout/LineLength:
   Max: 100

data/GEM_VERSION

@@ -1 +1 @@
-0.1.8
+0.1.13

data/Gemfile.lock

@@ -18,7 +18,7 @@ GIT
 PATH
   remote: .
   specs:
-    opentracing-instrumentation (0.1.8)
+    opentracing-instrumentation (0.1.13)
       json
       opentracing (~> 0.5.0)
 
@@ -58,7 +58,7 @@ GEM
     multipart-post (2.1.1)
     opentracing (0.5.0)
     parallel (1.19.1)
-    parser (2.7.0.3)
+    parser (2.7.0.5)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -84,7 +84,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.80.0)
+    rubocop (0.80.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
@@ -92,8 +92,12 @@ GEM
       rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
     rubocop-rspec (1.38.1)
       rubocop (>= 0.68.1)
+    rubocop-thread_safety (0.3.4)
+      rubocop (>= 0.51.0)
     ruby-progressbar (1.10.1)
     thread_safe (0.3.6)
     thrift (0.11.0.0)
@@ -118,7 +122,9 @@ DEPENDENCIES
   redis (~> 3.3.5)
   rspec (~> 3.0)
   rubocop (~> 0.80.0)
+  rubocop-performance (~> 1.5.2)
   rubocop-rspec (~> 1.38.1)
+  rubocop-thread_safety (~> 0.3.4)
   test-tracer!
   thrift (~> 0.11.0)
   tracing-matchers!

data/lib/opentracing/instrumentation/mongo.rb

@@ -5,6 +5,8 @@ module OpenTracing
     # Mongo driver instrumentation. Support mongo gem version 2.x.
     module Mongo
       autoload :DirectSanitazer, 'opentracing/instrumentation/mongo/direct_sanitazer'
+      autoload :OperationNameBuilder,
+               'opentracing/instrumentation/mongo/operation_name_builder'
       autoload :TraceSubscriber, 'opentracing/instrumentation/mongo/trace_subscriber'
       autoload :QuerySanitazer, 'opentracing/instrumentation/mongo/query_sanitazer'
     end

data/lib/opentracing/instrumentation/mongo/operation_name_builder.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OpenTracing
+  module Instrumentation
+    module Mongo
+      # OperationNameBuilder for Mongo::TraceSubscriber
+      class OperationNameBuilder
+        DEFAULT_OPERATION_NAME_PATTERN = \
+          'mongo(collection=%<database>s.%<collection>s, command=%<command>s)'
+
+        # @param operation_name_pattern [String]
+        def initialize(
+          operation_name_pattern: DEFAULT_OPERATION_NAME_PATTERN
+        )
+          @operation_name_pattern = operation_name_pattern
+        end
+
+        # @param event [Mongo::Monitoring::Event::CommandStarted]
+        # @return [String] formated command name
+        def build_operation_name(event)
+          format_args = build_format_args(event)
+          format(operation_name_pattern, **format_args)
+        end
+
+        private
+
+        attr_reader :operation_name_pattern
+
+        COLLECTION = 'collection'
+
+        def build_format_args(event)
+          {
+            database: event.database_name,
+            collection: fetch_collection_name(event),
+            command: event.command_name,
+          }
+        end
+
+        def fetch_collection_name(event)
+          # On some command collection name into 'collection' field,
+          event.command[COLLECTION] || event.command[event.command_name]
+        end
+      end
+    end
+  end
+end

data/lib/opentracing/instrumentation/mongo/trace_subscriber.rb

@@ -10,24 +10,22 @@ module OpenTracing
       class TraceSubscriber
         include Forwardable
 
-        DEFAULT_OPERATION_NAME = 'mongo_command'
-
         def initialize(
           tracer: OpenTracing.global_tracer,
           scope_store: {},
-          operation_name: DEFAULT_OPERATION_NAME,
+          operation_name_builder: OperationNameBuilder.new,
           sanitazer: QuerySanitazer.new
         )
           @tracer = tracer
           @monitor = Monitor.new
           @scope_store = scope_store
-          @operation_name = operation_name
+          @operation_name_builder = operation_name_builder
           @sanitazer = sanitazer
         end
 
         def started(event)
           scope = tracer.start_active_span(
-            operation_name,
+            build_operation_name(event),
             tags: base_tags(event).merge(mongo_tags(event)),
           )
 
@@ -48,9 +46,13 @@ module OpenTracing
         attr_reader :tracer
         attr_reader :scope_store
         attr_reader :monitor
-        attr_reader :operation_name
+        attr_reader :operation_name_builder
         attr_reader :sanitazer
 
+        def build_operation_name(event)
+          operation_name_builder.build_operation_name(event)
+        end
+
         def base_tags(event)
           {
             'component' => 'db',

data/lib/opentracing/instrumentation/object_wrapper.rb

@@ -8,39 +8,49 @@ module OpenTracing
     #   wrapped_object = OpenTracing::Instrumentation::ObjectWrapper.new(other_object)
     #   wrapped_object.other_object_method
     class ObjectWrapper
-      DEFAULT_COMMAND_NAME = 'method_call'
+      DEFAULT_OPERATOIN_NAME_PATTERN = \
+        'object_call(%<class_name>s#%<method>s)'
 
       attr_reader :tracer,
-                  :command_name
+                  :operation_name_pattern
 
       def initialize(
         object,
         tracer: OpenTracing.global_tracer,
-        command_name: DEFAULT_COMMAND_NAME
+        operation_name_pattern: DEFAULT_OPERATOIN_NAME_PATTERN
       )
         @object = object
         @tracer = tracer
-        @command_name = command_name
+        @operation_name_pattern = operation_name_pattern
       end
 
       # wrapped object
       attr_reader :object
 
       def respond_to_missing?(method_name, *)
-        object.response_to?(method_name)
+        object.respond_to?(method_name)
       end
 
       def method_missing(method_name, *args)
         return super unless object.respond_to?(method_name)
 
+        operation_name = buid_operation_name(method_name)
         tags = build_tags(method_name)
-        tracer.start_active_span(command_name, tags: tags) do |scope|
+        tracer.start_active_span(operation_name, tags: tags) do |scope|
           call_method(scope.span, method_name, *args)
         end
       end
 
       private
 
+      def buid_operation_name(method_name)
+        format(
+          operation_name_pattern,
+          class_name: class_name,
+          method: method_name,
+        )
+      end
+
       def call_method(span, method_name, *args)
         object.send(method_name, *args)
       rescue StandardError => e
@@ -48,9 +58,13 @@ module OpenTracing
         raise e
       end
 
+      def class_name
+        @class_name ||= object.class.to_s
+      end
+
       def build_tags(method)
         {
-          'object.class' => object.class.to_s,
+          'object.class' => class_name,
           'object.method' => method.to_s,
         }
       end

data/lib/opentracing/instrumentation/redis/config.rb

@@ -7,27 +7,28 @@ module OpenTracing
     module Redis
       # Redis tracing mixin config
       class Config
-        DEFAULT_SPAN_NAME = 'redis_command'
+        DEFAULT_OPERATION_NAME_PATTERN = \
+          'redis(command=%<command>s)'
         # Safe by default
         DEFAULT_LOG_ARGS = false
         DEFAULT_LOG_REPLY = false
         DEFAULT_COMPONENT = 'kv'
 
         attr_accessor :tracer
-        attr_accessor :span_name
+        attr_accessor :operation_name_pattern
         attr_accessor :log_args
         attr_accessor :log_reply
         attr_accessor :component
 
         def initialize(
           tracer: OpenTracing.global_tracer,
-          span_name: DEFAULT_SPAN_NAME,
+          operation_name_pattern: DEFAULT_OPERATION_NAME_PATTERN,
           log_args: DEFAULT_LOG_ARGS,
           log_reply: DEFAULT_LOG_REPLY,
           component: DEFAULT_COMPONENT
         )
           @tracer = tracer
-          @span_name = span_name
+          @operation_name_pattern = operation_name_pattern
           @log_args = log_args
           @log_reply = log_reply
           @component = component

data/lib/opentracing/instrumentation/redis/span_builder.rb

@@ -19,7 +19,7 @@ module OpenTracing
 
         def_delegators :@config,
                        :tracer,
-                       :span_name,
+                       :operation_name_pattern,
                        :component,
                        :log_args,
                        :log_reply
@@ -27,10 +27,11 @@ module OpenTracing
         def_delegators :@error_writer,
                        :write_error
 
-        def start_active_scope(connection_class, peer_addr)
+        def start_active_scope(command, connection_class, peer_addr)
+          operation_name = build_operation_name(command)
           tags = build_tags(connection_class, peer_addr)
           tracer.start_active_span(
-            span_name,
+            operation_name,
             tags: tags,
           )
         end
@@ -79,6 +80,13 @@ module OpenTracing
             'redis.reply': JSON.dump(reply),
           )
         end
+
+        private
+
+        def build_operation_name(command)
+          command_name, * = command
+          format(operation_name_pattern, command: command_name)
+        end
       end
     end
   end

data/lib/opentracing/instrumentation/redis/tracing_driver_wrapper.rb

@@ -56,7 +56,7 @@ module OpenTracing
                        :timeout=
 
         def write(command)
-          scope = start_pipeline_scope
+          scope = start_pipeline_scope(command)
           connection.write(command).tap do
             span_builder.write_log_command(scope.span, command) if scope
           end
@@ -87,15 +87,20 @@ module OpenTracing
           "#{@host}:#{@port}"
         end
 
-        def start_pipeline_scope
+        def start_pipeline_scope(command)
           if @pipeline_scope
             @pipeline_queue_size += 1
             return @pipeline_scope
           end
 
+          new_pipeline_scope(command)
+        end
+
+        def new_pipeline_scope(command)
           @pipeline_queue_size = 1
           @pipeline_scope =
             span_builder.start_active_scope(
+              command,
               connection.class,
               peer_addr,
             )

data/opentracing-instrumentation.gemspec

@@ -38,6 +38,8 @@ Gem::Specification.new do |spec|
   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 '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.8
+  version: 0.1.13
 platform: ruby
 authors:
 - Fedorenko Dmitrij
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -192,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.80.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.38.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
 - !ruby/object:Gem::Dependency
   name: thrift
   requirement: !ruby/object:Gem::Requirement
@@ -268,6 +296,7 @@ files:
 - lib/opentracing/instrumentation/hutch/global_properties_builder.rb
 - lib/opentracing/instrumentation/mongo.rb
 - 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/trace_subscriber.rb
 - lib/opentracing/instrumentation/object_wrapper.rb