jcw 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 110c81162cbfa9b0c7320539340e3adc8f2ecb0dc76f3ebc398ab3ef9330db31
-  data.tar.gz: 637bfb300fc81f4e07dce12983da6e4a342dbaa2445695241c7f3bd6fdd76f69
+  metadata.gz: c1f8f9b595186e86f086290543b8b4ea880a174dab1e1a94d11f8afd151479b8
+  data.tar.gz: 209f2ff14d28cd1a7ca7d586c17c53e8505ce170f23d81f5b5de42a4f6544f29
 SHA512:
-  metadata.gz: 1cd01757ae92d40d4e0bd2ba687fc62d612a3ce7a6b3178d1a4038c56e7c2877ff219a8415fe0f4c099b0930b341eaff81efe2345ce6361384c46dfaa16829ab
-  data.tar.gz: 696a1156f40a49295c53f638b2626e6269c445f30f73ad809bc725dc765673417de5c9869c39fe3cbbc58146a951ef14f4d11e7a00b6a36193358e3b73ec1c3c
+  metadata.gz: ad26e8445a04470d780aa4a4aed1f4aa50653b1db80b55cd24238fc95dde6c17d1e94e33924706c766885e957633f55ed47e50365f17cecff79b5ab3766299c9
+  data.tar.gz: d4b076df8cdcfdf35a0a31998ad7d248ce77c7dca6f6c3b6291e4d4b90b424b66c89678ac16188b1a3f5cca62a48428eec555bd6954f35c95ad228de68dcb980

data/.github/workflows/test.yml

@@ -41,7 +41,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.6, 2.7, 2.7.4, 3.0.0, 3.0.1, 3.0.2]
+        ruby: [2.6, 2.7, 2.7.4, 3.0.0, 3.0.1, 3.0.2, 3.1.0]
         experimental: [false]
 
     steps:

data/.rubocop.yml

@@ -11,6 +11,9 @@ RSpec/EmptyLineAfterHook:
 Naming/RescuedExceptionsVariableName:
   Enabled: false
 
+Style/CaseEquality:
+  Enabled: false
+
 Style/HashConversion:
   Exclude:
     - spec/**/*_spec.rb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jcw (0.2.2)
+    jcw (0.3.0)
       activesupport (>= 5.0, < 7.0.0)
       gruf (~> 2.10)
       httprb-opentracing (~> 0.4.0)
@@ -10,20 +10,20 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.4.4)
-      actionview (= 6.1.4.4)
-      activesupport (= 6.1.4.4)
+    actionpack (6.1.6.1)
+      actionview (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
       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.4)
-      activesupport (= 6.1.4.4)
+    actionview (6.1.6.1)
+      activesupport (= 6.1.6.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.4.4)
+    activesupport (6.1.6.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -37,7 +37,7 @@ GEM
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
     diff-lcs (1.4.4)
     docile (1.4.0)
@@ -49,22 +49,31 @@ GEM
     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.21.3)
+    google-protobuf (3.21.3-x86_64-darwin)
+    google-protobuf (3.21.3-x86_64-linux)
+    googleapis-common-protos-types (1.3.2)
       google-protobuf (~> 3.14)
-    grpc (1.42.0)
-      google-protobuf (~> 3.18)
+    grpc (1.48.0)
+      google-protobuf (~> 3.19)
       googleapis-common-protos-types (~> 1.0)
-    grpc-tools (1.42.0)
-    gruf (2.10.0)
+    grpc (1.48.0-x86_64-darwin)
+      google-protobuf (~> 3.19)
+      googleapis-common-protos-types (~> 1.0)
+    grpc (1.48.0-x86_64-linux)
+      google-protobuf (~> 3.19)
+      googleapis-common-protos-types (~> 1.0)
+    grpc-tools (1.48.0)
+    gruf (2.15.1)
       activesupport (> 4)
       concurrent-ruby (> 1)
-      e2mmap (~> 0.1)
+      e2mmap (>= 0.1)
       grpc (~> 1.10)
       grpc-tools (~> 1.10)
       json (>= 2.3)
-      slop (~> 4.6)
-      thwait (~> 0.1)
+      slop (>= 4.6)
+      thwait (>= 0.1)
+      zeitwerk (>= 2)
     http (5.0.4)
       addressable (~> 2.8)
       http-cookie (~> 1.0)
@@ -77,56 +86,56 @@ GEM
       ffi-compiler (>= 1.0, < 2.0)
     httprb-opentracing (0.4.0)
       opentracing (~> 0.5.0)
-    i18n (1.8.11)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     jaeger-client (1.1.0)
       opentracing (~> 0.3)
       thrift
-    json (2.6.1)
+    json (2.6.2)
     llhttp-ffi (0.4.0)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
-    loofah (2.13.0)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.6.1)
-    minitest (5.15.0)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
+    mini_portile2 (2.8.0)
+    minitest (5.16.2)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.12.5-x86_64-darwin)
+    nokogiri (1.13.8-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.12.5-x86_64-linux)
+    nokogiri (1.13.8-x86_64-linux)
       racc (~> 1.4)
     opentracing (0.5.0)
     opentracing_test_tracer (0.1.1)
       opentracing
-    parallel (1.21.0)
-    parser (3.0.3.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
     racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (6.1.4.4)
-      actionpack (= 6.1.4.4)
-      activesupport (= 6.1.4.4)
+    railties (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
       method_source
-      rake (>= 0.13)
+      rake (>= 12.2)
       thor (~> 1.0)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -141,37 +150,36 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    rubocop (1.17.0)
+    rubocop (1.30.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.0)
-      parser (>= 3.0.1.1)
-    rubocop-config-umbrellio (1.17.0.53)
-      rubocop (= 1.17.0)
-      rubocop-performance (= 1.10.0)
-      rubocop-rails (= 2.9.1)
-      rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 2.2.0)
-      rubocop-sequel (= 0.2.0)
-    rubocop-performance (1.10.0)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-config-umbrellio (1.30.0.65)
+      rubocop (~> 1.30.0)
+      rubocop-performance (~> 1.14.0)
+      rubocop-rails (~> 2.14.2)
+      rubocop-rake (~> 0.6.0)
+      rubocop-rspec (~> 2.11.1)
+      rubocop-sequel (~> 0.3.3)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
+    rubocop-rails (2.14.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    rubocop-sequel (0.2.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
+    rubocop-sequel (0.3.4)
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
@@ -181,18 +189,18 @@ GEM
     simplecov-html (0.12.3)
     simplecov-lcov (0.8.0)
     simplecov_json_formatter (0.1.3)
-    slop (4.9.1)
-    thor (1.1.0)
-    thrift (0.15.0)
+    slop (4.9.2)
+    thor (1.2.1)
+    thrift (0.16.0)
     thwait (0.2.0)
       e2mmap
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8)
-    unicode-display_width (2.1.0)
-    zeitwerk (2.5.1)
+    unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   ruby
@@ -215,4 +223,4 @@ DEPENDENCIES
   simplecov-lcov
 
 BUNDLED WITH
-   2.2.15
+   2.2.31

data/README.md

@@ -42,7 +42,7 @@ UDP Sender(default):
     hostname: "custom-hostname",
     custom_tag: "custom-tag-value",
   }
-  config.rack_ignore_paths = %w[/api/test]
+  config.rack_ignore_path_patterns = ["/api/test", %r{/sidekiq}]
 end
 
 # Set middleware for wrapping all requests
@@ -60,7 +60,7 @@ TCP Sender:
     hostname: "custom-hostname",
     custom_tag: "custom-tag-value",
   }
-  config.rack_ignore_paths = %w[/api/test]
+  config.rack_ignore_path_patterns = ["/api/test", %r{/sidekiq}]
 end
 
 # Set middleware for wrapping all requests

data/lib/jcw/config.rb

@@ -9,7 +9,7 @@ module JCW
                 :flush_interval,
                 :tags,
                 :grpc_ignore_methods,
-                :rack_ignore_paths
+                :rack_ignore_path_patterns
 
     def enabled
       @enabled ||= false
@@ -41,8 +41,8 @@ module JCW
       @grpc_ignore_methods ||= []
     end
 
-    def rack_ignore_paths
-      @rack_ignore_paths ||= []
+    def rack_ignore_path_patterns
+      @rack_ignore_path_patterns ||= []
     end
   end
 end

data/lib/jcw/rack_tracer.rb

@@ -15,7 +15,7 @@ module JCW
       #        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 ignore_path_patterns [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
@@ -23,7 +23,7 @@ module JCW
                      on_start_span: nil,
                      on_finish_span: nil,
                      trust_incoming_span: true,
-                     ignore_paths: Wrapper.config.rack_ignore_paths,
+                     ignore_path_patterns: Wrapper.config.rack_ignore_path_patterns,
                      errors: [StandardError])
         @app = app
         @tracer = tracer
@@ -31,7 +31,7 @@ module JCW
         @on_finish_span = on_finish_span
         @trust_incoming_span = trust_incoming_span
         @errors = errors
-        @ignore_paths = ignore_paths
+        @ignore_path_patterns = ignore_path_patterns
       end
 
       def call(env)
@@ -39,44 +39,31 @@ module JCW
         path = env[REQUEST_PATH]
         url = env[REQUEST_URI]
 
-        return @app.call(env) if @ignore_paths.include?(path)
+        return @app.call(env) if @ignore_path_patterns.find { |pattern| pattern === 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"),
-        )
+        set_extract_env(env)
+        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)
+        call_request(env, span)
+      rescue *@errors => error
+        build_error_log(span, error)
         raise
       ensure
         begin
-          @scope.close
+          close_scope(scope)
         ensure
-          perform_on_finish_span
+          perform_on_finish_span(span)
         end
       end
 
+      private
+
+      def set_extract_env(env)
+        env["uber-trace-id"] = env["HTTP_UBER_TRACE_ID"]
+      end
+
       def build_scope(method, url, context)
         @tracer.start_active_span(
           method,
@@ -95,10 +82,16 @@ module JCW
         env["rack.span"] = span
       end
 
+      def call_request(env, span)
+        @app.call(env).tap do |status_code, _headers, _body|
+          set_tag(span, status_code, env)
+        end
+      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
+        span.operation_name = route
       end
 
       def route_from_env(env)
@@ -109,6 +102,8 @@ module JCW
           "#{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)}"
+        else
+          "#{method} #{env[REQUEST_PATH] || env["SCRIPT_NAME"] || env["PATH_INFO"]}".strip
         end
       end
 
@@ -121,9 +116,24 @@ module JCW
         end
       end
 
-      def perform_on_finish_span
+      def build_error_log(span, error)
+        span.set_tag("error", true)
+        span.log_kv(
+          event: "error",
+          "error.kind": error.class.to_s,
+          "error.object": error,
+          message: error.message,
+          stack: error.backtrace.join("\n"),
+        )
+      end
+
+      def perform_on_finish_span(span)
         return unless @on_finish_span
-        @on_finish_span.call(@span)
+        @on_finish_span.call(span)
+      end
+
+      def close_scope(scope)
+        scope&.close
       end
     end
   end

data/lib/jcw/subscriber.rb

@@ -7,12 +7,12 @@ module JCW
     IGNORED_PAYLOAD_KEYS = %i[request response headers exception exception_object].freeze
 
     def subscribe_to_event!(event)
-      ActiveSupport::Notifications.subscribe(event) do |name, _start, _finish, _uid, payload|
-        add(name, payload)
+      ActiveSupport::Notifications.subscribe(event) do |name, start, finish, _uid, payload|
+        add(name, payload, finish - start)
       end
     end
 
-    def add(name, payload)
+    def add(name, payload, duration)
       # skip Rails internal events
       return if name.start_with?("!")
 
@@ -23,7 +23,10 @@ module JCW
         # we should only mutate the copy of the payload
         payload = payload.dup
         IGNORED_PAYLOAD_KEYS.each { |key| payload.delete(key) if payload.key?(key) }
+      else
+        payload = { payload: payload }
       end
+      payload[:duration] = duration
 
       span.log_kv(message: name, context: JSON.dump(payload))
     end

data/lib/jcw/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jcw
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexander Starovojtov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -293,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Wrapper for jaeger-client