rorvswild 1.5.14 → 1.5.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46b5f40b58c450a91d4ccef20ecca01087c6a91ab5914fc15dacf98f759ba2ef
-  data.tar.gz: '094aaa9bccc0c1ba609407de5f253875ef86a537392cc740d5daea3b35b6b294'
+  metadata.gz: 29d23fa806fe2d9547169a35795b4b313bf7510264aba4d0f8f3471ae7acf047
+  data.tar.gz: 681d88bef1fb76ede952387ef1d8ffbdf4bfa4cbf08f990f7964624401ff71a9
 SHA512:
-  metadata.gz: d3f133b046fe451a3f2614a56db5b4581e74f1679ee1a5678f4e03ad070c1e57c14ae344d59126efe217aedaac9f27b9e09c19501bb5c1a64c395e5199352c74
-  data.tar.gz: ebf70177f6200fd0f2103e4cd2f2a3fe8378a6a02871c5d66de5299c2228c4906d17c23fc3185b6b0a3f7385abc3b28dd248f6554864ec93bbb21911a5499624
+  metadata.gz: e54dba0143bdb8e94677519698857c7ddc62f91ecb0a876ecc9e0e2fb402e4d11055a59f03cca1c2ca5a2e73b82cf5380574d9e3e4c73d1a66e21c7ea54cfe6c
+  data.tar.gz: 92d4cb2e15015929ccc609b6b81837fb1a78ea12ebe4538555e0a023266fc852001d1aa17d7e620b50dd6ac3f856cbf08bba1d3cb9e4f24f10333b1faa26064d

data/README.md

@@ -218,6 +218,30 @@ 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
+
+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 :
+
+```yaml
+# config/rorvswild.yml
+production:
+  api_key: API_KEY
+  features:
+    - server_metrics
+```
+
+Here is the equivalent if you prefer initialising RorVsWild manually :
+
+```ruby
+# config/initializers/rorvswild.rb
+RorVsWild.start(api_key: "API_KEY", features: ["server_metrics"])
+```
+
+The data are available in a server tab beside requests and jobs.
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/rorvswild/fork )

data/lib/rorvswild/agent.rb

@@ -26,6 +26,7 @@ module RorVsWild
 
     def initialize(config)
       @config = self.class.default_config.merge(config)
+      load_features
       @client = Client.new(@config)
       @queue = config[:queue] || Queue.new(client)
       @locator = RorVsWild::Locator.new
@@ -35,6 +36,12 @@ module RorVsWild
       cleanup_data
     end
 
+    def load_features
+      features = config[:features] || []
+      features.include?("server_metrics")
+      require "rorvswild/metrics" if features.include?("server_metrics")
+    end
+
     def setup_plugins
       for name in RorVsWild::Plugin.constants
         next if config[:ignore_plugins] && config[:ignore_plugins].include?(name.to_s)
@@ -146,6 +153,12 @@ 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
+
     #######################
     ### Private methods ###
     #######################
@@ -199,11 +212,5 @@ module RorVsWild
     def ignored_exception?(exception)
       (config[:ignored_exceptions] || config[:ignore_exceptions]).include?(exception.class.to_s)
     end
-
-    def os_description
-      @os_description ||= `uname -a`
-    rescue Exception => ex
-      @os_description = RUBY_PLATFORM
-    end
   end
 end

data/lib/rorvswild/metrics/cpu.rb

@@ -0,0 +1,31 @@
+module RorVsWild
+  class Metrics
+    class Cpu
+      attr_reader :user, :system, :idle, :waiting, :stolen
+      attr_reader :load_average, :count
+
+      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
+        end
+        if uptime = execute(:uptime)
+          @load_average = uptime.split[-3].to_f
+        end
+        if nproc = execute(:nproc)
+          @count = nproc.to_i
+        end
+      end
+
+      def execute(command)
+        `#{command}`
+      rescue => ex
+        nil
+      end
+    end
+  end
+end

data/lib/rorvswild/metrics/memory.rb

@@ -0,0 +1,57 @@
+module RorVsWild
+  class Metrics
+    class Memory
+      attr_reader :ram_total, :ram_free, :ram_available, :ram_buffers, :ram_cached
+      attr_reader :swap_total, :swap_free
+      attr_reader :storage_total, :storage_used
+
+      def ram_used
+        ram_total - ram_available
+      end
+
+      def swap_used
+        swap_total - swap_free
+      end
+
+      PROC_MEMINFO = "/proc/meminfo".freeze
+      MEM_TOTAL = "MemTotal" # Total usable RAM (i.e., physical RAM minus a few reserved bits and the kernel binary code).
+      MEM_FREE = "MemFree" # The sum of LowFree+HighFree.
+      MEM_AVAILABLE = "MemAvailable" # An estimate of how much memory is available for starting new applications, without swapping.
+      BUFFERS = "Buffers" # Relatively temporary storage for raw disk blocks that shouldn't get tremendously large (20MB or so).
+      CACHED = "Cached" # In-memory cache for files read from the disk (the page cache).  Doesn't include SwapCached.
+      SWAP_TOTAL = "SwapTotal" # Total amount of swap space available.
+      SWAP_FREE = "SwapFree" # Amount of swap space that is currently unused.
+
+      def update
+        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])
+        @ram_buffers = convert_to_bytes(info[BUFFERS])
+        @ram_cached = convert_to_bytes(info[CACHED])
+        @swap_total = convert_to_bytes(info[SWAP_TOTAL])
+        @swap_free = convert_to_bytes(info[SWAP_FREE])
+      end
+
+      private
+
+      def units
+        @units ||= {"kb" => 1000, "mb" => 1000 * 1000, "gb" => 1000 * 1000 * 1000}.freeze
+      end
+
+      def read_meminfo
+        return unless File.readable?(PROC_MEMINFO)
+        File.read(PROC_MEMINFO).split("\n").reduce({}) do |hash, line|
+          name, value = line.split(":")
+          hash[name] = value.strip
+          hash
+        end
+      end
+
+      def convert_to_bytes(string)
+        value, unit = string.split
+        value.to_i * units[unit.downcase]
+      end
+    end
+  end
+end

data/lib/rorvswild/metrics/storage.rb

@@ -0,0 +1,17 @@
+module RorVsWild
+  class Metrics
+    class Storage
+      attr_reader :used, :free
+
+      def update
+        array = `df -k | grep " /$"`.split
+        @used = array[2].to_i * 1000
+        @free = array[3].to_i * 1000
+      end
+
+      def total
+        used + free
+      end
+    end
+  end
+end

data/lib/rorvswild/metrics.rb

@@ -0,0 +1,54 @@
+module RorVsWild
+  class Metrics
+    UPDATE_INTERVAL_MS = 60_000 # One metric every minute
+
+    attr_reader :cpu, :memory, :storage, :updated_at
+
+    def initialize
+      @cpu = RorVsWild::Metrics::Cpu.new
+      @memory = RorVsWild::Metrics::Memory.new
+      @storage = RorVsWild::Metrics::Storage.new
+    end
+
+    def update
+      if staled?
+        cpu.update
+        memory.update
+        storage.update
+        @updated_at = RorVsWild.clock_milliseconds
+      end
+    end
+
+    def staled?
+      !updated_at || RorVsWild.clock_milliseconds - updated_at > UPDATE_INTERVAL_MS
+    end
+
+    def to_h
+      {
+        hostname: Socket.gethostname,
+        os: RorVsWild.agent.os_description,
+        cpu_user: cpu.user,
+        cpu_system: cpu.system,
+        cpu_idle: cpu.idle,
+        cpu_waiting: cpu.waiting,
+        cpu_stolen: cpu.stolen,
+        cpu_count: cpu.count,
+        load_average: cpu.load_average,
+        ram_total: memory.ram_total,
+        ram_free: memory.ram_free,
+        ram_used: memory.ram_used,
+        ram_cached: memory.ram_cached,
+        swap_total: memory.swap_total,
+        swap_used: memory.swap_used,
+        swap_free: memory.swap_free,
+        storage_total: storage.total,
+        storage_used: storage.used,
+        storage_free: storage.free,
+      }
+    end
+  end
+end
+
+require "rorvswild/metrics/cpu"
+require "rorvswild/metrics/memory"
+require "rorvswild/metrics/storage"

data/lib/rorvswild/queue.rb

@@ -1,6 +1,6 @@
 module RorVsWild
   class Queue
-    SLEEP_TIME = 10
+    SLEEP_TIME = 30
     FLUSH_TRESHOLD = 10
 
     attr_reader :mutex, :thread, :client
@@ -11,6 +11,7 @@ module RorVsWild
       @requests = []
       @client = client
       @mutex = Mutex.new
+      @metrics = RorVsWild::Metrics.new if defined?(Metrics)
       Kernel.at_exit { flush }
     end
 
@@ -50,6 +51,10 @@ module RorVsWild
       result
     end
 
+    def pull_server_metrics
+      @metrics && @metrics.update && @metrics.to_h
+    end
+
     def flush_indefinetely
       sleep(SLEEP_TIME) and flush while true
     rescue Exception => ex
@@ -60,6 +65,7 @@ module RorVsWild
     def flush
       data = pull_jobs and client.post("/jobs", jobs: data)
       data = pull_requests and client.post("/requests", requests: data)
+      data = pull_server_metrics and client.post("/metrics", metrics: data)
     end
 
     def start_thread

data/lib/rorvswild/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rorvswild
 version: !ruby/object:Gem::Version
-  version: 1.5.14
+  version: 1.5.15
 platform: ruby
 authors:
 - Alexis Bernard
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-15 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies: []
 description: Performances and errors insights for rails developers.
 email:
@@ -40,6 +40,10 @@ files:
 - lib/rorvswild/local/stylesheet/local.css
 - lib/rorvswild/local/stylesheet/vendor/prism.css
 - lib/rorvswild/locator.rb
+- lib/rorvswild/metrics.rb
+- lib/rorvswild/metrics/cpu.rb
+- lib/rorvswild/metrics/memory.rb
+- lib/rorvswild/metrics/storage.rb
 - lib/rorvswild/plugin/action_controller.rb
 - lib/rorvswild/plugin/action_mailer.rb
 - lib/rorvswild/plugin/action_view.rb