rorvswild 1.5.17 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ce241e0d917e560c8a5683bdc210dbd4f5158cd7bf49444ced9548d85b61e5e
-  data.tar.gz: b354848c0048368c615e4c2dd5231864a164c127af0aaf590fbfcd5c2a1cb36c
+  metadata.gz: f0d7eae69ceb93804c2297b8fb97a400e09d183eeeb46ac879dc02873ba7f5b0
+  data.tar.gz: 0bfe3e2d48fcecd010eeb399ad896d6e4e519073aa6ae0fc160ebcb9e1cf554c
 SHA512:
-  metadata.gz: fc3e48e9328b450bfb3cb7e7e4536e249470bcf7cb1fd2b3c7f67416daa66e1c281e742446a97f868276ac3028a573a84247b80b7f3053fbaeb9f9dfe4209c57
-  data.tar.gz: eab70d88fd705bdd5d679b625a9b6e06b6612cff6eaa6dc5080d6cd80a38f6f28e1a198f475b683cecdb25be7ac98d54a67eecfb8ee8cea230d987248e846823
+  metadata.gz: 5bf001a094bfa234414b8247c18d57159b734f1a829ef62997cdf66b7265fdc40e9cdad0530ecac8bc108459b202930487f0cad30b610cc4ebd7b00326ef17af
+  data.tar.gz: 25ace108524d491befd74c9682c92f2a95e17c4ee4b8e11174143bb29425685074d81923f4cf981e0f0dc313ab7c493731206037d6036d2d74ff633411519ffd

data/README.md

@@ -218,30 +218,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,16 +30,18 @@ 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
       cleanup_data
+      send_deployment
     end
 
     def load_features
       features = config[:features] || []
-      features.include?("server_metrics")
-      require "rorvswild/metrics" if features.include?("server_metrics")
+      RorVsWild.logger.info("Server metrics are now monitored enabled by default") if features.include?("server_metrics")
     end
 
     def setup_plugins
@@ -85,7 +87,7 @@ module RorVsWild
         raise
       ensure
         current_data[:runtime] = RorVsWild.clock_milliseconds - current_data[:started_at]
-        post_job
+        queue_job
       end
     end
 
@@ -96,7 +98,7 @@ module RorVsWild
     def stop_request
       return unless current_data
       current_data[:runtime] = RorVsWild.clock_milliseconds - current_data[:started_at]
-      post_request
+      queue_request
     end
 
     def catch_error(extra_details = nil, &block)
@@ -109,7 +111,7 @@ module RorVsWild
     end
 
     def record_error(exception, extra_details = nil)
-      post_error(exception_to_hash(exception, extra_details))
+      send_error(exception_to_hash(exception, extra_details))
     end
 
     def push_exception(exception, options = nil)
@@ -153,21 +155,8 @@ module RorVsWild
       config[:ignore_jobs].include?(name)
     end
 
-    def os_description
-      @os_description ||= `uname -sr`
-    rescue Exception => ex
-      @os_description = RbConfig::CONFIG["host_os"]
-    end
-
-    def hostname
-      if gae_instance = ENV["GAE_INSTANCE"] || ENV["CLOUD_RUN_EXECUTION"]
-        gae_instance
-      elsif dyno = ENV["DYNO"] # Heroku
-        dyno.start_with?("run.") ? "run.*" :
-          dyno.start_with?("release.") ? "release.*" : dyno
-      else
-        Socket.gethostname
-      end
+    def send_deployment
+      client.post("/deployments", deployment: Deployment.to_h)
     end
 
     #######################
@@ -177,7 +166,12 @@ module RorVsWild
     private
 
     def initialize_data
-      Thread.current[:rorvswild_data] = {sections: [], section_stack: [], started_at: RorVsWild.clock_milliseconds}
+      Thread.current[:rorvswild_data] = {
+        sections: [],
+        section_stack: [],
+        environment: Host.to_h,
+        started_at: RorVsWild.clock_milliseconds,
+      }
     end
 
     def cleanup_data
@@ -186,15 +180,15 @@ module RorVsWild
       result
     end
 
-    def post_request
+    def queue_request
       (data = cleanup_data) && data[:name] && queue.push_request(data)
     end
 
-    def post_job
+    def queue_job
       queue.push_job(cleanup_data)
     end
 
-    def post_error(hash)
+    def send_error(hash)
       client.post_async("/errors".freeze, error: hash)
     end
 
@@ -208,15 +202,7 @@ module RorVsWild
         backtrace: exception.backtrace || ["No backtrace"],
         exception: exception.class.to_s,
         extra_details: context,
-        environment: {
-          os: os_description,
-          user: Etc.getlogin,
-          host: Socket.gethostname,
-          ruby: RUBY_DESCRIPTION,
-          pid: Process.pid,
-          cwd: Dir.pwd,
-          lib_paths: locator.lib_paths,
-        },
+        environment: Host.to_h,
       }
     end
 

data/lib/rorvswild/deployment.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+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
+      @revision
+    end
+
+    def self.description
+      @description
+    end
+
+    def self.author
+      @author
+    end
+
+    def self.email
+      @email
+    end
+
+    def self.ruby
+      RUBY_VERSION
+    end
+
+    def self.rails
+      Rails.version if defined?(Rails)
+    end
+
+    def self.rorvswild
+      RorVsWild::VERSION
+    end
+
+    def self.to_h
+      @to_h ||= {revision: revision, description: description, author: author, email: email, ruby: ruby, rails: rails, rorvswild: rorvswild}.compact
+    end
+
+    def self.read
+      read_from_heroku || read_from_scalingo || read_from_git || read_from_capistrano
+    end
+
+    private
+
+    def self.read_from_heroku
+      return unless ENV["HEROKU_SLUG_COMMIT"]
+      @revision = ENV["HEROKU_SLUG_COMMIT"]
+      @description = ENV["HEROKU_SLUG_DESCRIPTION"]
+    end
+
+    def self.read_from_scalingo
+      return unless ENV["SOURCE_VERSION"]
+      @revision = ENV["SOURCE_VERSION"]
+    end
+
+    def self.read_from_git
+      @revision = normalize_string(`git rev-parse HEAD`) rescue nil
+      return unless @revision
+      lines = `git log -1 --pretty=%an%n%ae%n%B`.lines rescue nil
+      return unless lines
+      @author = normalize_string(lines[0])
+      @email = normalize_string(lines[1])
+      @description = lines[2..-1] && normalize_string(lines[2..-1].join)
+      @revision
+    end
+
+    def self.read_from_capistrano
+      return unless File.readable?("REVISION")
+      return unless @revision = File.read("REVISION")
+      lines = `git --git-dir ../../repo log --format=%an%n%ae%n%B -n 1 #{@revision}`.lines rescue nil
+      return unless lines
+      @author = normalize_string(lines[0])
+      @email = normalize_string(lines[1])
+      @description = lines[2..-1] && normalize_string(lines[2..-1].join)
+      @revision
+    end
+
+    def self.normalize_string(string)
+      if string
+        string = string.strip
+        string.empty? ? nil : string
+      end
+    end
+  end
+end

data/lib/rorvswild/host.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+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
+      @os_description = RbConfig::CONFIG["host_os"]
+    end
+
+    def self.user
+      Etc.getlogin
+    end
+
+    def self.ruby
+      RUBY_DESCRIPTION
+    end
+
+    def self.rails
+      Rails.version if defined?(Rails)
+    end
+
+    def self.name
+      @name ||= if gae_instance = ENV["GAE_INSTANCE"] || ENV["CLOUD_RUN_EXECUTION"]
+        gae_instance
+      elsif dyno = ENV["DYNO"] # Heroku
+        dyno.start_with?("run.") ? "run.*" :
+          dyno.start_with?("release.") ? "release.*" : dyno
+      else
+        Socket.gethostname
+      end
+    end
+
+    def self.pid
+      Process.pid
+    end
+
+    def self.cwd
+      Dir.pwd
+    end
+
+    def self.revision
+      Deployment.revision
+    end
+
+    def self.revision_description
+      Deployment.description
+    end
+
+    def self.to_h
+      @to_h ||= {os: os, user: user, host: name, ruby: ruby, rails: rails, pid: pid, cwd: cwd, revision: revision}.compact
+    end
+  end
+end

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/local/javascript/local.js

@@ -77,9 +77,9 @@ RorVsWild.Local.prototype.goToHistory = function(event) {
   this.render()
 }
 
-RorVsWild.Local.prototype.containerStyle = function() {
+RorVsWild.Local.prototype.containerClass = function() {
   if (!this.active)
-    return 'display: none !important;'
+    return "is-hidden"
 }
 
 RorVsWild.Local.kindToLanguage = function(kind) {

data/lib/rorvswild/local/local.html.erb

@@ -4,7 +4,7 @@
 </div>
 
 <script type="x-tmpl-mustache" data-partial="RorVsWild.Local">
-  <div id="rorvswild-local-requests" class="rorvswild-local-panel" style="{{containerStyle}}">
+  <div id="rorvswild-local-requests" class="rorvswild-local-panel {{containerClass}}">
 
     <div class="rorvswild-local-panel__header">
       <a href="https://www.rorvswild.com" class="rorvswild-local-panel__logo">

data/lib/rorvswild/local/stylesheet/local.css

@@ -76,6 +76,10 @@
           flex-direction: column !important;
 }
 
+.rorvswild-local-panel.is-hidden {
+  display: none !important;
+}
+
 .rorvswild-local-panel * {
   font-family: inherit !important;
   font-size: inherit !important;

data/lib/rorvswild/metrics/cpu.rb

@@ -1,30 +1,61 @@
+# frozen_string_literal: true
+
 module RorVsWild
   class Metrics
     class Cpu
       attr_reader :user, :system, :idle, :waiting, :stolen
       attr_reader :load_average, :count
 
+      def initialize
+        @old_stat = Stat.read
+      end
+
       def update
-        if vmstat = execute(:vmstat)
-          vmstat = vmstat.split("\n").last.split
-          @user = vmstat[12].to_i
-          @system = vmstat[13].to_i
-          @idle = vmstat[14].to_i
-          @waiting = vmstat[15].to_i
-          @stolen = vmstat[16].to_i
+        if @old_stat && (new_stat = Stat.read)
+          if (total = new_stat.total - @old_stat.total) > 0
+            @user = (new_stat.user - @old_stat.user) * 100 / total
+            @system = (new_stat.system - @old_stat.system) * 100 / total
+            @idle = (new_stat.idle - @old_stat.idle) * 100 / total
+            @waiting = (new_stat.iowait - @old_stat.iowait) * 100 / total
+            @stolen = (new_stat.steal - @old_stat.steal) * 100 / total
+            @old_stat = new_stat
+          end
         end
-        if uptime = execute(:uptime)
-          @load_average = uptime.split[-3].to_f
+        @load_average = File.read("/proc/loadavg").to_f if File.readable?("/proc/loadavg")
+        @count = `nproc`.to_i rescue nil
+      end
+
+      class Stat
+        attr_reader :user, :nice, :system, :idle, :iowait, :irq, :softirq, :steal, :guest, :guest_nice, :total
+
+        def initialize(user, nice, system, idle, iowait, irq, softirq, steal, guest, guest_nice)
+          @user = user
+          @nice = nice
+          @system = system
+          @idle = idle
+          @iowait = iowait
+          @irq = irq
+          @softirq = softirq
+          @steal = steal
+          @guest = guest
+          @guest_nice = guest_nice
+          @total = user + nice + system + idle + iowait + irq + softirq + steal + guest + guest_nice
         end
-        if nproc = execute(:nproc)
-          @count = nproc.to_i
+
+        def self.parse(string)
+          for row in string.lines
+            if row.start_with?("cpu ")
+              array = row.split[1..-1].map(&:to_i)[0,10]
+              array.fill(0, array.size, 10 - array.size) if array.size < 10
+              return new(*array)
+            end
+          end
+          nil
         end
-      end
 
-      def execute(command)
-        `#{command}`
-      rescue => ex
-        nil
+        def self.read
+          parse(File.read("/proc/stat")) if File.readable?("/proc/stat")
+        end
       end
     end
   end

data/lib/rorvswild/metrics/memory.rb

@@ -23,7 +23,7 @@ module RorVsWild
       SWAP_FREE = "SwapFree" # Amount of swap space that is currently unused.
 
       def update
-        info = read_meminfo
+        return unless info = read_meminfo
         @ram_total = convert_to_bytes(info[MEM_TOTAL])
         @ram_free = convert_to_bytes(info[MEM_FREE])
         @ram_available = convert_to_bytes(info[MEM_AVAILABLE])

data/lib/rorvswild/metrics.rb

@@ -1,7 +1,5 @@
 module RorVsWild
   class Metrics
-    UPDATE_INTERVAL_MS = 60_000 # One metric every minute
-
     attr_reader :cpu, :memory, :storage, :updated_at
 
     def initialize
@@ -11,22 +9,23 @@ module RorVsWild
     end
 
     def update
-      if staled?
-        cpu.update
-        memory.update
-        storage.update
-        @updated_at = RorVsWild.clock_milliseconds
-      end
+      cpu.update
+      memory.update
+      storage.update
     end
 
-    def staled?
-      !updated_at || RorVsWild.clock_milliseconds - updated_at > UPDATE_INTERVAL_MS
+    def update_every_minute
+      return unless Host.os.include?("Linux")
+      if !@updated_at || @updated_at.min != Time.now.min
+        @updated_at = Time.now
+        update
+      end
     end
 
     def to_h
       {
-        hostname: RorVsWild.agent.hostname,
-        os: RorVsWild.agent.os_description,
+        hostname: Host.name,
+        os: Host.os,
         cpu_user: cpu.user,
         cpu_system: cpu.system,
         cpu_idle: cpu.idle,

data/lib/rorvswild/plugin/net_http.rb

@@ -19,7 +19,7 @@ module RorVsWild
           end
 
           def request_with_rorvswild(req, body = nil, &block)
-            return request_without_rorvswild(req, body, &block) if request_called_twice?
+            return request_without_rorvswild(req, body, &block) if !RorVsWild.agent || request_called_twice?
             RorVsWild.agent.measure_section("#{req.method} #{address}", kind: HTTP) do
               request_without_rorvswild(req, body, &block)
             end

data/lib/rorvswild/queue.rb

@@ -1,6 +1,6 @@
 module RorVsWild
   class Queue
-    SLEEP_TIME = 30
+    SLEEP_TIME = 10
     FLUSH_TRESHOLD = 10
 
     attr_reader :mutex, :thread, :client
@@ -52,7 +52,7 @@ module RorVsWild
     end
 
     def pull_server_metrics
-      @metrics && @metrics.update && @metrics.to_h
+      @metrics && @metrics.update_every_minute && @metrics.to_h
     end
 
     def flush_indefinetely

data/lib/rorvswild/version.rb

@@ -1,3 +1,3 @@
 module RorVsWild
-  VERSION = "1.5.17".freeze
+  VERSION = "1.6.1".freeze
 end

data/lib/rorvswild.rb

@@ -1,4 +1,7 @@
 require "rorvswild/version"
+require "rorvswild/host"
+require "rorvswild/metrics"
+require "rorvswild/deployment"
 require "rorvswild/locator"
 require "rorvswild/section"
 require "rorvswild/client"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rorvswild
 version: !ruby/object:Gem::Version
-  version: 1.5.17
+  version: 1.6.1
 platform: ruby
 authors:
 - Alexis Bernard
 - Antoine Marguerie
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies: []
 description: Performances and errors insights for rails developers.
 email:
@@ -27,6 +27,8 @@ files:
 - lib/rorvswild.rb
 - lib/rorvswild/agent.rb
 - lib/rorvswild/client.rb
+- lib/rorvswild/deployment.rb
+- lib/rorvswild/host.rb
 - lib/rorvswild/installer.rb
 - lib/rorvswild/local.rb
 - lib/rorvswild/local/javascript/application.js
@@ -69,7 +71,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/BaseSecrete/rorvswild
   changelog_uri: https://github.com/BaseSecrete/rorvswild/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -85,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.22
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Ruby on Rails applications monitoring
 test_files: []