rorvswild 1.5.11 → 1.5.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35897aa29faf0bcc0fe63db30ef4e837ce9a29fea2527b830bdd81c22f28b3b5
-  data.tar.gz: 8c2f951e47e9a4834ed97068651077d5672b2cc909799c240ab41e4eb7f6145d
+  metadata.gz: 46b5f40b58c450a91d4ccef20ecca01087c6a91ab5914fc15dacf98f759ba2ef
+  data.tar.gz: '094aaa9bccc0c1ba609407de5f253875ef86a537392cc740d5daea3b35b6b294'
 SHA512:
-  metadata.gz: f94a20f60b6967ded361bc37a695fe9cef4f2b79d5d63d7a4ff658189eadd351dd9e587a25950bb9fe2a3dd353a55dbf9b095cdd96ba43a276796abad589e2cb
-  data.tar.gz: f89fb8baf1d6db2d7d1d6af631740423402df53112c60474061fd1514744bc727f79cd4e8c07c7ddd3a98ea236723b74cffcf175593f829b022e7ac442ce4e45
+  metadata.gz: d3f133b046fe451a3f2614a56db5b4581e74f1679ee1a5678f4e03ad070c1e57c14ae344d59126efe217aedaac9f27b9e09c19501bb5c1a64c395e5199352c74
+  data.tar.gz: ebf70177f6200fd0f2103e4cd2f2a3fe8378a6a02871c5d66de5299c2228c4906d17c23fc3185b6b0a3f7385abc3b28dd248f6554864ec93bbb21911a5499624

data/README.md

@@ -58,19 +58,18 @@ It shows most of the requests performances insights *RoRvsWild.com* displays. **
 
 *RoRvsWild Local* renders a small button in the bottom left corner of your page showing the runtime of the current request. If you click on it, you get all the profiled sections ordered by impact, which is depending on the sections average runtime and the calls count. As on RoRvsWild.com, the bottleneck is always on the top of the list.
 
-Sometimes the widget displayed in the bottom left corner can be annoying depending on your site layout. You can change its position like in the example below with the `widget` option :
-
+You may want to hide or change the widget position like in the example below with the `widget` option :
 
 ```yaml
 # config/rorvswild.yml
 
 development:
-  widget: top-right # Default is bottom-left
-  # All possition values :
-  #   top-left, top-right, bottom-right, bottom-left, hidden
+  widget: top-right 
+  
+#accepted values : top-left, top-right, bottom-right, bottom-left (default), hidden
 ```
 
-If you choose to hide the widget, you can still see request profilings via the following URL http://localhost:3000/rorvswild.
+You can still access the profiler at http://localhost:3000/rorvswild if you choose to hide the widget.
 
 Be aware that the performances on your development machine may vary from the production server. Obviously because of the different hardware and database size. Also, Rails is reloading all the code in development environment and this takes quite a lot of time.
 To prevent this behaviour and better match the production, turn on cache_classes in your config/environments/development.rb:
@@ -90,24 +89,22 @@ If you are using `Rack::Deflater` middleware you won't see the small button in t
 *RoRvsWild.com* makes it easy to monitor requests, background jobs and errors in your production and staging environment.
 It also comes with some extra options listed below.
 
-#### Measure any code
+#### Measure any section of code
 
-You can measure any code like this (useful to monitor cronjobs):
+RorVsWild measures a lot of events such as SQL queries. But it might not be enough for you. There is a solution to measure any section of code to help you find the most hidden bottlenecks.
 
 ```ruby
-RorVsWild.measure_code("User.all.do_something_great")
-```
+# Measure a code given as a string
+RorVsWild.measure("bubble_sort(array)")
 
-Or like that:
+# Measure a code given as a block
+RorVsWild.measure { bubble_sort(array) }
 
-```ruby
-RorVsWild.measure_block("A great job name") { User.all.do_something_great }
+# Measure a code given as a block with an optional description
+RorVsWild.measure("Optional description") { bubble_sort(array) }
 ```
 
-Then it will appear in the jobs page.
-
-Note that Calling `measure_code` or `measure_block` inside or a request or a job will add a section.
-That is convenient to profile finely parts of your code.
+For each custom measure, a section is added with the file name and line number where it has been called.
 
 #### Send errors manually
 
@@ -137,6 +134,18 @@ RorVsWild.record_error(exception, {something: "important"})
 RorVsWild.catch_error(something: "important") { 1 / 0 }
 ```
 
+It is also possible to pre-fill this context data at the begining of each request or job :
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :prefill_error_context
+
+  def prefill_error_context
+    RorVsWild.merge_error_context(something: "important")
+  end
+end
+```
+
 #### Ignore requests, jobs, exceptions and plugins
 
 From the configuration file, you can tell RorVsWild to skip monitoring some requests, jobs, exceptions and plugins.

data/lib/rorvswild/agent.rb

@@ -16,7 +16,7 @@ module RorVsWild
 
     def self.default_ignored_exceptions
       if defined?(Rails)
-        %w[ActionController::RoutingError] + Rails.application.config.action_dispatch.rescue_responses.map { |(key,value)| key }
+        ActionDispatch::ExceptionWrapper.rescue_responses.keys
       else
         []
       end
@@ -49,7 +49,7 @@ module RorVsWild
       measure_block(code) { eval(code) }
     end
 
-    def measure_block(name, kind = "code".freeze, &block)
+    def measure_block(name = nil, kind = "code".freeze, &block)
       current_data ? measure_section(name, kind: kind, &block) : measure_job(name, &block)
     end
 
@@ -113,6 +113,18 @@ module RorVsWild
       current_data[:error]
     end
 
+    def merge_error_context(hash)
+      self.error_context = error_context ? error_context.merge(hash) : hash
+    end
+
+    def error_context
+      current_data[:error_context] if current_data
+    end
+
+    def error_context=(hash)
+      current_data[:error_context] = hash if current_data
+    end
+
     def current_data
       Thread.current[:rorvswild_data]
     end
@@ -162,15 +174,16 @@ module RorVsWild
       client.post_async("/errors".freeze, error: hash)
     end
 
-    def exception_to_hash(exception, extra_details = nil)
+    def exception_to_hash(exception, context = nil)
       file, line = locator.find_most_relevant_file_and_line_from_exception(exception)
+      context = context ? error_context.merge(context) : error_context if error_context
       {
         line: line.to_i,
         file: locator.relative_path(file),
         message: exception.message,
         backtrace: exception.backtrace || ["No backtrace"],
         exception: exception.class.to_s,
-        extra_details: extra_details,
+        extra_details: context,
         environment: {
           os: os_description,
           user: Etc.getlogin,

data/lib/rorvswild/plugin/net_http.rb

@@ -2,7 +2,6 @@ module RorVsWild
   module Plugin
     class NetHttp
       HTTP = "http".freeze
-      HTTPS = "https".freeze
 
       def self.setup
         return if !defined?(Net::HTTP)
@@ -21,9 +20,7 @@ module RorVsWild
 
           def request_with_rorvswild(req, body = nil, &block)
             return request_without_rorvswild(req, body, &block) if request_called_twice?
-            scheme = use_ssl? ? HTTPS : HTTP
-            url = "#{req.method} #{scheme}://#{address}#{req.path}"
-            RorVsWild.agent.measure_section(url, kind: HTTP) do
+            RorVsWild.agent.measure_section("#{req.method} #{address}", kind: HTTP) do
               request_without_rorvswild(req, body, &block)
             end
           end

data/lib/rorvswild/plugin/redis.rb

@@ -18,7 +18,7 @@ module RorVsWild
       end
 
       def self.commands_to_string(commands)
-        commands.map { |c| c[0] == :auth ? "auth *****".freeze : c.join(" ".freeze) }.join("\n".freeze)
+        commands.map { |c| c[0]  }.join("\n".freeze)
       end
 
       APPENDABLE_COMMANDS = [:auth, :select]

data/lib/rorvswild/rails_loader.rb

@@ -10,7 +10,7 @@ module RorVsWild
     def self.start
       return if RorVsWild.agent
 
-      if (config = load_config) && config["api_key"]
+      if (config = load_config) && config[:api_key]
         RorVsWild.start(config)
       elsif Rails.env.development?
         require "rorvswild/local"

data/lib/rorvswild/version.rb

@@ -1,3 +1,3 @@
 module RorVsWild
-  VERSION = "1.5.11".freeze
+  VERSION = "1.5.14".freeze
 end

data/lib/rorvswild.rb

@@ -23,6 +23,10 @@ module RorVsWild
     @logger ||= initialize_logger
   end
 
+  def self.measure(code_or_name = nil, &block)
+    block ? measure_block(code_or_name, &block) : measure_code(code_or_name)
+  end
+
   def self.measure_code(code)
     agent ? agent.measure_code(code) : eval(code)
   end
@@ -39,6 +43,10 @@ module RorVsWild
     agent.record_error(exception, extra_details) if agent
   end
 
+  def self.merge_error_context(hash)
+    agent.merge_error_context(hash) if agent
+  end
+
   def self.initialize_logger(destination = nil)
     if destination.respond_to?(:info) && destination.respond_to?(:warn) && destination.respond_to?(:error)
       destination

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rorvswild
 version: !ruby/object:Gem::Version
-  version: 1.5.11
+  version: 1.5.14
 platform: ruby
 authors:
 - Alexis Bernard
 - Antoine Marguerie
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies: []
 description: Performances and errors insights for rails developers.
 email:
@@ -62,8 +62,10 @@ files:
 homepage: https://www.rorvswild.com
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/BaseSecrete/rorvswild
+  changelog_uri: https://github.com/BaseSecrete/rorvswild/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,8 +80,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Ruby on Rails applications monitoring
 test_files: []