vmstator 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecd3e9cb253790a7875af885738d58676054f933
-  data.tar.gz: 99ed4992498808ff8531ccb356fa8e01dd343609
+  metadata.gz: b593666503181d0bb66d1c68a4834d62fbff3bd5
+  data.tar.gz: 297d3af6c94cde231888477dff7c1407c5f8d759
 SHA512:
-  metadata.gz: d600e96a80e3dfd9ae41989e6bf15fd0c11f5d40ab350b5d6c091ac9031a7120d3d7409f699940c9627dfe9c3c389a9a783f05844225ac8638a2a3ae3a14c372
-  data.tar.gz: 26ac32611230939c5c86436a37e9f9bb08d86b8a4eec2e6e8149ada836f12bde9cd5d531f50b56eb0be40be37f84b38fca0b6ed18cc9b936bd06d9f62c5871e7
+  metadata.gz: 582a2eba336e5ca0dca10392306f99c43566dbbef54a360daeba8f8a14c8a1d26c1d467613207811dc5ea6a795183a2a59ec73017fbee676fb03984288b9dbe4
+  data.tar.gz: 21d844a2b549883cb605469f161c02a377ae433ebeb53b78e5d8840fa6b6a1a32c7f1b0620ed47ba974359b035c5a95904518c87294da95325ea992d54917703

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vmstator (2.0.1)
+    vmstator (2.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -6,9 +6,7 @@ Vmstator is a Ruby API for [vmstat](https://en.wikipedia.org/wiki/Vmstat). It pr
 
 This gem is still in development, but has more or less working code! :)
 
-![screenshot](http://i.imgur.com/spjIhpy.png "Screen Shot")
-
-![screenshot2](http://i.imgur.com/D9TNIpY.png "Screen Shot2")
+![screenshot](http://imgur.com/a/eMpO2 "Screen Shot")
 
 ## Installation
 
@@ -39,18 +37,62 @@ Still working on this bit, but, for the mean time...
 ```ruby
 require 'vmstator'
 
-vmstats = Vmstator::Stats.new
-vmstats.flags = "-S M"
-vmstats.parse
-
-puts vmstats.data
-puts vmstats.buffer
-puts vmstats.cache
-puts vmstats.forks
-puts vmstats.active
-puts vmstats.disk_info
-puts vmstats.event_counter_statistics
-puts vmstats.slab_info
+parser = Vmstator::Parser.new
+
+# Parse command-line arguments to vmstat.
+parser.parse("-a")
+
+# Access the command-line arguments directly as methods.
+parser.active
+
+# Other Vmstator methods for vmstat:
+parser.active
+parser.average  
+parser.disk_statistics  
+parser.disk_summary  
+parser.event_counter_statistics  
+parser.forks  
+parser.parse  
+parser.slab_info  
+parser.version
+
+# If returns a Vmstator object, for example, for active memory "-a" ...
+active_memory = parser.active
+
+# Example, the available methods to access data about Vmstator::ActiveMemory objects.
+active_memory.blocks_recv  
+active_memory.buffer  
+active_memory.cntxt_swtchs  
+active_memory.idle_time   
+active_memory.kernel      
+active_memory.runnable  
+active_memory.swapped_in  
+active_memory.uninter  
+active_memory.used   
+active_memory.blocks_sent  
+active_memory.cache   
+active_memory.free          
+active_memory.interrupts  
+active_memory.non_kernel  
+active_memory.stolen    
+active_memory.swapped_to  
+active_memory.update   
+active_memory.waiting
+
+# Types of Vmstator objects:
+ActiveMemory   
+Cache  
+DiskStatistics  
+EventCounterStatistics  
+Memory  
+SlabInfo  
+AverageMemory  
+Disk   
+DiskSummary     
+Parser  
+Stats     
+VmstatError
+
 ```
 
 ## License

data/lib/vmstator/disk.rb

@@ -18,13 +18,13 @@ module Vmstator
 
     def update(data)
       if data
-        @ms      = data[:ms]      if data[:ms]
-        @cur     = data[:cur]     if data[:cur]
-        @sec     = data[:sec]     if data[:sec]
-        @name    = data[:name]    if data[:name]
-        @total   = data[:total]   if data[:total]
-        @merged  = data[:merged]  if data[:merged]
-        @sectors = data[:sectors] if data[:sectors]
+        @ms      = data[:ms]      
+        @cur     = data[:cur]     
+        @sec     = data[:sec]
+        @name    = data[:name]
+        @total   = data[:total]   
+        @merged  = data[:merged]  
+        @sectors = data[:sectors] 
       else
         return false
       end

data/lib/vmstator/version.rb

@@ -1,3 +1,3 @@
 module Vmstator
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

data/lib/vmstator.rb

@@ -17,6 +17,7 @@ require "vmstator/version"
 module Vmstator
 
   class Parser
+    
     # parse() parses the the vmstat command 
     # with optional vmstat command-line flags
     # which is passed in as a string
@@ -67,7 +68,7 @@ module Vmstator
 
     # active() will run the -a flag and return the data
     def active(flags=false)
-      flags = "-a" unless flags
+      flags  = "-a" unless flags
       output = `vmstat #{flags}`.split("\n")
       labels = output[1]
       stats  = output[2]
@@ -106,7 +107,7 @@ module Vmstator
     end
 
     # disk_statistics() will run the -d flag and return that data.
-    def disk_statistics(flags="")
+    def disk_statistics(flags=false)
       flags      = "-d" unless flags
       disk_stats = Vmstator::DiskStatistics.new
       output     = `vmstat #{flags}`.split("\n")
@@ -115,25 +116,31 @@ module Vmstator
       output.shift
       output.each do |line|
         name, total, merged, sectors, ms, total, merged, sectors, ms, cur, sec = line.split
-        data = {:name => name, :totoal => total.to_i, :merged => merged.to_i, :sectors => sectors.to_i,
-                :ms => ms.to_i,     :cur => cur.to_i,      :sec => sec.to_i }
+        data = { :name => name, 
+                 :totoal => total.to_i, 
+                 :merged => merged.to_i, 
+                 :sectors => sectors.to_i,
+                 :ms => ms.to_i,     
+                 :cur => cur.to_i,      
+                 :sec => sec.to_i }
         disk_stats.update(data)
       end
       disk_stats
     end
 
     # slab_info() will run the -m flag and return that data
-    def slab_info(flags="")
-      flags = "-m" unless flags
-      # TODO : may go back, make this an option to use sudo or not.
-      # You need sudo permission to run this flag.
-      flags = "-m" if flags.empty?
+    def slab_info(flags=false)
+      raise VmstatError("This must be run with root privileges!") unless Process.uid == 0
+      flags     = "-m" unless flags
       slab_info = Vmstator::SlabInfo.new 
       `sudo vmstat #{flags}`.split("\n").each do |info|
         next if info == "Cache                       Num  Total   Size  Pages"
         name, num, total, size, pages = info.split
-        data = { :name => name, :num => num.to_i, :total => total.to_i,
-                 :size => size.to_i,  :pages => pages.to_i }
+        data = { :name => name, 
+                 :num => num.to_i, 
+                 :total => total.to_i,
+                 :size => size.to_i,  
+                 :pages => pages.to_i }
         slab_info.update(data)
       end
       slab_info

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vmstator
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Kent 'picat' Gruber