rorvswild 1.6.0 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b40a18c6bc14739968aabfda67d1ce3b68fbd582ef16b66bc35e636ab1cc4137
-  data.tar.gz: d90c55f88561d249a723de427ce522e27133cbf2fed8c68639e029b0a7f2a6f1
+  metadata.gz: 34fc75a952dcdd5b7291e2227f2f59da531413338f0fb91ea64a61245b9368af
+  data.tar.gz: daab97444a9876ef871ca0c2832afd667cfb986fc1e101c36c97f3880f700b1a
 SHA512:
-  metadata.gz: 5ecb2843e5cf8d0556a4b412011d5facb3fdc9a936ab19836758acf3d0fb7de90ccccdad7cb4f599fc3fe9f1bbb39d112b3674a43aec1d1313d5264a643ea58a
-  data.tar.gz: e4bcb64980a094b6a4743c24d35452fc86fe53f347286272129103a321ac34e15e4ebd3fbb6d7fba24f7a77cc7b920b6b9ce626328baf91a671cb9e3382b09e4
+  metadata.gz: 3986c7c35162a29f6f4173fa4ce6728fea1eac8d2c4293fc275f850b885fb0eb472c4a3be85a473761295322aa10c490f2ad1e4ae198b4528075033eb8c977db
+  data.tar.gz: 94ecd7c5f04ecbf7608f5fd37467ebfa5d49e8f6f5e50d2be4822d4cb695c65e15daa325c8843a2f04b6c841803040dfdb020e055bb961f6122101119e1e04df

data/README.md

@@ -155,12 +155,15 @@ From the configuration file, you can tell RorVsWild to skip monitoring some requ
 production:
   api_key: API_KEY
   ignore_requests:
-    - SecretController#index
+    - HeartbeatController#show
+    - !ruby/regexp /SecretController/ # Ignore the entire controller
   ignore_jobs:
     - SecretJob
+    - !ruby/regexp /Secret::/ # Ignore the entire Secret namespace
   ignore_exceptions:
     - ActionController::RoutingError  # Ignore by default any 404
     - ZeroDivisionError
+    - !ruby/regexp /Secret::/ # Ignore all secret errors
   ignore_plugins:
     - Sidekiq # If you don't want to monitor your Sidekiq jobs
 ```
@@ -171,9 +174,9 @@ Here is the equivalent if you prefer initialising RorVsWild manually.
 # config/initializers/rorvswild.rb
 RorVsWild.start(
   api_key: "API_KEY",
-  ignore_requests: ["SecretController#index"],
-  ignore_jobs: ["SecretJob"],
-  ignore_exceptions: ["ActionController::RoutingError", "ZeroDivisionError"],
+  ignore_requests: ["ApplicationController#heartbeat", /SecretController/],
+  ignore_jobs: ["SecretJob", /Secret::/],
+  ignore_exceptions: ["ActionController::RoutingError", "ZeroDivisionError", /Secret::/],
   ignore_plugins: ["Sidekiq"])
 ```
 
@@ -218,30 +221,71 @@ In the case you want a custom logger such as Syslog, you can only do it by initi
 RorVsWild.start(api_key: "API_KEY", logger: Logger::Syslog.new)
 ```
 
-#### Server metrics monitoring
+### Deployment tracking
 
-We are adding server metrics as a beta feature.
-It monitors load average, CPU, memory, swap and disk space.
-For now, only Linux is supported.
-It has to be explicitly enabled with a feature flag :
+Since version 1.6.0, RorVsWild compares performances between each deployment.
+That is convenient to detect quickly a performance deterioration.
+
+It is working without any actions from your part if the application is :
+
+- Deployed via Capistrano
+- Inside a Git repositoriy
+- Hosted on Heroku if [Dyno metadata](https://devcenter.heroku.com/articles/dyno-metadata) is enabled
+- Hosted on Scalingo
+
+Because we are not aware of all cloud hosting providers, there is a generic method to provide these data via the configuration :
 
 ```yaml
 # config/rorvswild.yml
 production:
   api_key: API_KEY
-  features:
-    - server_metrics
+  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.com" %>
 ```
 
 Here is the equivalent if you prefer initialising RorVsWild manually :
 
 ```ruby
 # config/initializers/rorvswild.rb
-RorVsWild.start(api_key: "API_KEY", features: ["server_metrics"])
+RorVsWild.start(api_key: "API_KEY", deployment: {
+  revision: "Unique version number such as Git commit ID",
+  description: "Message such as in Git",
+  author: "Deployer's name",
+  email: "Deployer's email"
+})
 ```
 
+Only the revision is mandatory, but it's better if you are able to provide more information.
+
+
+#### Server metrics monitoring
+
+Since version 1.6.0 RorVsWild monitors server metrics such as load average, CPU, memory, swap and disk space.
+For now, only Linux is supported.
 The data are available in a server tab beside requests and jobs.
 
+Metrics are grouped by hostnames.
+Cloud providers give random hostnames which change on every deployment.
+You can manually define them:
+
+```yaml
+# config/rorvswild.yml
+production:
+  api_key: API_KEY
+  server:
+    name: <%= "Some code that return a relevant hostname" %>
+```
+
+Here is the equivalent if you prefer initialising RorVsWild manually :
+
+```ruby
+# config/initializers/rorvswild.rb
+RorVsWild.start(api_key: "API_KEY", server: {name: "host.name"})
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/rorvswild/fork )

data/lib/rorvswild/agent.rb

@@ -30,6 +30,8 @@ module RorVsWild
       @client = Client.new(@config)
       @queue = config[:queue] || Queue.new(client)
       @locator = RorVsWild::Locator.new
+      Host.load_config(config)
+      Deployment.load_config(config)
 
       RorVsWild.logger.debug("Start RorVsWild #{RorVsWild::VERSION}")
       setup_plugins
@@ -99,17 +101,17 @@ module RorVsWild
       queue_request
     end
 
-    def catch_error(extra_details = nil, &block)
+    def catch_error(context = nil, &block)
       begin
         block.call
       rescue Exception => ex
-        record_error(ex, extra_details) if !ignored_exception?(ex)
+        record_error(ex, context)
         ex
       end
     end
 
-    def record_error(exception, extra_details = nil)
-      send_error(exception_to_hash(exception, extra_details))
+    def record_error(exception, context = nil)
+      send_error(exception_to_hash(exception, context)) if !ignored_exception?(exception)
     end
 
     def push_exception(exception, options = nil)
@@ -146,11 +148,16 @@ module RorVsWild
     end
 
     def ignored_request?(name)
-      (config[:ignore_actions] || config[:ignore_requests]).include?(name)
+      config[:ignore_requests].any? { |str_or_regex| str_or_regex === name }
     end
 
     def ignored_job?(name)
-      config[:ignore_jobs].include?(name)
+      config[:ignore_jobs].any? { |str_or_regex| str_or_regex === name }
+    end
+
+    def ignored_exception?(exception)
+      return false unless config[:ignore_exceptions]
+      config[:ignore_exceptions].any? { |str_or_regex| str_or_regex === exception.class.to_s }
     end
 
     def send_deployment
@@ -199,13 +206,9 @@ module RorVsWild
         message: exception.message,
         backtrace: exception.backtrace || ["No backtrace"],
         exception: exception.class.to_s,
-        extra_details: context,
+        context: context,
         environment: Host.to_h,
       }
     end
-
-    def ignored_exception?(exception)
-      (config[:ignored_exceptions] || config[:ignore_exceptions]).include?(exception.class.to_s)
-    end
   end
 end

data/lib/rorvswild/deployment.rb

@@ -2,20 +2,30 @@
 
 module RorVsWild
   module Deployment
+    def self.load_config(config)
+      read
+      if hash = config[:deployment]
+        @description = hash[:description]
+        @revision = hash[:revision]
+        @author = hash[:author]
+        @email = hash[:email]
+      end
+    end
+
     def self.revision
-      read_once && @revision
+      @revision
     end
 
     def self.description
-      read_once && @description
+      @description
     end
 
     def self.author
-      read_once && @author
+      @author
     end
 
     def self.email
-      read_once && @email
+      @email
     end
 
     def self.ruby
@@ -38,11 +48,6 @@ module RorVsWild
       read_from_heroku || read_from_scalingo || read_from_git || read_from_capistrano
     end
 
-    def self.read_once
-      @already_read || read
-      @already_read = true
-    end
-
     private
 
     def self.read_from_heroku

data/lib/rorvswild/host.rb

@@ -2,6 +2,10 @@
 
 module RorVsWild
   module Host
+    def self.load_config(config)
+      @name = config.dig(:server, :name)
+    end
+
     def self.os
       @os_description ||= `uname -sr`.strip
     rescue Exception => ex
@@ -21,7 +25,7 @@ module RorVsWild
     end
 
     def self.name
-      if gae_instance = ENV["GAE_INSTANCE"] || ENV["CLOUD_RUN_EXECUTION"]
+      @name ||= if gae_instance = ENV["GAE_INSTANCE"] || ENV["CLOUD_RUN_EXECUTION"]
         gae_instance
       elsif dyno = ENV["DYNO"] # Heroku
         dyno.start_with?("run.") ? "run.*" :

data/lib/rorvswild/installer.rb

@@ -4,7 +4,7 @@ module RorVsWild
 
     def self.create_rails_config(api_key)
       if File.directory?("config")
-        if !File.exists?(PATH)
+        if !File.exist?(PATH)
           File.write(PATH, template(api_key))
           puts "File #{PATH} has been created. Restart / deploy your app to start collecting data."
         else
@@ -19,26 +19,34 @@ module RorVsWild
       <<YAML
 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
-    # logger: log/rorvswild.log # By default it uses Rails.logger or Logger.new(STDOUT)
+  # 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
+  # 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 repositoriy, is deployed via Capistrano.
+  # # 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.com" %>
 YAML
     end
   end

data/lib/rorvswild/rails_loader.rb

@@ -20,8 +20,9 @@ module RorVsWild
 
     def self.load_config
       if (path = Rails.root.join("config/rorvswild.yml")).exist?
-        hash = YAML.load(ERB.new(path.read).result)[Rails.env]
-        hash && hash.deep_symbolize_keys
+        yaml = ERB.new(path.read).result
+        hash = YAML.safe_load(yaml, permitted_classes: [Regexp])
+        hash[Rails.env] && hash[Rails.env].deep_symbolize_keys
       end
     end
   end

data/lib/rorvswild/version.rb

@@ -1,3 +1,3 @@
 module RorVsWild
-  VERSION = "1.6.0".freeze
+  VERSION = "1.6.2".freeze
 end

data/lib/rorvswild.rb

@@ -38,12 +38,12 @@ module RorVsWild
     agent ? agent.measure_block(name , &block) : block.call
   end
 
-  def self.catch_error(extra_details = nil, &block)
-    agent ? agent.catch_error(extra_details, &block) : block.call
+  def self.catch_error(context = nil, &block)
+    agent ? agent.catch_error(context, &block) : block.call
   end
 
-  def self.record_error(exception, extra_details = nil)
-    agent.record_error(exception, extra_details) if agent
+  def self.record_error(exception, context = nil)
+    agent.record_error(exception, context) if agent
   end
 
   def self.merge_error_context(hash)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rorvswild
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.2
 platform: ruby
 authors:
 - Alexis Bernard
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-27 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies: []
 description: Performances and errors insights for rails developers.
 email: