systemstats 0.1.dev

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.ds_store
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dave Golombek
+
+MIT License
+
+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,4 @@
+SystemStats
+===========
+
+Gem used to retrieve performance statistics from a machine.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => [:spec]
+task :default => :test

data/lib/systemstats/iostat_reader.rb

@@ -0,0 +1,87 @@
+# -*- encoding : utf-8 -*-
+module SystemStats
+
+  class IoStatReader
+
+    IOSTAT_CMD_OSX    = 'iostat -dC disk'
+    IOSTAT_CMD_LINUX  = 'iostat -x'
+
+    private
+      # Gets system statistics from iostats and parses the output
+      def read_iostats(disk)
+        if OS::linux?
+          process_iostat_linux(disk)
+        elsif OS::mac?
+          process_iostat_mac(disk)
+        else
+         raise 'Unsupported operating system'
+        end
+      end
+
+      # Parse disk/cpu counters from iostat on osx.
+      def process_iostat_mac(disk_id = 0)
+        output = IO.popen(IOSTAT_CMD_OSX + disk_id.to_s)
+        data = output.readlines
+        values = Hash.new
+        begin
+          values[:cpu] =  data[2].split[3,3]
+          values[:disk] = data[2].split[0,3]
+        rescue => parse_error
+          raise 'Error parsing IoStats output.'
+        end
+        values
+      end
+
+      # Parse disk/cpu counters from iostat on linux.
+      def process_iostat_linux(disk_id = 'sda1')
+        output = IO.popen(IOSTAT_CMD_LINUX + disk_id.to_s)
+        data = output.readlines
+        values = Hash.new
+        begin
+          values[:cpu]  = [data[3].split[0] , data[3].split[2], data[3].split[5]]
+          values[:disk] = data[2].split[0,3]
+        rescue => parse_error
+          raise 'Error parsing IoStats output.'
+        end
+        values
+      end
+
+    public
+
+      # Returns the User Cpu average percentage
+      def cpu_user_average
+         read_iostats(0)[:cpu][0]
+      end
+
+      # Returns the system Cpu average use percentage
+      def cpu_system_average
+        read_iostats(0)[:cpu][1]
+      end
+
+      # Returns the user Cpu average idle time percentage
+      def cpu_idle_average
+        read_iostats(0)[:cpu][2]
+      end
+
+      # Returns the user's Kilobytes per transfer
+      # Disk id is the numeric ID in osx, disk type in linux
+      # OSX: disk0 => '0', Linux => disk 0 => 'sda'
+      def disk_kb_per_transfer(disk_id)
+        read_iostats(disk_id)[:disk][0]
+      end
+
+      # Returns the number of current transfers per second for a disk
+      # Disk id is the numeric ID in osx, disk type in linux
+      # OSX: disk0 => '0', Linux => disk 0 => 'sda'
+      def disk_transfers_per_second(disk_id)
+        read_iostats(disk_id)[:disk][1]
+      end
+
+      # Returns the current  number of megabytes transfered on a disk per second
+      # Disk id is the numeric ID in osx, disk type in linux
+      # OSX: disk0 => '0', Linux => disk 0 => 'sda'
+      def disk_megabytes_per_second(disk_id)
+        read_iostats(disk_id)[:disk][2]
+      end
+  end
+end

data/lib/systemstats/os_detect.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+require 'rbconfig'
+
+module OS
+  class << self
+    # Detects the current OS running
+    def is?(what)
+      what === RbConfig::CONFIG['host_os']
+    end
+    alias is is?
+
+    def to_s
+      RbConfig::CONFIG['host_os']
+    end
+  end
+
+  module_function
+
+  # Returns true if operating system is Linux
+  def linux?
+    OS.is? /linux|cygwin/
+  end
+
+  # Returns true if Operating system is OsX
+  def mac?
+    OS.is?  /mac|darwin/
+  end
+
+end

data/lib/systemstats/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+module SystemStats
+    VERSION = "0.1.#{ENV['BUILD_NUMBER'] || 'dev'}"
+end

data/lib/systemstats.rb

@@ -0,0 +1,6 @@
+# -*- encoding : utf-8 -*-
+$LOAD_PATH << File.dirname(__FILE__)
+
+require 'systemstats/iostat_reader'
+require 'systemstats/os_detect'
+require 'systemstats/version'

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH << File.expand_path(File.join(*%w[ .. lib ]), File.dirname(__FILE__))
+require 'systemstats'
+
+def self.stub_all_syscalls
+  Dir.stub(:chdir)
+  Kernel.stub(:system)
+  bundler_helper.stub(:system)
+end
+
+def mock_next_io(str)
+  include RSpec::Mocks::ExampleMethods
+  io = mock('IO Connection').as_null_object
+  IO.stub!(:new).and_return(io)
+  IO.stub!(:popen).and_return(io)
+  io.stub!(:write){|b| b.size}
+  io.stub!(:readlines).and_return(str)
+  io.stub!(:flush).and_return(io)
+  io.stub!(:close).and_return(nil)
+  io.stub!(:pid).and_return(rand(300))
+end
+
+def unmock_io
+  io_proxy = IO.send(:__mock_proxy)
+  io_proxy.reset
+end

data/spec/unit/iostat_linux_spec.rb

@@ -0,0 +1,62 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe SystemStats::IoStatReader do
+
+  #pre-made response
+  let (:mock_iostat_output_linux) {[
+    "Linux 2.6.32-312-ec2 (domU-12-31-39-0A-70-82)   05/15/2013  _x86_64_  (2 CPU)",
+    "avg-cpu:  %user   %nice %system %iowait  %steal   %idle",
+    "0.41    0.00    0.44    0.01    0.32   98.82",
+    "Device:         rrqm/s   wrqm/s     r/s     w/s   rsec/s   wsec/s avgrq-sz avgqu-sz   await  svctm  %util",
+    "sda1              0.00     0.33    0.00    0.19     0.01     4.13    22.02     0.01   28.66   0.75   0.01",
+    "sdb               0.00     0.00    0.00    0.00     0.00     0.00    10.35     0.00    3.51   3.50   0.00"]}
+
+  let(:stats) do
+    stats = SystemStats::IoStatReader.new
+  end
+
+  before(:each) do
+    mock_next_io(mock_iostat_output_linux)
+  end
+
+  after(:each) do
+    unmock_io
+  end
+
+  it "creates a new instance" do
+    stats.stub(:readlines).and_return(mock_iostat_output_linux)
+  end
+
+  it "should return the average cpu_user_average for the current cpu" do
+    stats.cpu_user_average.should == '0.01'
+  end
+
+  it "should return the average cpu_system_average for the current cpu" do
+    stats.cpu_system_average.should == '0.32'
+  end
+
+  it "should return the average cpu_user_average for the current cpu" do
+    stats.cpu_idle_average.should == '98.82'
+  end
+
+  it "should return the megabytes per second for disk 0" do
+    stats.disk_megabytes_per_second(0).should == '0.44'
+  end
+
+  it "should fail on a non existent disk" do
+    stats.disk_megabytes_per_second(100).should_not == '0.27'
+  end
+
+  it "should fail on a random string as disk" do
+    stats.disk_megabytes_per_second('randomdisk').should raise_error
+  end
+
+  it "should return the transfer per second for disk 0" do
+    stats.disk_transfers_per_second(0) == '12'
+  end
+
+  it "should return the transfer per second for disk 0" do
+    stats.disk_kb_per_transfer(0) == '23.41'
+  end
+end

data/spec/unit/iostat_osx_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe SystemStats::IoStatReader do
+
+  describe 'Osx Iostats' do
+
+    #pre-made response
+    let (:mock_iostat_output_osx) {
+      ["disk0       cpu     load average",
+      "KB/t tps  MB/s  us sy id   1m   5m   15m",
+      "23.41  12  0.27   4  2 94  0.71 0.80 0.75"]}
+
+    let(:stats) do
+      stats = SystemStats::IoStatReader.new
+    end
+
+    before(:each) do
+      mock_next_io(mock_iostat_output_osx)
+    end
+
+    after(:each) do
+      unmock_io
+    end
+
+    it "should return the average cpu_user_average for the current cpu" do
+      stats.cpu_user_average.should == '4'
+    end
+
+    it "should return the average cpu_system_average for the current cpu" do
+      stats.cpu_system_average.should == '2'
+    end
+
+    it "should return the average cpu_user_average for the current cpu" do
+      stats.cpu_idle_average.should == '94'
+    end
+
+    it "creates a new instance" do
+      stats.stub(:readlines).and_return(mock_iostat_output_osx)
+    end
+
+    it "should return the megabytes per second for disk 0" do
+      stats.disk_megabytes_per_second(0).should == '0.27'
+    end
+
+    it "should fail on a random string as disk" do
+      stats.disk_megabytes_per_second('randomdisk').should raise_error
+    end
+
+    it "should return the transfer per second for disk 0" do
+      stats.disk_transfers_per_second(0) == '12'
+    end
+
+    it "should return the transfer per second for disk 0" do
+      stats.disk_kb_per_transfer(0) == '23.41'
+    end
+  end
+end

data/systemstats.gemspec

@@ -0,0 +1,28 @@
+  # -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'systemstats/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "systemstats"
+  gem.version       = SystemStats::VERSION
+  gem.authors       = ["Ivan Marcin"]
+  gem.email         = ["ivan.marcin@lookout.com"]
+  gem.description   = %q{Retrieves machine stats, including cpu,memory,disk,io}
+  gem.summary       = %q{Library to access a machine's performance stats}
+  gem.homepage      = "https://source.flexilis.local/gems/systemstats"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "json"
+  gem.add_dependency "git"
+  gem.add_dependency "activesupport"
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "ruby-debug"
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification 
+name: systemstats
+version: !ruby/object:Gem::Version 
+  hash: -2034994314
+  prerelease: 4
+  segments: 
+  - 0
+  - 1
+  - dev
+  version: 0.1.dev
+platform: ruby
+authors: 
+- Ivan Marcin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-05-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: git
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: Retrieves machine stats, including cpu,memory,disk,io
+email: 
+- ivan.marcin@lookout.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/systemstats.rb
+- lib/systemstats/iostat_reader.rb
+- lib/systemstats/os_detect.rb
+- lib/systemstats/version.rb
+- spec/spec_helper.rb
+- spec/unit/iostat_linux_spec.rb
+- spec/unit/iostat_osx_spec.rb
+- systemstats.gemspec
+homepage: https://source.flexilis.local/gems/systemstats
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Library to access a machine's performance stats
+test_files: 
+- spec/spec_helper.rb
+- spec/unit/iostat_linux_spec.rb
+- spec/unit/iostat_osx_spec.rb