vmstat 1.0.0 → 1.1.0

data/lib/vmstat/linux_disk.rb

@@ -0,0 +1,33 @@
+module Vmstat
+  # Since on linux the type and mount information are note available in the
+  # statfs library, we have to use constants to find out the file system type.
+  # The mount point and the path will allways be the same, because we don't have
+  # the mount information. But one can still either use the device or mountpoint
+  # to get the information.
+  class LinuxDisk < Disk
+    # Mapping of file system type codes to file system names.
+    FS_CODES = {
+      44533=>:adfs, 44543=>:affs, 1111905073=>:befs, 464386766=>:bfs,
+      4283649346=>:cifs_number, 1937076805=>:coda, 19920823=>:coh,
+      684539205=>:cramfs, 4979=>:devfs, 4278867=>:efs, 4989=>:ext,
+      61265=>:ext2_old, 61267=>:ext4, 16964=>:hfs, 4187351113=>:hpfs,
+      2508478710=>:hugetlbfs, 38496=>:isofs, 29366=>:jffs2,
+      827541066=>:jfs, 4991=>:minix, 9320=>:minix2, 9336=>:minix22,
+      19780=>:msdos, 22092=>:ncp, 26985=>:nfs, 1397118030=>:ntfs_sb,
+      40865=>:openprom, 40864=>:proc, 47=>:qnx4, 1382369651=>:reiserfs,
+      29301=>:romfs, 20859=>:smb, 19920822=>:sysv2, 19920821=>:sysv4,
+      16914836=>:tmpfs, 352400198=>:udf, 72020=>:ufs, 7377 => :devpts,
+      40866=>:usbdevice, 2768370933=>:vxfs, 19920820=>:xenix, 1481003842=>:xfs,
+      19911021=>:xiafs, 1448756819=>:reiserfs, 1650812274 => :sysfs
+    }.freeze
+
+    # Mainly a wrapper for the {Vmstat::Disk} class constructor. This constructor
+    # handles the file system type mapping.
+    def initialize(fs = nil, path = nil, block_size = nil, 
+                   free_blocks = nil, available_blocks = nil, total_blocks = nil)
+      @fs = fs
+      super FS_CODES[@fs], path, path, block_size, 
+            free_blocks, available_blocks, total_blocks
+    end
+  end
+end

data/lib/vmstat/procfs.rb

@@ -0,0 +1,126 @@
+module Vmstat
+  module ProcFS
+    # Grep from the man procfs about cpu data in stat file:
+    # @example Format
+    #     (num) user nice system idle iowait irq softirq steal
+    # @example manpage
+    #     iowait - time waiting for I/O to complete (since 2.5.41)  
+    #     irq - time servicing interrupts (since 2.6.0-test4)
+    #     softirq - time servicing softirqs (since 2.6.0-test4)
+    #     Since Linux 2.6.11:
+    #     steal - stolen time, which is the time spent in other operating 
+    #             systems when running in a virtualized environment
+    #     Since Linux 2.6.24:
+    #     guest - which is the time spent running a virtual CPU for guest
+    #             operating systems under the control of the Linux kernel.
+    CPU_DATA = /cpu(\d)#{'\s+(\d+)' * 4}/.freeze
+
+    # Grep the network stats from the procfs.
+    # @example Format (from /proc/net/dev)
+    #   Inter-|   Receive                                                |  Transmit
+    #    face |bytes    packets errs drop fifo frame compressed multicast|bytes    packets errs drop fifo colls carrier compressed
+    # @example Data
+    #   eth0:   33660     227    0    0    0     0          0         0    36584     167    0    0    0     0       0          0
+    NET_DATA = /(\w+):#{'\s*(\d+)' * 16}/
+
+    # Fetches the cpu statistics (usage counter for user, nice, system and idle)
+    # @return [Array<Vmstat::Cpu>] the array of cpu counter
+    # @example
+    #   Vmstat.cpu # => [#<struct Vmstat::Cpu ...>, #<struct Vmstat::Cpu ...>]
+    def cpu
+      cpus = []
+      procfs_file("stat") do |file|
+        file.read.scan(CPU_DATA) do |i, user, nice, system, idle|
+          cpus << Cpu.new(i.to_i, user.to_i, system.to_i, nice.to_i, idle.to_i)
+        end
+      end
+      cpus
+    end
+
+    # Fetches the memory usage information.
+    # @return [Vmstat::Memory] the memory data like free, used und total.
+    # @example
+    #   Vmstat.memory # => #<struct Vmstat::Memory ...>
+    def memory
+      @pagesize ||= Vmstat.pagesize
+
+      total = free = active = inactive = pageins = pageouts = 0
+      procfs_file("meminfo") do |file|
+        content = file.read(2048) # the requested information is in the first bytes
+
+        content.scan(/(\w+):\s+(\d+) kB/) do |name, kbytes| 
+          pages = (kbytes.to_i * 1024) / @pagesize
+
+          case name
+            when "MemTotal" then total = pages
+            when "MemFree" then free = pages
+            when "Active" then active = pages
+            when "Inactive" then inactive = pages
+          end
+        end
+      end
+
+      procfs_file("vmstat") do |file|
+        content = file.read
+
+        if content =~ /pgpgin\s+(\d+)/
+          pageins = $1.to_i
+        end
+
+        if content =~ /pgpgout\s+(\d+)/
+          pageouts = $1.to_i
+        end
+      end
+
+      Memory.new @pagesize, total-free-active-inactive, active, inactive, free,
+                 pageins, pageouts
+    end
+
+    # Fetches the information for all available network devices.
+    # @return [Array<Vmstat::NetworkInterface>] the network device information
+    # @example
+    #   Vmstat.network_interfaces # => [#<struct Vmstat::NetworkInterface ...>, ...]
+    def network_interfaces
+      netifcs = []
+      procfs_file("net", "dev") do |file|
+        file.read.scan(NET_DATA) do |columns|
+          netifcs << NetworkInterface.new(columns[0].to_sym, columns[1].to_i, 
+                                          columns[3].to_i,   columns[4].to_i, 
+                                          columns[9].to_i,   columns[11].to_i)
+        end
+      end
+      netifcs
+    end
+
+    # Fetches the boot time of the system.
+    # @return [Time] the boot time as regular time object.
+    # @example
+    #   Vmstat.boot_time # => 2012-10-09 18:42:37 +0200
+    def boot_time
+      raw = procfs_file("uptime") { |file| file.read }
+      Time.now - raw.split(/\s/).first.to_f
+    end
+
+    # @return [String] the path to the proc file system
+    # @example
+    #   procfs_path # => "/proc"
+    # @api private
+    def procfs_path
+      "/proc".freeze
+    end
+
+    # Opens a proc file system file handle and returns the handle in the
+    # passed block. Closes the file handle.
+    # @see File#open
+    # @param [Array<String>] names parts of the path to the procfs file
+    # @example
+    #   procfs_file("net", "dev") { |file| }
+    #   procfs_file("stat") { |file| }
+    # @yieldparam [IO] file the file handle
+    # @api private
+    def procfs_file(*names, &block)
+      path = File.join(procfs_path, *names)
+      File.open(path, "r", &block)
+    end
+  end
+end

data/lib/vmstat/snapshot.rb

@@ -11,7 +11,7 @@ module Vmstat
       @load_average = Vmstat.load_average
       @memory = Vmstat.memory
       @network_interfaces = Vmstat.network_interfaces
-      @task = Vmstat.task
+      @task = Vmstat.task if Vmstat.respond_to? :task
     end
   end
 end

data/lib/vmstat/stub.rb

@@ -0,0 +1,69 @@
+module Vmstat
+  module Stub
+    # Fetches the boot time of the system.
+    # @return [Time] the boot time as regular time object.
+    # @example
+    #   Vmstat.boot_time # => 2012-10-09 18:42:37 +0200
+    def self.boot_time
+      nil
+    end
+
+    # Fetches the cpu statistics (usage counter for user, nice, system and idle)
+    # @return [Array<Vmstat::Cpu>] the array of cpu counter
+    # @example
+    #   Vmstat.cpu # => [#<struct Vmstat::Cpu ...>, #<struct Vmstat::Cpu ...>]
+    def self.cpu
+      []
+    end
+
+    # Fetches the usage data and other useful disk information for the given path.
+    # @param [String] path the path (mount point or device path) to the disk
+    # @return [Vmstat::Disk] the disk information
+    # @example
+    #   Vmstat.disk("/") # => #<struct Vmstat::Disk type=:hfs, ...>
+    def self.disk(path)
+      nil
+    end
+
+    # Fetches the load average for the current system.
+    # @return [Vmstat::LoadAverage] the load average data
+    # @example
+    #   Vmstat.load_average # => #<struct Vmstat::LoadAverage one_minute=...>
+    def self.load_average
+      nil
+    end
+
+    # Fetches the memory usage information.
+    # @return [Vmstat::Memory] the memory data like free, used und total.
+    # @example
+    #   Vmstat.memory # => #<struct Vmstat::Memory ...>
+    def self.memory
+      nil
+    end
+
+    # Fetches the information for all available network devices.
+    # @return [Array<Vmstat::NetworkInterface>] the network device information
+    # @example
+    #   Vmstat.network_interfaces # => [#<struct Vmstat::NetworkInterface ...>, ...]
+    def self.network_interfaces
+      []
+    end
+
+    # Fetches pagesize of the current system.
+    # @return [Fixnum] the pagesize of the current system in bytes.
+    # @example
+    #   Vmstat.pagesize # => 4096
+    def self.pagesize
+      4096
+    end
+
+    # Fetches time and memory usage for the current process.
+    # @note Currently only on Mac OS X
+    # @return [Array<Vmstat::Task>] the network device information
+    # @example
+    #   Vmstat.task # => #<struct Vmstat::Task ...>
+    def self.task
+      nil
+    end
+  end
+end

data/lib/vmstat/version.rb

@@ -1,3 +1,3 @@
 module Vmstat
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/procfs/loadavg

@@ -0,0 +1 @@
+0.24 0.32 0.21 1/79 2621

data/spec/procfs/meminfo

@@ -0,0 +1,46 @@
+MemTotal:         507344 kB
+MemFree:          428068 kB
+Buffers:           13104 kB
+Cached:            40296 kB
+SwapCached:            0 kB
+Active:            26032 kB
+Inactive:          33620 kB
+Active(anon):       6276 kB
+Inactive(anon):      240 kB
+Active(file):      19756 kB
+Inactive(file):    33380 kB
+Unevictable:           0 kB
+Mlocked:               0 kB
+HighTotal:             0 kB
+HighFree:              0 kB
+LowTotal:         507344 kB
+LowFree:          428068 kB
+SwapTotal:        521212 kB
+SwapFree:         521212 kB
+Dirty:                 8 kB
+Writeback:             0 kB
+AnonPages:          6240 kB
+Mapped:             5844 kB
+Shmem:               268 kB
+Slab:              14012 kB
+SReclaimable:       6476 kB
+SUnreclaim:         7536 kB
+KernelStack:         688 kB
+PageTables:          468 kB
+NFS_Unstable:          0 kB
+Bounce:                0 kB
+WritebackTmp:          0 kB
+CommitLimit:      774884 kB
+Committed_AS:      48400 kB
+VmallocTotal:     512056 kB
+VmallocUsed:        2228 kB
+VmallocChunk:     509236 kB
+HardwareCorrupted:     0 kB
+AnonHugePages:         0 kB
+HugePages_Total:       0
+HugePages_Free:        0
+HugePages_Rsvd:        0
+HugePages_Surp:        0
+Hugepagesize:       2048 kB
+DirectMap4k:       34752 kB
+DirectMap2M:      489472 kB

data/spec/procfs/net/dev

@@ -0,0 +1,5 @@
+Inter-|   Receive                                                |  Transmit
+ face |bytes    packets errs drop fifo frame compressed multicast|bytes    packets errs drop fifo colls carrier compressed
+    lo:    3224      40    0    0    0     0          0         0     3224      40    0    0    0     0       0          0
+  eth1:       0       0    1    2    0     0          0         0        0       0    3    4    0     0       0          0
+  eth0:   33660     227    0    0    0     0          0         0    36584     167    0    0    0     0       0          0

data/spec/procfs/stat

@@ -0,0 +1,12 @@
+cpu  1312 0 3760 108331 788 0 169 0 0 0
+cpu0 311 0 966 26788 520 0 109 0 0 0
+cpu1 351 0 862 27263 162 0 15 0 0 0
+cpu2 324 0 1092 26698 74 0 32 0 0 0
+cpu3 326 0 838 27581 31 0 12 0 0 0
+intr 39520 61 9 0 0 0 0 0 0 0 0 0 0 133 0 0 352 0 0 0 394 0 1864 25 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
+ctxt 29527
+btime 1349885697
+processes 1560
+procs_running 1
+procs_blocked 0
+softirq 52656 0 26117 54 429 2037 0 3 6623 75 17318

data/spec/procfs/uptime

@@ -0,0 +1 @@
+355.63 1302.86

data/spec/procfs/vmstat

@@ -0,0 +1,89 @@
+nr_free_pages 107062
+nr_inactive_anon 60
+nr_active_anon 1557
+nr_inactive_file 8341
+nr_active_file 4939
+nr_unevictable 0
+nr_mlock 0
+nr_anon_pages 1579
+nr_mapped 1461
+nr_file_pages 13346
+nr_dirty 1
+nr_writeback 0
+nr_slab_reclaimable 1628
+nr_slab_unreclaimable 1885
+nr_page_table_pages 101
+nr_kernel_stack 88
+nr_unstable 0
+nr_bounce 0
+nr_vmscan_write 0
+nr_vmscan_immediate_reclaim 0
+nr_writeback_temp 0
+nr_isolated_anon 0
+nr_isolated_file 0
+nr_shmem 67
+nr_dirtied 185
+nr_written 182
+nr_anon_transparent_hugepages 0
+nr_dirty_threshold 24392
+nr_dirty_background_threshold 12196
+pgpgin 64599
+pgpgout 1104
+pswpin 0
+pswpout 0
+pgalloc_dma 2
+pgalloc_normal 190973
+pgalloc_high 0
+pgalloc_movable 0
+pgfree 298439
+pgactivate 5802
+pgdeactivate 0
+pgfault 581461
+pgmajfault 42
+pgrefill_dma 0
+pgrefill_normal 0
+pgrefill_high 0
+pgrefill_movable 0
+pgsteal_dma 0
+pgsteal_normal 0
+pgsteal_high 0
+pgsteal_movable 0
+pgscan_kswapd_dma 0
+pgscan_kswapd_normal 0
+pgscan_kswapd_high 0
+pgscan_kswapd_movable 0
+pgscan_direct_dma 0
+pgscan_direct_normal 0
+pgscan_direct_high 0
+pgscan_direct_movable 0
+pginodesteal 0
+slabs_scanned 0
+kswapd_steal 0
+kswapd_inodesteal 0
+kswapd_low_wmark_hit_quickly 0
+kswapd_high_wmark_hit_quickly 0
+kswapd_skip_congestion_wait 0
+pageoutrun 1
+allocstall 0
+pgrotated 0
+compact_blocks_moved 0
+compact_pages_moved 0
+compact_pagemigrate_failed 0
+compact_stall 0
+compact_fail 0
+compact_success 0
+htlb_buddy_alloc_success 0
+htlb_buddy_alloc_fail 0
+unevictable_pgs_culled 0
+unevictable_pgs_scanned 0
+unevictable_pgs_rescued 0
+unevictable_pgs_mlocked 0
+unevictable_pgs_munlocked 0
+unevictable_pgs_cleared 0
+unevictable_pgs_stranded 0
+unevictable_pgs_mlockfreed 0
+thp_fault_alloc 0
+thp_fault_fallback 0
+thp_collapse_alloc 0
+thp_collapse_alloc_failed 0
+thp_split 0

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@
 $:.unshift(File.expand_path("../lib", __FILE__))
 require 'vmstat'
 require 'ostruct'
+require 'timecop'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

data/spec/vmstat/procfs_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Vmstat::ProcFS do
+  let(:procfs) do
+    Class.new do
+      extend Vmstat::ProcFS
+
+      def self.procfs_path
+        File.expand_path("../../procfs", __FILE__)
+      end
+    end
+  end
+  subject { procfs }
+
+  context "#cpu" do
+    subject { procfs.cpu }
+
+    it { should be_a(Array)}
+    it do 
+      should == [
+        Vmstat::Cpu.new(0, 311, 966, 0, 26788),
+        Vmstat::Cpu.new(1, 351, 862, 0, 27263),
+        Vmstat::Cpu.new(2, 324, 1092, 0, 26698),
+        Vmstat::Cpu.new(3, 326, 838, 0, 27581)
+      ]
+    end
+  end
+
+  context "#memory" do
+    subject { procfs.memory }
+    
+    it { should be_a(Vmstat::Memory) }
+    it do
+      should == Vmstat::Memory.new(4096, 4906, 6508, 8405, 107017, 64599, 1104)
+    end
+
+    it "should have the right total" do
+      (subject.wired_bytes + subject.active_bytes + 
+       subject.inactive_bytes + subject.free_bytes).should == 507344 * 1024
+    end
+  end
+
+  context "#boot_time" do
+    subject { procfs.boot_time }
+
+    it { should be_a(Time) }
+    it { Timecop.freeze(Time.now) { should == Time.now - 355.63 } }
+  end
+
+  context "#network_interfaces" do
+    subject { procfs.network_interfaces }
+
+    it { should be_a(Array) }
+    it do
+      should == [
+        Vmstat::NetworkInterface.new(:lo, 3224, 0, 0, 3224, 0),
+        Vmstat::NetworkInterface.new(:eth1, 0, 1, 2, 0, 3),
+        Vmstat::NetworkInterface.new(:eth0, 33660, 0, 0, 36584, 0)
+      ]
+    end
+  end
+end