opentracing-instrumentation 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79f1742c93b198bb7928c48fd0331d0eb698d84c20380a82a607811b193972b4
-  data.tar.gz: 9c849787447dc9a9e55ed146e68c6cc106eb3ce2e2ad753db21958747e5ba57a
+  metadata.gz: acb5d0dd01cab906babfd39d9ad99949eefcfa7f586c00883c0c9a606e66f642
+  data.tar.gz: 7051aa44a11889a29f33f853805734dc06efdc548e979fe83f8725a84d5f8b79
 SHA512:
-  metadata.gz: d085afca97c026da18ffcaac48ce0c7906ea0de756f4fd563be3444941f43666f080e84c2f0e0c16502b9caa9445900e21161493bbd21f58bdce20ae4e7f825c
-  data.tar.gz: df8544b857144ded2ad34ac802e63ae5e5b984ec40b17aed62002e164887dee0ab081f984ca1d5478e41d7e58c5d5a770e076c6f360861c30540662bec2f4807
+  metadata.gz: 784b8bb87a3a7e1b2ae054b32e3c3313d55809efcf567af1d72bd1d5a7f88e671450ea188e4d862bd5fd8bdc8cc8a8d29bcd4bcfd3ca6db41ee3aade85429a23
+  data.tar.gz: aff530e01d925b4dd77d587a37b48af25d57e51982ed25748621842b7c121422d7d3fe2cc35ebc2c5bd396708901c51927bc793dfaaa4fe2d0622a15dea33014

data/GEM_VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/Gemfile.lock

@@ -18,8 +18,8 @@ GIT
 PATH
   remote: .
   specs:
-    opentracing-instrumentation (0.1.0)
-      json (~> 2.0)
+    opentracing-instrumentation (0.1.1)
+      json
       opentracing (~> 0.5.0)
 
 GEM
@@ -83,7 +83,7 @@ PLATFORMS
 
 DEPENDENCIES
   bson (~> 4.0)
-  bundler (~> 2.1.4)
+  bundler (= 2.1.4)
   faraday (~> 0.9.2)
   opentracing-instrumentation!
   pry-byebug (~> 3.8)

data/lib/opentracing/instrumentation/rack.rb

@@ -5,7 +5,15 @@ module OpenTracing
     # Rack tracing middlewares
     module Rack
       autoload :HttpTagger, 'opentracing/instrumentation/rack/http_tagger'
+      autoload :RegexpPathSanitazer,
+               'opentracing/instrumentation/rack/regexp_path_sanitazer'
+      autoload :StaticCommandNameBuilder,
+               'opentracing/instrumentation/rack/static_command_name_builder'
       autoload :TraceMiddleware, 'opentracing/instrumentation/rack/trace_middleware'
+      autoload :UnsafePathSanitazer,
+               'opentracing/instrumentation/rack/unsafe_path_sanitazer'
+      autoload :UrlCommandNameBuilder,
+               'opentracing/instrumentation/rack/url_command_name_builder'
     end
   end
 end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+module OpenTracing
+  module Instrumentation
+    module Rack
+      # RegexpPathSanitazer return raw path
+      class RegexpPathSanitazer
+        DEFAULT_REPLACE_MAP = {
+          '/:object_id\1' => %r{/[0-9a-f]{24}(/|$)},
+          '/:sequence_id\1' => %r{/\d+(/|$)},
+        }.freeze
+
+        def initialize(
+          replace_map: DEFAULT_REPLACE_MAP
+        )
+          @replace_map = replace_map
+        end
+
+        def sanitaze_path(path)
+          @replace_map.each do |(target, regexp)|
+            path = path.gsub(regexp, target)
+          end
+          path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenTracing
+  module Instrumentation
+    module Rack
+      # StaticCommandNameBuilder build static command_name
+      class StaticCommandNameBuilder
+        DEFAULT_COMMAND_NAME = 'rack'
+
+        def initialize(
+          command_name: DEFAULT_COMMAND_NAME
+        )
+          @command_name = command_name
+        end
+
+        def build_command_name(_env)
+          @command_name
+        end
+      end
+    end
+  end
+end

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

@@ -7,16 +7,18 @@ module OpenTracing
     module Rack
       # TraceMiddleware observer rack requests.
       class TraceMiddleware
+        DEFAULT_COMMAND_NAME_BUILDER = StaticCommandNameBuilder.new
+
         def initialize(
           app,
           logger: nil,
-          command_name: 'rack',
+          command_name_builder: DEFAULT_COMMAND_NAME_BUILDER,
           http_tagger: HttpTagger.new,
           tracer: OpenTracing.global_tracer
         )
           @app = app
           @logger = logger
-          @command_name = command_name
+          @command_name_builder = command_name_builder
           @http_tagger = http_tagger
           @tracer = tracer
         end
@@ -42,8 +44,9 @@ module OpenTracing
         def trace_request(env)
           extracted_ctx = tracer.extract(OpenTracing::FORMAT_RACK, env)
           logger&.info('Tracing context extracted') if extracted_ctx
+          command_name = @command_name_builder.build_command_name(env)
           tracer.start_active_span(
-            @command_name,
+            command_name,
             child_of: extracted_ctx,
             tags: request_tags(env),
           ) do |scope|

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+module OpenTracing
+  module Instrumentation
+    module Rack
+      # UnsafePathSanitazer return raw path
+      class UnsafePathSanitazer
+        def sanitaze_path(path)
+          path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+module OpenTracing
+  module Instrumentation
+    module Rack
+      # UrlCommandNameBuilder build command name with request url
+      class UrlCommandNameBuilder
+        DEFAULT_COMMAND_PATTERN = \
+          'rack(%<method>s %<schema>s://%<host>s:%<port>d%<path>s)'
+        DEFAULT_PORT = 80
+
+        def initialize(
+          command_pattern: DEFAULT_COMMAND_PATTERN,
+          path_sanitazer: RegexpPathSanitazer.new
+        )
+          @command_pattern = command_pattern
+          @path_sanitazer = path_sanitazer
+        end
+
+        def build_command_name(env)
+          format(@command_pattern, pattern_args(env))
+        end
+
+        private
+
+        def pattern_args(env)
+          path = env[::Rack::REQUEST_PATH]
+          sanitazed_path = @path_sanitazer.sanitaze_path(path)
+          {
+            schema: env[::Rack::RACK_URL_SCHEME],
+            method: env[::Rack::REQUEST_METHOD],
+            host: env[::Rack::HTTP_HOST],
+            port: env[::Rack::HTTP_PORT] || DEFAULT_PORT,
+            path: sanitazed_path,
+          }
+        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.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Fedorenko Dmitrij
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -212,7 +212,11 @@ files:
 - lib/opentracing/instrumentation/object_wrapper.rb
 - lib/opentracing/instrumentation/rack.rb
 - lib/opentracing/instrumentation/rack/http_tagger.rb
+- lib/opentracing/instrumentation/rack/regexp_path_sanitazer.rb
+- lib/opentracing/instrumentation/rack/static_command_name_builder.rb
 - lib/opentracing/instrumentation/rack/trace_middleware.rb
+- lib/opentracing/instrumentation/rack/unsafe_path_sanitazer.rb
+- lib/opentracing/instrumentation/rack/url_command_name_builder.rb
 - lib/opentracing/instrumentation/redis.rb
 - lib/opentracing/instrumentation/redis/config.rb
 - lib/opentracing/instrumentation/redis/span_builder.rb