jcw 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc773311ab088e7276e7fb32a3f4482fe573b1395504aa2a3f65976c2554ee5d
-  data.tar.gz: e55467a99786575009b8bb0bd87204c0349517913db982e3367235ef11b5d6ca
+  metadata.gz: 110c81162cbfa9b0c7320539340e3adc8f2ecb0dc76f3ebc398ab3ef9330db31
+  data.tar.gz: 637bfb300fc81f4e07dce12983da6e4a342dbaa2445695241c7f3bd6fdd76f69
 SHA512:
-  metadata.gz: 1dfba6de347759d9dbd0073f7f258b7305a2257a340d26dc2248df54cdaaba7319583b18a281b688356f1fbce4ccd0144cffa7656919803418127d036af829f0
-  data.tar.gz: a60b7db65670d6c171acda171c77cc4de936959417d484fd04678d82ed94ed638c59dafca5bc0336d27007d894af7a6ec8cc2057d28f865472520629f7d71782
+  metadata.gz: 1cd01757ae92d40d4e0bd2ba687fc62d612a3ce7a6b3178d1a4038c56e7c2877ff219a8415fe0f4c099b0930b341eaff81efe2345ce6361384c46dfaa16829ab
+  data.tar.gz: 696a1156f40a49295c53f638b2626e6269c445f30f73ad809bc725dc765673417de5c9869c39fe3cbbc58146a951ef14f4d11e7a00b6a36193358e3b73ec1c3c

data/Gemfile.lock

@@ -1,30 +1,29 @@
 PATH
   remote: .
   specs:
-    jcw (0.2.1)
-      activesupport (>= 5.0)
+    jcw (0.2.2)
+      activesupport (>= 5.0, < 7.0.0)
       gruf (~> 2.10)
       httprb-opentracing (~> 0.4.0)
       jaeger-client (~> 1.1.0)
-      rack-tracer (~> 0.9.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.4.1)
-      actionview (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
+    actionpack (6.1.4.4)
+      actionview (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.4.1)
-      activesupport (= 6.1.4.1)
+    actionview (6.1.4.4)
+      activesupport (= 6.1.4.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.4.1)
+    activesupport (6.1.4.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -34,7 +33,7 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     builder (3.2.4)
-    bundler-audit (0.8.0)
+    bundler-audit (0.9.0.1)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
     coderay (1.1.3)
@@ -46,17 +45,17 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     e2mmap (0.1.0)
     erubi (1.10.0)
-    ffi (1.15.3)
+    ffi (1.15.4)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
     google-protobuf (3.19.1)
     googleapis-common-protos-types (1.3.0)
       google-protobuf (~> 3.14)
-    grpc (1.41.1)
-      google-protobuf (~> 3.17)
+    grpc (1.42.0)
+      google-protobuf (~> 3.18)
       googleapis-common-protos-types (~> 1.0)
-    grpc-tools (1.41.1)
+    grpc-tools (1.42.0)
     gruf (2.10.0)
       activesupport (> 4)
       concurrent-ruby (> 1)
@@ -66,11 +65,11 @@ GEM
       json (>= 2.3)
       slop (~> 4.6)
       thwait (~> 0.1)
-    http (5.0.1)
-      addressable (~> 2.3)
+    http (5.0.4)
+      addressable (~> 2.8)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
-      llhttp-ffi (~> 0.3.0)
+      llhttp-ffi (~> 0.4.0)
     http-cookie (1.0.4)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
@@ -78,21 +77,21 @@ GEM
       ffi-compiler (>= 1.0, < 2.0)
     httprb-opentracing (0.4.0)
       opentracing (~> 0.5.0)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     jaeger-client (1.1.0)
       opentracing (~> 0.3)
       thrift
     json (2.6.1)
-    llhttp-ffi (0.3.1)
+    llhttp-ffi (0.4.0)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
-    loofah (2.12.0)
+    loofah (2.13.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
     mini_portile2 (2.6.1)
-    minitest (5.14.4)
+    minitest (5.15.0)
     nokogiri (1.12.5)
       mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
@@ -101,33 +100,33 @@ GEM
     nokogiri (1.12.5-x86_64-linux)
       racc (~> 1.4)
     opentracing (0.5.0)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    opentracing_test_tracer (0.1.1)
+      opentracing
+    parallel (1.21.0)
+    parser (3.0.3.2)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rack-tracer (0.9.0)
-      opentracing (~> 0.4)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
+    railties (6.1.4.4)
+      actionpack (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
       method_source
       rake (>= 0.13)
       thor (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -141,7 +140,7 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+    rspec-support (3.10.3)
     rubocop (1.17.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -151,7 +150,7 @@ GEM
       rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
+    rubocop-ast (1.15.0)
       parser (>= 3.0.1.1)
     rubocop-config-umbrellio (1.17.0.53)
       rubocop (= 1.17.0)
@@ -191,9 +190,9 @@ GEM
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.7)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    unf_ext (0.0.8)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -206,6 +205,7 @@ DEPENDENCIES
   http
   http-parser
   jcw!
+  opentracing_test_tracer
   pry
   railties
   rake

data/README.md

@@ -42,10 +42,11 @@ UDP Sender(default):
     hostname: "custom-hostname",
     custom_tag: "custom-tag-value",
   }
+  config.rack_ignore_paths = %w[/api/test]
 end
 
-# Set middleware for wrapping all requests(gem RackTracer)
-Rails.application.middleware.use(JCW::RackTracer)
+# Set middleware for wrapping all requests
+Rails.application.middleware.use(JCW::Rack::Tracer)
 ```
 
 TCP Sender:
@@ -59,16 +60,17 @@ TCP Sender:
     hostname: "custom-hostname",
     custom_tag: "custom-tag-value",
   }
+  config.rack_ignore_paths = %w[/api/test]
 end
 
 # Set middleware for wrapping all requests
-Rails.application.middleware.use(JCW::RackTracer)
+Rails.application.middleware.use(JCW::Rack::Tracer)
 
 # If you need send all logs with spans set on_finish_span and extend JaegerLoggerExtension
 # Not recommended for UDP sender, because default max packet size is 65,000 bytes.
 Rails.application.config.tap do |config|
   config.middleware.use(
-    JCW::RackTracer,
+    JCW::Rack::Tracer,
     on_finish_span: lambda do |span|
       JCW::Logger.current.logs.each { |log| span.log_kv(**log) }
       JCW::Logger.current.clear # Do not forget to avoid memory leaks

data/jcw.gemspec

@@ -22,16 +22,16 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", ">= 5.0"
+  spec.add_dependency "activesupport", ">= 5.0", "< 7.0.0"
   spec.add_dependency "gruf", "~> 2.10"
   spec.add_dependency "httprb-opentracing", "~> 0.4.0"
   spec.add_dependency "jaeger-client", "~> 1.1.0"
-  spec.add_dependency "rack-tracer", "~> 0.9.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "bundler-audit"
   spec.add_development_dependency "http"
   spec.add_development_dependency "http-parser"
+  spec.add_development_dependency "opentracing_test_tracer"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "railties"
   spec.add_development_dependency "rake"
@@ -39,4 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-config-umbrellio"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-lcov"
+  spec.metadata = {
+    "rubygems_mfa_required" => "true",
+  }
 end

data/lib/jcw/config.rb

@@ -8,7 +8,8 @@ module JCW
                 :connection,
                 :flush_interval,
                 :tags,
-                :grpc_ignore_methods
+                :grpc_ignore_methods,
+                :rack_ignore_paths
 
     def enabled
       @enabled ||= false
@@ -39,5 +40,9 @@ module JCW
     def grpc_ignore_methods
       @grpc_ignore_methods ||= []
     end
+
+    def rack_ignore_paths
+      @rack_ignore_paths ||= []
+    end
   end
 end

data/lib/jcw/http_tracer.rb

@@ -17,6 +17,7 @@ module JCW
               host = request.uri.host if request.uri.respond_to?(:host)
               port = request.uri.port if request.uri.respond_to?(:port)
               verb = request.verb.to_s.upcase if request.respond_to?(:verb)
+              full_path = request.uri.to_s
 
               tags = {
                 "component" => "ruby-httprb",
@@ -25,13 +26,15 @@ module JCW
                 "http.url" => path,
                 "peer.host" => host,
                 "peer.port" => port,
+                "full_path" => full_path,
               }.compact
 
               tracer = ::HTTP::Tracer.tracer
 
-              tracer.start_active_span("http.request", tags: tags) do |scope|
+              request_name = "http.request #{verb} #{path}"
+              tracer.start_active_span(request_name, tags: tags) do |scope|
                 request.headers.merge!(options.headers)
-                OpenTracing.inject(scope.span.context, OpenTracing::FORMAT_RACK,
+                OpenTracing.inject(scope.span.context, OpenTracing::FORMAT_TEXT_MAP,
                                    request.headers)
 
                 res = perform_without_tracing(request, options)

data/lib/jcw/rack_tracer.rb

@@ -1,5 +1,130 @@
 # frozen_string_literal: true
 
+# inspired https://github.com/opentracing-contrib/ruby-rack-tracer/blob/master/lib/rack/tracer.rb
 module JCW
-  RackTracer = Class.new(Rack::Tracer)
+  module Rack
+    class Tracer
+      REQUEST_URI = "REQUEST_URI"
+      REQUEST_PATH = "REQUEST_PATH"
+      REQUEST_METHOD = "REQUEST_METHOD"
+
+      # Create a new Rack Tracer middleware.
+      #
+      # @param app The Rack application/middlewares stack.
+      # @param tracer [OpenTracing::Tracer] A tracer to be used when start_span, and extract
+      #        is called.
+      # @param on_start_span [Proc, nil] A callback evaluated after a new span is created.
+      # @param on_finish_span [Proc, nil] A callback evaluated after a span is finished.
+      # @param ignore_paths [Array<Class>] An array of paths to be skiped by the tracer.
+      # @param errors [Array<Class>] An array of error classes to be captured by the tracer
+      #        as errors. Errors are **not** muted by the middleware, they're re-raised afterwards.
+      def initialize(app, # rubocop:disable Metrics/ParameterLists
+                     tracer: OpenTracing.global_tracer,
+                     on_start_span: nil,
+                     on_finish_span: nil,
+                     trust_incoming_span: true,
+                     ignore_paths: Wrapper.config.rack_ignore_paths,
+                     errors: [StandardError])
+        @app = app
+        @tracer = tracer
+        @on_start_span = on_start_span
+        @on_finish_span = on_finish_span
+        @trust_incoming_span = trust_incoming_span
+        @errors = errors
+        @ignore_paths = ignore_paths
+      end
+
+      def call(env)
+        method = env[REQUEST_METHOD]
+        path = env[REQUEST_PATH]
+        url = env[REQUEST_URI]
+
+        return @app.call(env) if @ignore_paths.include?(path)
+
+        handle_error(@errors) do
+          env["uber-trace-id"] = env["HTTP_UBER_TRACE_ID"]
+          context = @tracer.extract(OpenTracing::FORMAT_TEXT_MAP, env) if @trust_incoming_span
+          @scope = build_scope(method, url, context)
+          @span = @scope.span
+
+          perform_on_start_span(env, @span, @on_start_span)
+
+          @app.call(env).tap do |status_code, _headers, _body|
+            set_tag(@span, status_code, env)
+          end
+        end
+      end
+
+      private
+
+      def handle_error(errors)
+        yield
+      rescue *errors => e
+        @span.set_tag("error", true)
+        @span.log_kv(
+          event: "error",
+          "error.kind": e.class.to_s,
+          "error.object": e,
+          message: e.message,
+          stack: e.backtrace.join("\n"),
+        )
+        raise
+      ensure
+        begin
+          @scope.close
+        ensure
+          perform_on_finish_span
+        end
+      end
+
+      def build_scope(method, url, context)
+        @tracer.start_active_span(
+          method,
+          child_of: context,
+          tags: {
+            "component" => "rack",
+            "span.kind" => "server",
+            "http.method" => method,
+            "http.url" => url,
+          },
+        )
+      end
+
+      def perform_on_start_span(env, span, on_start_span)
+        on_start_span&.call(span)
+        env["rack.span"] = span
+      end
+
+      def set_tag(span, status_code, env)
+        span.set_tag("http.status_code", status_code)
+        route = route_from_env(env)
+        span.operation_name = route if route
+      end
+
+      def route_from_env(env)
+        method = env[REQUEST_METHOD]
+        if (sinatra_route = env["sinatra.route"])
+          sinatra_route
+        elsif (rails_controller = env["action_controller.instance"])
+          "#{method} #{rails_controller.controller_name}/#{rails_controller.action_name}"
+        elsif (grape_route_args = env["grape.routing_args"] || env["rack.routing_args"])
+          "#{method} #{grape_route_from_args(grape_route_args)}"
+        end
+      end
+
+      def grape_route_from_args(route_args)
+        route_info = route_args[:route_info]
+        if route_info.respond_to?(:path)
+          route_info.path
+        elsif (rack_route_options = route_info.instance_variable_get(:@options))
+          rack_route_options[:path]
+        end
+      end
+
+      def perform_on_finish_span
+        return unless @on_finish_span
+        @on_finish_span.call(@span)
+      end
+    end
+  end
 end

data/lib/jcw/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JCW
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/jcw.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "rack/tracer"
+require "opentracing"
 require "jaeger/client"
 require "active_support"
 require "httprb-opentracing"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jcw
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Alexander Starovojtov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: gruf
   requirement: !ruby/object:Gem::Requirement
@@ -67,21 +73,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: rack-tracer
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +101,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler-audit
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +115,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: http
+  name: http-parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +129,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: http-parser
+  name: opentracing_test_tracer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -270,7 +276,8 @@ files:
 homepage: https://github.com/Cado-Labs/jcw
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: