vmstator 2.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7f7a43819a1849279655e1056a3be2b802ae83c
-  data.tar.gz: 928c84ecd16c33addd20d1fdac5b7ed3c9becc2c
+  metadata.gz: b85df90cea71304f1d1425813adf72f828fda9ad
+  data.tar.gz: 1e3611b676d28290bc3adde06b0e05f66c4f5b7c
 SHA512:
-  metadata.gz: faaa1554c57651f0efebfbcbdfd951e506803a0cd99ce9cd40a7baeb081d8f90b792a914f666cde5688c309fb267aff3a10c646effee35eedec76164b9227e65
-  data.tar.gz: afe1fc90504fda4b1c77d4167e14b9f133082e6c4dd508eb10572c00f0bae453e996e811007d76231b4738ea1ed3ba53588406dd36c380dc0443ca52fd05acb6
+  metadata.gz: 238ecaa11790d77c4c208a5b26b6ffefd3698903362c31c3a59ef66ae298e474999bd6970727beb50dfe8e48d5763a37a2244c4cfda1d4f06390b928399bf009
+  data.tar.gz: 8d5b8f87992b861901f1d1ca88476c5e03d531b8dbef238cb8191596ba8698720cb86a164ba75b8180abe025a79d4cdb61ba453563442d7f899f95e2596974e4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vmstator (2.0.4)
+    vmstator (2.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -32,4 +32,4 @@ DEPENDENCIES
   vmstator!
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/README.md

@@ -2,9 +2,13 @@
 
 Vmstator is a Ruby API for [vmstat](https://en.wikipedia.org/wiki/Vmstat). It provides an [OO](https://www.tutorialspoint.com/ruby/ruby_object_oriented.htm) interface to be able to parse the contents of the output of vmstat and access that infromation intuitively.
 
+#### Supported Platforms
+
+Currently working on / testing on Debian GNU/Linux 8  
+
 ## Screen Shot
 
-![screenshot](http://i.imgur.com/RKs36Pa.png "Screen Shot")
+![screenshot](http://i.imgur.com/q5WkVhQ.png "Screen Shot")
 
 ## Installation
 

data/examples/linux_example.rb

@@ -0,0 +1,32 @@
+# Path setting slight of hand:
+$: << File.expand_path("../../lib", __FILE__)
+require 'vmstator'
+
+parser = Vmstator::Parser.new
+
+parser.active  
+# => Vmstator::DiskSummary
+
+parser.average  
+# => Vmstator::DiskSummary
+
+parser.disk_statistics  
+# => Vmstator::DiskStatistics
+ 
+parser.disk_summary  
+# => Vmstator::DiskSummary
+
+parser.event_counter_statistics  
+# => Vmstator::EventCounterStatistics
+
+parser.slab_info  
+# => Vmstator::SlabInfo
+
+parser.forks  
+# => Integer
+
+parser.parse("-a -S m")
+# => Whatever the flags were will determine output.
+
+parser.version
+# => String containing vmstat's version number.

data/examples/macOS_example.rb

@@ -0,0 +1,29 @@
+# Path setting slight of hand:
+$: << File.expand_path("../../lib", __FILE__)
+require 'vmstator'
+require 'pry'
+
+parser = Vmstator::Parser.new
+macos_pages = parser.parse
+
+puts "                Active: " + macos_pages.active.to_s
+puts "             Anonymous: " + macos_pages.anonymous.to_s
+puts "          Compressions: " + macos_pages.compressions.to_s
+puts "         Copy on Write: " + macos_pages.copy_on_write.to_s
+puts "        Decompressions: " + macos_pages.decompressions.to_s
+puts "           File Backed: " + macos_pages.file_backed.to_s
+puts "            Pages Free: " + macos_pages.free.to_s
+puts "              Inactive: " + macos_pages.inactive.to_s
+puts "                   Ins: " + macos_pages.ins.to_s
+puts "Occupied by Compressor: " + macos_pages.occupied_by_compressor.to_s
+puts "                  Outs: " + macos_pages.outs.to_s
+puts "             Purgeable: " + macos_pages.purgeable.to_s
+puts "           Reactivated: " + macos_pages.reactivated.to_s
+puts "  Stored in Compressor: " + macos_pages.stored_in_compressor.to_s
+puts "              Swap Ins: " + macos_pages.swapins.to_s
+puts "             Swap Outs: " + macos_pages.swapouts.to_s
+puts "             Throttled: " + macos_pages.throttled.to_s
+puts "    Translation Faults: " + macos_pages.translation_faults.to_s
+puts "            Wired Down: " + macos_pages.wired_down.to_s
+puts "           Zero Filled: " + macos_pages.zero_filled.to_s
+

data/lib/vmstator.rb

@@ -1,17 +1,16 @@
 require "vmstator/errors"
 require "vmstator/version"
 require "vmstator/stats"
-require "vmstator/memory"
-require "vmstator/active"
-require "vmstator/average"
-require "vmstator/cache"
-require "vmstator/disk"
-require "vmstator/disk_statistics"
-require "vmstator/disk_summary"
-require "vmstator/errors"
-require "vmstator/event_counter_statistics"
-require "vmstator/slab_info"
-require "vmstator/version"
+require "vmstator/macos/pages"
+require "vmstator/linux/memory"
+require "vmstator/linux/active"
+require "vmstator/linux/average"
+require "vmstator/linux/cache"
+require "vmstator/linux/disk"
+require "vmstator/linux/disk_statistics"
+require "vmstator/linux/disk_summary"
+require "vmstator/linux/event_counter_statistics"
+require "vmstator/linux/slab_info"
 
 module Vmstator
 
@@ -21,35 +20,54 @@ module Vmstator
     # with optional vmstat command-line flags
     # which is passed in as a string
     def parse(flags=false)
-      if flags 
-        if flags =~ /(-d|--disk)/
-          # parse instances of disk_statistics
-          return disk_statistics(flags)
-        elsif flags =~ /(-D|--disk-sum)/
-          # parse instances of disk summary
-          return disk_summary(flags)
-        elsif flags =~ /(-a|--active)/
-          # parse instances of active memory
-          return active(flags)
-        elsif flags =~ /(-m|--slabs)/
-          # parse instances of slab info
-          return slab_info(flags)
-        elsif flags =~ /(-f|--forks)/
-          # parse instances of forks
-          return forks
-        elsif flags =~ /(-s|--stats)/
-          # parse instances of event counter statistics
-          return event_counter_statistics(flags)
-        elsif flags =~ /(-V|--version)/
-          # parse instances of version
-          return version
-        else
-          # parse instances of the typical, average things
-          return average(flags)
-        end
+      if RUBY_PLATFORM =~ /darwin/i
+        return parse_macos
+      elsif RUBY_PLATFORM =~ /linux/i
+        return parse_linux(flags) 
+      elsif RUBY_PLATFORM =~ /win32|win64|\.NET|windows|cygwin|mingw32/i
+        raise Vmstator::VmstatError.new("This platform is not supported. Yet!?")
+      else
+        raise Vmstator::VmstatError.new("Unable to parse vmstat on this platform!")
+      end
+    end
+
+    def parse_linux(flags=false)
+      if flags =~ /(-d|--disk)/
+        # parse instances of disk_statistics
+        return disk_statistics(flags)
+      elsif flags =~ /(-D|--disk-sum)/
+        # parse instances of disk summary
+        return disk_summary(flags)
+      elsif flags =~ /(-a|--active)/
+        # parse instances of active memory
+        return active(flags)
+      elsif flags =~ /(-m|--slabs)/
+        # parse instances of slab info
+        return slab_info(flags)
+      elsif flags =~ /(-f|--forks)/
+        # parse instances of forks
+        return forks
+      elsif flags =~ /(-s|--stats)/
+        # parse instances of event counter statistics
+        return event_counter_statistics(flags)
+      elsif flags =~ /(-V|--version)/
+        # parse instances of version
+        return version
       else
-        return average
+         flags ? average(flags) : average
+      end
+    end
+
+    def parse_macos
+      output = `vm_stat`.split("\n")
+      output.shift
+      data = {}
+      output.each do |line|
+        key, value = line.split(':').map(&:strip)  
+        key        = key.downcase.gsub(" ", "_").gsub("-", "_").gsub('"', '').to_sym
+        data[key]  = value.to_i
       end
+      Vmstator::MacOSPages.new(data)
     end
 
     def version
@@ -94,7 +112,7 @@ module Vmstator
       flags  = "-D" unless flags
       output = `vmstat #{flags}` 
       values = output.split(/[A-z]/).compact.join.split("\n").map(&:strip).map(&:to_i)
-      keys   = output.split(/\d/).compact.join.split("\n").map(&:strip) 
+      kecys   = output.split(/\d/).compact.join.split("\n").map(&:strip) 
       keys   = keys.map(&:downcase).map {|s| s.gsub(" ", "_")}.map(&:to_sym)
       data   = Hash[keys.zip values]
       Vmstator::DiskSummary.new(data)
@@ -129,7 +147,7 @@ module Vmstator
 
     # slab_info() will run the -m flag and return that data
     def slab_info(flags=false)
-      raise VmstatError("This must be run with root privileges!") unless Process.uid == 0
+      raise Vmstator::VmstatError.new("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|

data/lib/vmstator/macos/pages.rb

@@ -0,0 +1,58 @@
+module Vmstator
+
+  class MacOSPages < Stats
+    attr_reader :free                   # total number of free pages in the system
+    attr_reader :active                 # total number of pages currently in use and pageable
+    attr_reader :inactive               # total number of pages on the inactive list
+    attr_reader :speculative            # total number of pages on the speculative list
+    attr_reader :throttled              # total number of pages on the throttled list (not wired but not pageable)
+    attr_reader :wired_down             # total number of pages wired down. that is, pages that cannot be paged out
+    attr_reader :purgeable              # total number of purgeable pages
+    attr_reader :translation_faults     # number of times the "vm_fault" routine has been called
+    attr_reader :copy_on_write          # number of faults that caused a page to be copied (generally caused by copy-on-write faults)
+    attr_reader :zero_filled            # total number of pages that have been zero-filled on demand
+    attr_reader :reactivated            # total number of pages that have been moved from the inactive list to the active list (reactivated)
+    attr_reader :purged                 # total number of pages that have been purged 
+    attr_reader :file_backed            # total number of pages that are file-backed (non-swap)
+    attr_reader :anonymous              # total number of pages that are anonymous
+    attr_reader :stored_in_compressor   # total number of pages (uncompressed) held within the compressor
+    attr_reader :occupied_by_compressor # number of pages used to store compressed VM pages 
+    attr_reader :decompressions         # total number of pages that have been decompressed by the VM compressor
+    attr_reader :compressions           # total number of pages that have been compressed by the VM compressor
+    attr_reader :ins                    # total number of requests for pages from a pager (such as the inode pager)
+    attr_reader :outs                   # total number of pages that have been paged out
+    attr_reader :swapins                # total number of compressed pages that have been swapped out to disk
+    attr_reader :swapouts               # total number of compressed pages that have been swapped back in from disk
+
+    def update(data)
+      if data
+        @free                   =  data[:pages_free]                   
+        @active                 =  data[:pages_active]                
+        @inactive               =  data[:pages_inactive]              
+        @speculative            =  data[:pages_speculative]           
+        @throttled              =  data[:pages_throttled]          
+        @wired_down             =  data[:pages_wired_down]            
+        @purgeable              =  data[:pages_purgeable]           
+        @translation_faults     =  data[:translation_faults]          
+        @copy_on_write          =  data[:pages_copy_on_write]         
+        @zero_filled            =  data[:pages_zero_filled]        
+        @reactivated            =  data[:pages_reactivated]          
+        @purged                 =  data[:pages_purged]          
+        @file_backed            =  data[:file_backed_pages]           
+        @anonymous              =  data[:anonymous_pages]          
+        @stored_in_compressor   =  data[:pages_stored_in_compressor] 
+        @occupied_by_compressor =  data[:pages_occupied_by_compressor]
+        @decompressions         =  data[:decompressions]
+        @compressions           =  data[:compressions]             
+        @ins                    =  data[:pageins]               
+        @outs                   =  data[:pageouts]                    
+        @swapins                =  data[:swapins]                   
+        @swapouts               =  data[:swapouts]                    
+      else
+        return false
+      end
+      true
+    end
+
+  end
+end

data/lib/vmstator/version.rb

@@ -1,3 +1,3 @@
 module Vmstator
-  VERSION = "2.0.4"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vmstator
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Kent 'picat' Gruber
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,18 +70,21 @@ files:
 - bin/console
 - bin/setup
 - examples/basic_example.rb
+- examples/linux_example.rb
+- examples/macOS_example.rb
 - lib/vmstator.rb
-- lib/vmstator/active.rb
-- lib/vmstator/average.rb
-- lib/vmstator/cache.rb
-- lib/vmstator/disk.rb
-- lib/vmstator/disk_statistics.rb
-- lib/vmstator/disk_summary.rb
 - lib/vmstator/errors.rb
-- lib/vmstator/event_counter_statistics.rb
-- lib/vmstator/memory.rb
-- lib/vmstator/parser.rb
-- lib/vmstator/slab_info.rb
+- lib/vmstator/linux/active.rb
+- lib/vmstator/linux/average.rb
+- lib/vmstator/linux/cache.rb
+- lib/vmstator/linux/disk.rb
+- lib/vmstator/linux/disk_statistics.rb
+- lib/vmstator/linux/disk_summary.rb
+- lib/vmstator/linux/event_counter_statistics.rb
+- lib/vmstator/linux/memory.rb
+- lib/vmstator/linux/parser.rb
+- lib/vmstator/linux/slab_info.rb
+- lib/vmstator/macos/pages.rb
 - lib/vmstator/stats.rb
 - lib/vmstator/version.rb
 - pkg/vmstator-0.1.0.gem
@@ -91,6 +94,8 @@ files:
 - pkg/vmstator-2.0.1.gem
 - pkg/vmstator-2.0.2.gem
 - pkg/vmstator-2.0.3.gem
+- pkg/vmstator-2.0.4.gem
+- pkg/vmstator-2.1.0.gem
 - vmstator.gemspec
 homepage: https://github.com/picatz/Vmstator
 licenses: