opentracing-instrumentation 0.1.9 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69f4f1cfeeac35ba9ae9136f6da987d5d0fe6fc389983b48a931a80a384293ec
-  data.tar.gz: 70418b1cd88602c5792b6e196211706b692cc4dfdc45de25ac296069171fa5a1
+  metadata.gz: 0deff013f5e114188fd45e5babe206deb828806074e5d5cdb64d2d0bd12039b9
+  data.tar.gz: b9db37bc148a276e95f6b9b843c8524ac0fcb81b9a136aa9e95532f7d18f9d25
 SHA512:
-  metadata.gz: 115e8567b8dc553d0a5b566bfd51b433f74137402dd80903daac6afcf59c548bdff1f3534033d2cfc99cd138ce9d4a977648971aca3349235d973d1380d60312
-  data.tar.gz: f41a753d755fb5e1fc409b7394c51877288ad410dc91bfa5141d1caa2100f94abe09c926a27bb3f71ccb11136514908e71c81b3d409f552510a2f1b981991070
+  metadata.gz: 7dac1db7d02ba70d447d2db46f28b31a2549e2d9636a9ead1013940af8e9338d5d75dfa6ce86a6d71b8eabbc26f17119be80b1110a9b0ccc3be8013f237b78a9
+  data.tar.gz: c604dfdd5b4f0e77f7bb5c29cc3a2c11e77540e6d8c69b901509af2f89c48575d6ff57cdc44d97e4f52ad4815a842684a16a723bfa874daa4ec9735fbc043e11

data/GEM_VERSION

@@ -1 +1 @@
-0.1.9
+0.1.14

data/Gemfile.lock

@@ -18,7 +18,7 @@ GIT
 PATH
   remote: .
   specs:
-    opentracing-instrumentation (0.1.9)
+    opentracing-instrumentation (0.1.14)
       json
       opentracing (~> 0.5.0)
 

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,19 +10,16 @@ module OpenTracing
       class TraceSubscriber
         include Forwardable
 
-        DEFAULT_OPERATION_NAME_PATTERN = \
-          'mongo(collection=%<database>s.%<collection>s, command=%<command>s)'
-
         def initialize(
           tracer: OpenTracing.global_tracer,
           scope_store: {},
-          operation_name_pattern: DEFAULT_OPERATION_NAME_PATTERN,
+          operation_name_builder: OperationNameBuilder.new,
           sanitazer: QuerySanitazer.new
         )
           @tracer = tracer
           @monitor = Monitor.new
           @scope_store = scope_store
-          @operation_name_pattern = operation_name_pattern
+          @operation_name_builder = operation_name_builder
           @sanitazer = sanitazer
         end
 
@@ -49,18 +46,11 @@ module OpenTracing
         attr_reader :tracer
         attr_reader :scope_store
         attr_reader :monitor
-        attr_reader :operation_name_pattern
+        attr_reader :operation_name_builder
         attr_reader :sanitazer
 
         def build_operation_name(event)
-          command_name = event.command_name
-          collection_name = event.command[command_name]
-          format(
-            operation_name_pattern,
-            database: event.database_name,
-            collection: collection_name,
-            command: command_name,
-          )
+          operation_name_builder.build_operation_name(event)
         end
 
         def base_tags(event)

data/lib/opentracing/instrumentation/object_wrapper.rb

@@ -28,7 +28,7 @@ module OpenTracing
       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)

data/lib/opentracing/instrumentation/rack.rb

@@ -4,6 +4,8 @@ module OpenTracing
   module Instrumentation
     # Rack tracing middlewares
     module Rack
+      autoload :ExtractMiddleware,
+               'opentracing/instrumentation/rack/extract_middleware'
       autoload :HttpTagger, 'opentracing/instrumentation/rack/http_tagger'
       autoload :RegexpHostSanitazer,
                'opentracing/instrumentation/rack/regexp_host_sanitazer'

data/lib/opentracing/instrumentation/rack/extract_middleware.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+module OpenTracing
+  module Instrumentation
+    module Rack
+      # ExtractMiddleware extract trace context and push it to scope manager.
+      class ExtractMiddleware
+        # @private
+        class FakeSpan
+          attr_reader :context
+
+          def initialize(context)
+            @context = context
+          end
+        end
+
+        # @param app [RackApp] inner rack application
+        # @param tracer [OpenTracing::Tracer]
+        def initialize(app, tracer: OpenTracing.global_tracer)
+          @app = app
+          @tracer = tracer
+        end
+
+        # @param env [Hash<String, String>] rack env
+        def call(env)
+          span_context = @tracer.extract(OpenTracing::FORMAT_RACK, env)
+          return @app.call unless span_context
+
+          with_scope(span_context) do
+            @app.call(env)
+          end
+        end
+
+        private
+
+        def with_scope(span_context)
+          fake_span = FakeSpan.new(span_context)
+          scope = @tracer.scope_manager.activate(fake_span, finish_on_close: false)
+
+          yield
+        ensure
+          scope.close
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentracing-instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.14
 platform: ruby
 authors:
 - Fedorenko Dmitrij
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2020-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -296,10 +296,12 @@ 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
 - lib/opentracing/instrumentation/rack.rb
+- lib/opentracing/instrumentation/rack/extract_middleware.rb
 - lib/opentracing/instrumentation/rack/http_tagger.rb
 - lib/opentracing/instrumentation/rack/regexp_host_sanitazer.rb
 - lib/opentracing/instrumentation/rack/regexp_path_sanitazer.rb