vmstator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d945feb142744013ddd6b191caebe82e19e599e6
+  data.tar.gz: eaf212ddbdfa8023e51f0f40a50983fbea83c103
+SHA512:
+  metadata.gz: 87c6801d7ac51d7d273eaf1ce30be069451bd0e0a30c360d4d4bafdb6724c790ee624dd5f78b4f3dd3688cf09ca894f3017f8efbe832d03cca1c78418333d54f
+  data.tar.gz: 93c819c1d3a4660dbb7bf0d5699a9239db6c542c3eb010f93fec2fa2dc41aacc1439953c443938bac839b13d91ba9336b5443fa08c2b130ea62c6c73cb30cd14

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kgruber1@emich.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vmstator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    vmstator (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vmstator!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kent Gruber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Vmstator
+
+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.
+
+#### Note
+
+This gem is still in development, but has more or less working code! :)
+
+![screenshot](http://i.imgur.com/XUrUBV8.png "Screen Shot")
+
+## Installation
+
+### Gemfile
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vmstator'
+```
+
+And then execute:
+
+    $ bundle
+
+### Gem Install
+
+Or install it yourself as:
+
+    $ gem install vmstator
+
+## Usage
+
+Still working on this bit, but, for the mean time...
+
+### Typical Use
+
+```ruby
+require 'vmstator'
+
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vmstator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/basic_example.rb

@@ -0,0 +1,6 @@
+# Path setting slight of hand:
+$: << File.expand_path("../../lib", __FILE__)
+require 'vmstator'
+require 'pry'
+
+binding.pry

data/lib/vmstator/errors.rb

@@ -0,0 +1,18 @@
+module Vmstator
+
+  # VmstatError handles the custom error handling for this Gem
+  #
+  # == Example
+  #
+  #  # Typical use case
+  #  raise VmstatError("This is a custom error!")
+  #
+  class VmstatError < StandardError
+    attr_reader :problem
+    def initialize(problem="Vmstat eems to have encountered a problem.")
+      @problem = problem
+      super(@problem)
+    end
+  end
+
+end

data/lib/vmstator/version.rb

@@ -0,0 +1,3 @@
+module Vmstator
+  VERSION = "1.0.0"
+end

data/lib/vmstator.rb

@@ -0,0 +1,193 @@
+require "vmstator/errors"
+require "vmstator/version"
+
+module Vmstator
+
+  # The Stats class does most of the work for this gem
+  # by providing an interface to parse vmstat, process
+  # flags for the vmstat command, and a way to access the
+  # result of that data.
+  class Stats
+    # Comand-line Flags
+    attr_accessor :flags
+    # Output of command and all parsed data
+    attr_reader :output, :data
+    # Parsed Data
+    attr_reader :r,    :runnable     # number of runnable processes
+    attr_reader :b,    :uninter      # number of processes in uninterruptible sleep
+    attr_reader :swpd, :used         # amount of virtual memory used
+    attr_reader :free, :free         # amount of idle memory
+    attr_reader :buff, :buffer       # amount of memory used as buffers
+    attr_reader :c,    :cache        # amount of memory used as cache
+    attr_reader :si,   :swapped_in   # amount of memory swapped in from disk (/s)
+    attr_reader :so,   :swapped_to   # amount memory swapped to disk (/s)
+    attr_reader :bi,   :blocs_recv   # blocks received from a block device (blocks/s)
+    attr_reader :bo,   :blocks_sent  # blocks sent to a block device (blocks/s)
+    attr_reader :in,   :interrupts   # number of interrupts (/s)
+    attr_reader :cs,   :cntxt_swtchs # number of context switches (/s)
+    attr_reader :us,   :non_kernel   # time spent running non-kernel code
+    attr_reader :sy,   :kernel       # time spent running kernel code
+    attr_reader :id,   :idle_time    # time spent idle
+    attr_reader :wa,   :waiting      # time spent waiting for IO
+    attr_reader :st,   :stolen       # time stolen from a virtual machine
+
+    # initialize() handles the initialization of a new
+    # Vmstator::Stats object which takes in an optional
+    # set of arguments that can be passed in as a hash.
+    #
+    # == Example
+    #
+    #  # Typical use case:
+    #  vmstats = Vmstator::Stats.new(:flags => "-S m", :parse => true )
+    #  # => true
+    #
+    def initialize(args=false)
+      unless vmstat_exists?
+        Vmstator::VmstatError.new("Vmstat was not found on this system!")
+      end
+      if args
+        process_flags(args[:flags]) if args[:flags]
+        parse if args[:parse]
+      end
+      true
+    end
+
+    # dry_run() runs the vmstat command with the available flags or
+    # will raise a custom Vmstator::VmstatError
+    def dry_run
+      unless system("vmstat #{@flags} > /dev/null 2>&1")
+        raise Vmstator::VmstatError.new("Vmstat ran into a problem with the flag(s): #{@flags}")
+      end
+    end
+
+    # forks() will run the -f flag and return that data.
+    def forks
+      `vmstat -f`.split.first
+    end
+    
+    # active() will parse the results of active
+    #  and inactive memory information.
+    def active
+      parse("-a") 
+    end
+
+    # version() will run the -V flag and return the version
+    # number from that information.
+    def vmstat_version
+      `vmstat -V`.split.last
+    end
+
+    # version() will run the -d flag and return the parsed
+    # informatio from that command.
+    def disk_info
+      @disk_info = {}
+      output = `vmstat -d`.split("\n")
+      # remove first two lines of the output
+      output.shift
+      output.shift
+      @disk_info[:disk_count] = output.count
+      output.each do |line|
+        disk, total, merged, sectors, ms, total, merged, sectors, ms, cur, sec = line.split
+        @disk_info[disk.to_sym] = { :totoal => total, :merged => merged, :sectors => sectors,
+                                    :ms => ms,        :cur => cur,        :sec => sec }
+      end
+      @disk_info
+    end 
+
+    # event_counter_statistics() will return the event
+    # count statistics in the form of a hash
+    def event_counter_statistics(flags=@flags)
+      output = `vmstat #{flags}`.split("\n")  
+      keys   = output.split(/\d/).compact.join.split("\n").map(&:strip)
+      values = output.split(/[A-z]/).compact.join.split("\n").map(&:strip)
+      Hash[keys.zip values]
+    end
+
+    # slab_info() will run the -m flag and return that data
+    def slab_info
+      # TODO : may go back, make this an option to use sudo or not.
+      # You need sudo permission to run this flag.
+      @slab_info = {}
+      `sudo vmstat -m`.split("\n").each do |info|
+        next if info == "Cache                       Num  Total   Size  Pages"
+        cache, num, total, size, pages = info.split
+        @slab_info[cache] = {}
+        @slab_info[cache][:num]   = num
+        @slab_info[cache][:total] = total
+        @slab_info[cache][:size]  = size
+        @slab_info[cache][:pages] = pages
+      end
+      @slab_info
+    end
+
+    # parse() is probably the main work horse of this class. It parses the
+    # the vmstat command after a dry run is done to check the command. It
+    # does quite few things: including parsing all of the vmstat information
+    # into a hash stored in @data; and will then store the relevant information
+    # into the appropriate attr_reader
+    #
+    # == Example
+    #
+    #  # Typical use case to parse a vmstat command.
+    #  vmstats = Vmstator::Stats.new(:flags => "-S m")
+    #  vmstats.parse
+    #  # => true
+    #
+    def parse(flags=@flags)
+      if flags =~ /(-d|--disk)/
+        return disk_statistics
+      elsif flags =~ /(-f|--forks)/
+        return forks
+      elsif flags =~ /(-s|--stats)/
+        return event_counter_statistics
+      end
+      dry_run
+      @output = `vmstat #{flags}`.split("\n")
+      labels  = @output[1]
+      stats   = @output[2]
+      @data = Hash[labels.split.map(&:to_sym).zip stats.split]
+      @swpd, @used         = @data[:swpd],  @data[:swpd]
+      @buff, @buffer       = @data[:buff],  @data[:buff]
+      @r,    @runnable     = @data[:r],     @data[:r]
+      @b,    @uninter      = @data[:b],     @data[:b]
+      @si,   @swapped_in   = @data[:si],    @data[:si]
+      @so,   @swapped_to   = @data[:so],    @data[:so]
+      @bi,   @blocs_recv   = @data[:bi],    @data[:bi]
+      @bo,   @blocks_sent  = @data[:bo],    @data[:bo]
+      @in,   @interrupts   = @data[:in],    @data[:in]
+      @cs,   @cntxt_swtchs = @data[:cs],    @data[:cs]
+      @us,   @non_kernel   = @data[:us],    @data[:us]
+      @sy,   @kernel       = @data[:sy],    @data[:sy]
+      @id,   @idle_time    = @data[:id],    @data[:id]
+      @wa,   @waiting      = @data[:wa],    @data[:wa]
+      @st,   @stolen       = @data[:st],    @data[:st]
+      @cache               = @data[:cache]
+      @free                = @data[:free]
+      true
+    end
+
+    private
+
+    # vmstat_exists?() checks if vmstat exists
+    # or not returning true or false for the command.
+    def vmstat_exists?
+      system("which vmstat > /dev/null 2>&1")
+    end
+
+    # process_flags() allows the flags argument that is passed
+    # in to be either an array or a string. That way the flags
+    # argument can be processed intuitively as either a string
+    # of flags or simple an array of those flags.
+    def process_flags(flags)
+      if flags.is_a? String
+        @flags = flags
+      elsif flags.is_a? Array
+        @flags = flags.join(" ")
+      else
+        false
+      end
+    end
+
+  end
+
+end

data/vmstator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vmstator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vmstator"
+  spec.version       = Vmstator::VERSION
+  spec.authors       = ["Kent 'picat' Gruber"]
+  spec.email         = ["kgruber1@emich.edu"]
+
+  spec.summary       = %q{Vmstator is a Ruby API for vmstat to monitor virtual memory statistics.}
+  spec.description   = %q{Vmstator is a Ruby API for vmstat to monitor virtual memory statistics. It provides an OO interface to be able to parse the contents of the output of vmstat and access that infromation intuitively.}
+  spec.homepage      = "https://github.com/picatz/Vmstator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: vmstator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kent 'picat' Gruber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Vmstator is a Ruby API for vmstat to monitor virtual memory statistics.
+  It provides an OO interface to be able to parse the contents of the output of vmstat
+  and access that infromation intuitively.
+email:
+- kgruber1@emich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/basic_example.rb
+- lib/vmstator.rb
+- lib/vmstator/errors.rb
+- lib/vmstator/version.rb
+- pkg/vmstator-0.1.0.gem
+- pkg/vmstator-1.0.0.gem
+- vmstator.gemspec
+homepage: https://github.com/picatz/Vmstator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Vmstator is a Ruby API for vmstat to monitor virtual memory statistics.
+test_files: []