rorvswild 1.11.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b29f5881ffc0b495ede8b88ca53f68161a5bbfa09ca4005c0384a18f17a77ce9
-  data.tar.gz: 8cf948c1c9ea720aeb35068160e61a506085194c3ad2f5caa5b43f6c6c5ee5a2
+  metadata.gz: 78dcaca37ba08f20d8b6fa091902f46973d48db05feabce1ab4600bd4afb48c3
+  data.tar.gz: 626507452a31fe1e63fab2826d239c4d13f03c36e8bda1690deb1ba766733bc6
 SHA512:
-  metadata.gz: 90e4b903eec8db8e89d3c6fdb77397bb75e7bb09212d7cc86fea9a865b1d5d13ab7ea9e9d9d7d199fda10ad20d3b5fb12749eb41841329de0db0b6893e05e6db
-  data.tar.gz: 1745b14bce30d4dccc1584e35c301f55b481156f8919e5030fee11c52e879ff6b7e77b2128b286d1566f0b407666799e6b4c6551b30e457a66b3ac213e1ce0bd
+  metadata.gz: 89a838d0e59c7a552ef0b961efe32420e9f271dbff74ca9427be809dc07b8a5b6158be53c10aac5bb3c69cfb6d1682e034b5b3d5f01898814e68f2443b3ffa6e
+  data.tar.gz: 35e531b0cfe704c0641ac075713893a46a55aefd453cc6fea5a34f2f3b814639096834bb8e9a9adfb11d2041693282da525a2e2b47c3d8c830e9003050e43bdd

data/lib/rorvswild/agent.rb

@@ -113,12 +113,10 @@ module RorVsWild
 
     def start_execution(execution)
       Thread.current[:rorvswild_execution] ||= execution
-      RorVsWild::Section.start
     end
 
     def stop_execution
       return unless execution = current_execution
-      RorVsWild::Section.stop
       execution.stop
       case execution
       when Execution::Job then queue_job

data/lib/rorvswild/execution.rb

@@ -2,21 +2,21 @@
 
 module RorVsWild
   class Execution
-    attr_reader :parameters, :sections, :section_stack, :error_context, :runtime
+    attr_reader :parameters, :sections, :section_stack, :error_context, :runtime, :root_section, :queue_section
 
     attr_accessor :error, :name
 
     def initialize(name, parameters)
+      @root_section = Section::Root.new
+
       @name = name
       @parameters = parameters
       @runtime = nil
       @error = nil
       @error_context = nil
 
-      @started_at = RorVsWild.clock_milliseconds
-      @gc_section = Section.start_gc_timing
       @environment = Host.to_h
-      @section_stack = []
+      @section_stack = [@root_section]
       @sections = []
     end
 
@@ -30,20 +30,18 @@ module RorVsWild
 
     def add_queue_time(queue_time_ms)
       return unless queue_time_ms
-      @started_at -= queue_time_ms
-      section = Section.new
-      section.total_ms = queue_time_ms
-      section.gc_time_ms = 0
-      section.file = "queue"
-      section.line = 0
-      section.kind = "queue"
-      add_section(section)
+      @queue_section = Section::Queue.new(queue_time_ms)
+      add_section(@queue_section)
+      @queue_section
     end
 
     def stop
-      Section.stop_gc_timing(@gc_section)
-      @sections << @gc_section if @gc_section.calls > 0 && @gc_section.total_ms > 0
-      @runtime = RorVsWild.clock_milliseconds - @started_at
+      Section.stop # root section
+      if @root_section.gc_time_ms > 0
+        add_section(Section::GarbageCollection.new(@root_section.gc_time_ms, @root_section.gc_calls))
+      end
+      @runtime = @root_section.total_ms + @root_section.gc_time_ms
+      @runtime += @queue_section.total_ms if @queue_section
     end
 
     def as_json(options = nil)
@@ -66,25 +64,6 @@ module RorVsWild
 
     private
 
-    def start_gc_timing
-      section = Section.new
-      section.calls = GC.count
-      section.file, section.line = "ruby/gc.c", 0
-      section.add_command("GC.start")
-      section.kind = "gc"
-      section
-    end
-
-    if GC.respond_to?(:total_time)
-      def gc_total_ms
-        GC.total_time / 1_000_000.0 # nanosecond -> millisecond
-      end
-    else
-      def gc_total_ms
-        GC::Profiler.total_time * 1000 # second -> millisecond
-      end
-    end
-
     class Job < Execution
       def add_exception(exception)
         super(exception)

data/lib/rorvswild/installer.rb

@@ -27,41 +27,54 @@ development:
   # editor_url: <%= ENV.fetch("RORVSWILD_EDITOR_URL", "vscode://file${path}:${line}") %>
   # for VSCode: "vscode://file${path}:${line}"
   # for Sublime: "subl://${path}:${line}"
-  
 
 production:
-  api_key: #{api_key}
-  # ignore_requests: # Do not monitor the following actions
-  #   - SecretController#index
-  # ignore_jobs: # Do not monitor the following jobs
-  #   - SecretJob
-  # ignore_exceptions: # Do not record the following exceptions
-  #   - ActionController::RoutingError  # By default to ignore 404
-  # ignore_plugins:
-  #   - ActionController
-  #   - ActionMailer
-  #   - ActionView
-  #   - ActiveJob
-  #   - ActiveRecord
-  #   - DelayedJob
-  #   - Elasticsearch
-  #   - Mongo
-  #   - NetHttp
-  #   - Redis
-  #   - Resque
-  #   - Sidekiq
-  #
+  api_key: <%= ENV["RORVSWILD_API_KEY"] || "#{api_key}" %>
+
+  # Do not monitor the following actions.
+  ignore_requests:
+   - SecretController#index
+
+  # Do not monitor the following jobs.
+  ignore_jobs:
+    - SecretJob
+
+  # Do not monitor the following exceptions.
+  ignore_exceptions:
+    # Noisy exceptions such as ActionNotFound, UnknownHttpMethod, etc are ignored by default.
+    - <%= ActionDispatch::ExceptionWrapper.rescue_responses.keys.join("\\n    - ") %>
+    - AnotherNoisyError
+
+  # In case you want less details.
+  ignore_plugins:
+    # - ActionController
+    # - ActionMailer
+    # - ActionView
+    # - ActiveJob
+    # - ActiveRecord
+    # - DelayedJob
+    # - Elasticsearch
+    # - Faktory
+    # - Mongo
+    # - NetHttp
+    # - Rack
+    # - RailsCache
+    # - RailsError
+    # - Redis
+    # - Resque
+    # - Sidekiq
+
   # logger: log/rorvswild.log # By default it uses Rails.logger or Logger.new(STDOUT)
-  #
-  # # Deployment tracking is working without any actions from your part if the Rails app
-  # # is inside a Git repository, is deployed via Capistrano.
-  # # In the other cases, you can provide the following details.
+
+  # Deployment tracking is working without any actions from your part if the Rails app
+  # is inside a Git repository, or deployed with Capistrano, Kamal, Heroku or Scalingo.
+  # In the other cases, you can provide the following details.
   # deployment:
   #   revision: <%= "Anything that will return the deployment version" %> # Mandatory
   #   description: <%= "Eventually if you have a description such as a Git message" %>
   #   author: <%= "Author's name of the deployment" %>
   #   email: <%= "emailOf@theAuthor.example" %>
-  #
+
   # Sampling allows to send a fraction of jobs and requests.
   # If your app is sending hundred of millions of requests per month,
   # you will probably get the same precision if you send only a fraction of it.

data/lib/rorvswild/plugin/active_record.rb

@@ -50,6 +50,9 @@ module RorVsWild
       SQL_ONE_LINE_COMMENT_REGEX =/--.*$/
       SQL_MULTI_LINE_COMMENT_REGEX = /\/\*.*?\*\//m
 
+      # Catch Regexp::TimeoutError without breaking before Ruby 3.2
+      REGEXP_TIMEOUT_ERROR = defined?(Regexp::TimeoutError) ? Regexp::TimeoutError : RegexpError
+
       def normalize_sql_query(sql)
         sql = sql.to_s.gsub(SQL_STRING_REGEX, "?")
         sql.gsub!(SQL_PARAMETER_REGEX, "?")
@@ -59,6 +62,8 @@ module RorVsWild
         sql.gsub!(SQL_MULTI_LINE_COMMENT_REGEX, "")
         sql.strip!
         sql
+      rescue REGEXP_TIMEOUT_ERROR
+        nil
       end
     end
   end

data/lib/rorvswild/plugin/rails_engine.rb

@@ -58,12 +58,11 @@ module RorVsWild
         execution = RorVsWild::Execution::Request.new(env["REQUEST_URI"])
         execution.add_queue_time(calculate_queue_time(env))
         RorVsWild.agent.start_execution(execution)
-        section = RorVsWild::Section.start
+        section = execution.root_section
         section.file, section.line = method(:call).super_method.source_location
         section.commands << "Rails::Engine#call"
         super
       ensure
-        RorVsWild::Section.stop
         RorVsWild.agent.stop_execution
       end
 

data/lib/rorvswild/section.rb

@@ -28,21 +28,6 @@ module RorVsWild
       (sections = stack) && sections.last
     end
 
-    def self.start_gc_timing
-      section = Section.new
-      section.calls = GC.count
-      section.file, section.line = "ruby/gc.c", 0
-      section.add_command("GC.start")
-      section.kind = "gc"
-      section
-    end
-
-    def self.stop_gc_timing(section)
-      section.total_ms = gc_total_ms - section.gc_start_ms
-      section.calls = GC.count - section.calls
-      section
-    end
-
     if GC.respond_to?(:total_time)
       def self.gc_total_ms
         GC.total_time / 1_000_000.0 # nanosecond -> millisecond
@@ -111,5 +96,46 @@ module RorVsWild
       string = @commands.to_a.join("\n")
       string.size > COMMAND_MAX_SIZE ? string[0, COMMAND_MAX_SIZE] + " [TRUNCATED]" : string
     end
+
+    class Root < Section
+      attr_reader :gc_calls
+
+      def initialize
+        super
+        @gc_count = GC.count
+      end
+
+      def stop
+        super
+        @gc_calls = GC.count - @gc_count
+      end
+    end
+
+    class GarbageCollection < Section
+      def initialize(total_ms, calls)
+        @total_ms = total_ms
+        @calls = calls > 0 ? calls : 1
+        @kind = "gc"
+        @file, @line = "ruby/gc.c", 0
+        @commands = Set.new
+        @children_ms = 0
+        @async_ms = 0
+        add_command("GC.start")
+      end
+    end
+
+    class Queue < Section
+      def initialize(total_ms)
+        @total_ms = total_ms
+        @gc_time_ms = 0
+        @file = "queue"
+        @line = 0
+        @kind = "queue"
+        @calls = 1
+        @children_ms = 0
+        @gc_time_ms = 0
+        @async_ms = 0
+      end
+    end
   end
 end

data/lib/rorvswild/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RorVsWild
-  VERSION = "1.11.0"
+  VERSION = "1.11.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rorvswild
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.11.1
 platform: ruby
 authors:
 - Alexis Bernard