dstat 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4cf88b13a58735fcc04844a1511ef91a6354cf1
+  data.tar.gz: a21026e28964163cb1feaf3a59fe18dc505d8d18
+SHA512:
+  metadata.gz: 65233a90ae1a866e91d011ca1d53c8ccd6b537cee84d70f519c1b49a27eb6ebb9b1e250ffe9426106fd3147ef8d22306def6c1b1cf0596c66b2a63dfac862858
+  data.tar.gz: b48f1e0d4339b6d7058dbd523a58ef2cdd33a843294c78470b63072c84d0461518d0932ed3aa59c918885af46feae0ca62237a005eada0b8ade4033e6f22e3bb

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryan Larson
+
+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,96 @@
+# dstat
+
+dstat is a ruby gem that provides utilites for working with dstat data
+
+Given a dstat csv file, this will import the data, columnwise, into a Hash.
+
+dstat CSV files are often of the form:
+
+```  
+top_level_header_1,top_level_header_2,,,
+child_header_1,child_header_2,child_header3,child_header4
+```  
+   
+or a more concrete example:
+
+```  
+epoch,memory usage,,,
+epoch,used,buff,cach,free
+1121245,12456,12856,20059,2999095
+1121246,12457,12855,20068,2996885
+```
+
+Where `used`, `buff`, `cache`, and `free` all correspond to memory usage. An index is created
+for each (parent header -> child header), unless parent header == child header.
+
+Using the concrete example above, the hash returned from this method would be indexed
+like so:
+
+```
+hash[:epoch] => [1121245, 1121246]
+hash[:memory_usage] => {:used => [12456, 12457], 
+                        :buff => [12856, 12855], 
+                        :cach => [20059, 20068], 
+                        :free => [2999095, 2996885]            
+                        }
+```
+
+Written another way:
+
+
+```
+puts hash[:memory_usage][:used]
+=> "[12456, 12457]"
+```
+
+The hash also has aliases for the keys, so you can access the values multiple ways:
+
+```
+puts hash[:memory_usage][:used]
+=> "[12456, 12457]"
+
+puts hash["memory_usage"]["used"]
+=> "[12456, 12457]"
+
+puts hash["memory_usage_used"]
+=> "[12456, 12457]"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dstat'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dstat
+
+## Usage
+
+Dstat is a module, and you can include it to mix in it's functionality.
+
+```
+require 'dstat'
+include Dstat
+```
+
+Once you do this, you have access to all of the Dstat methods. The most useful of which is:
+
+```
+import_dstat_csv(file)
+```
+
+You can pass this a File or a String representing a path to a file, and it will return a colmnwise hash of keys to values
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/dstat/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+# require "bundler/gem_tasks"
+
+require 'rubygems/tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+#This gives us build, install, and release
+Gem::Tasks.new(:console => false, :sign => false)

data/dstat.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dstat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dstat"
+  spec.version       = Dstat::VERSION
+  spec.authors       = ["Ryan Larson"]
+  spec.email         = ["rlarson@tripwire.com"]
+  spec.summary       = "Utilities for parsing dstat data from dstat csv files."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubygems-tasks"
+end

data/lib/dstat.rb

@@ -0,0 +1,105 @@
+require 'csv'
+
+module Dstat
+  def flatten_headers(csv)
+    headers = csv[0]
+    csv[0] = []
+
+    good = headers[0]
+    headers.each do |header| 
+      good = header unless header.nil?
+      csv[0] << good
+    end
+
+    csv[1] = csv[1].map do |child_header| 
+      parent_header = csv[0][csv[1].index(child_header)]
+      parent_header != child_header ? "#{parent_header} #{child_header}" : parent_header
+    end
+    csv[1..-1]
+  end
+
+  def normalize_top_level_header(csv)
+    headers = csv[0]
+    csv[0] = []
+
+    good = headers[0]
+    headers.each do |header| 
+      good = header unless header.nil?
+      csv[0] << good
+    end
+    csv
+  end
+
+  def parse_from_file(file)
+  file = File.new(file) unless file.is_a? File
+  # Split on the double newlines that separate the dstat header from the csv data
+  file = file.read.split("\n\n")
+  file = file[1].nil? ? file[0] : file[1]
+  CSV.parse(file)
+  end
+
+  # 
+  # Given a dstat csv file, this will import the data, columnwise, into a Hash.
+  # dstat CSV files are often of the form:
+  #
+  # top_level_header_1,top_level_header_2,,,
+  # child_header_1,child_header_2,child_header3,child_header4
+  #
+  # or a more concrete example:
+  #
+  # epoch,memory usage,,,
+  # epoch,used,buff,cach,free
+  # 1121245,12456,12856,20059,2999095
+  # 1121246,12457,12855,20068,2996885
+  # 
+  # Where used, buff, cache, and free all correspond to memory usage. An index is created
+  # for each (parent header -> child header), unless parent header == child header.
+  #
+  # Using the concrete example above, the hash returned from this method would be indexed
+  # like so:
+  # 
+  # hash[:epoch] => [1121245, 1121246]
+  # hash[:memory_usage] => {:used => [12456, 12457], 
+  #                          :buff => [12856, 12855], 
+  #                          :cach => [20059, 20068], 
+  #                          :free => [2999095, 2996885]
+  #              }
+  #
+  # Written another way:
+  #
+  # puts hash[:memory_usage][:used]
+  # => "[12456, 12457]"
+  #
+  # The hash also has aliases for the keys, so you can access the values multiple ways:
+  #
+  # puts hash[:memory_usage][:used]
+  # => "[12456, 12457]"
+  #
+  # puts hash["memory_usage"]["used"]
+  # => "[12456, 12457]"
+  #
+  # puts hash["memory_usage_used"]
+  # => "[12456, 12457]"
+  # 
+  def import_dstat_csv(file)
+    csv = parse_from_file(file)
+    csv = normalize_top_level_header(csv)
+    csv = csv.transpose
+    csv_hash = Hash.new
+    csv.each do |column|
+      parent_header = column[0].gsub(/\s+/, "_").strip.to_sym
+      child_header = column[1].gsub(/\s+/, "_").strip.to_sym
+      if (parent_header != child_header)
+        csv_hash[parent_header] = Hash.new if csv_hash[parent_header].nil?
+        csv_hash[parent_header.to_s] = Hash.new if csv_hash[parent_header.to_s].nil?
+        csv_hash[parent_header][child_header] = column[2..-1]
+        csv_hash[parent_header.to_s][child_header.to_s] = column[2..-1]
+        csv_hash["#{parent_header}_#{child_header}"] = column[2..-1]
+      else
+        csv_hash[parent_header] = column[2..-1]
+        csv_hash[parent_header.to_s] = column[2..-1]
+      end
+    end
+    csv_hash
+  end
+end

data/lib/dstat/version.rb

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

data/spec/dstat-test.csv

@@ -0,0 +1,7 @@
+"epoch","total cpu usage",,,,,,"dsk/total",,"load avg",,,"memory usage",,,,"net/total",,"procs",,,"filesystem",,"sockets",,,,,"interrupts",,,"system",,"sysv ipc",,,"file locks",,,
+"epoch","usr","sys","idl","wai","hiq","siq","read","writ","1m","5m","15m","used","buff","cach","free","recv","send","run","blk","new","files","inodes","tot","tcp","udp","raw","frg","33","34","35","int","csw","msg","sem","shm","pos","lck","rea","wri"
+1412803673.026,2.092,0.337,91.968,5.596,0.000,0.007,877736.191,203248.643,0.220,0.050,0.020,2316075008.0,196341760.0,3298529280.0,2308231168.0,0.0,0.0,0.0,0.0,0.696,6464.0,266398.0,736.0,22.0,16.0,0.0,0.0,72.613,0.007,90.803,577.711,760.541,0.0,2.0,23.0,5.0,5.0,0.0,10.0
+1412803674.027,20.698,1.496,77.805,0.0,0.0,0.0,0.0,8192.0,0.220,0.050,0.020,2319179776.0,196341760.0,3298578432.0,2305077248.0,167.0,0.0,1.0,0.0,13.0,6464.0,266408.0,735.0,22.0,15.0,0.0,0.0,2.0,0.0,1.0,1061.0,240.0,0.0,2.0,23.0,5.0,5.0,0.0,10.0
+1412803675.027,11.750,0.750,87.500,0.0,0.0,0.0,0.0,16384.0,0.220,0.050,0.020,2322378752.0,196362240.0,3298578432.0,2301857792.0,60.0,0.0,0.0,0.0,21.0,6528.0,266424.0,735.0,22.0,15.0,0.0,0.0,4.0,0.0,2.0,710.0,340.0,0.0,2.0,23.0,5.0,5.0,0.0,10.0
+1412803676.027,0.0,0.0,100.0,0.0,0.0,0.0,0.0,0.0,0.220,0.050,0.020,2322513920.0,196362240.0,3298594816.0,2301706240.0,0.0,0.0,0.0,0.0,1.0,6528.0,266424.0,735.0,22.0,15.0,0.0,0.0,0.0,0.0,0.0,64.0,97.0,0.0,2.0,23.0,5.0,5.0,0.0,10.0
+1412803677.027,0.0,0.0,100.0,0.0,0.0,0.0,0.0,0.0,0.220,0.050,0.020,2322513920.0,196362240.0,3298594816.0,2301706240.0,60.0,0.0,0.0,0.0,0.0,6528.0,266424.0,735.0,22.0,15.0,0.0,0.0,0.0,0.0,2.0,39.0,54.0,0.0,2.0,23.0,5.0,5.0,0.0,10.0

data/spec/dstat_spec.rb

@@ -0,0 +1,37 @@
+require 'rspec'
+require 'dstat'
+
+describe Dstat do
+	include Dstat
+	it "creates multiple indexes for dstat output" do
+		dstat = import_dstat_csv('spec/dstat-test.csv')
+		
+		expect(dstat[:epoch]).to eq(dstat["epoch"])
+		
+		[:usr, :sys, :idl, :wai, :hiq, :siq].each do |usage|
+			expect(dstat[:total_cpu_usage][usage]).to eq(dstat["total_cpu_usage"][usage.to_s])
+		end
+
+		[:read, :writ].each do |dsk|
+			expect(dstat[:"dsk/total"][dsk]).to eq(dstat["dsk/total"][dsk.to_s])
+		end
+
+		[:"1m", :"5m", :"15m"].each do |avg|
+			expect(dstat[:load_avg][avg]).to eq(dstat["load_avg"][avg.to_s])
+		end
+
+		[:used, :buff, :cach, :free].each do |usage|
+			expect(dstat[:memory_usage][usage]).to eq(dstat["memory_usage"][usage.to_s])
+		end
+
+		[:recv,	:send].each do |net|
+			expect(dstat[:"net/total"][net]).to eq(dstat["net/total"][net.to_s])
+		end
+
+		# TODO, write the rest of the assertions
+	end
+
+	it "correctly parses the data" do
+		# TODO write parser validation
+	end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: dstat
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Larson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- rlarson@tripwire.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dstat.gemspec
+- lib/dstat.rb
+- lib/dstat/version.rb
+- spec/dstat-test.csv
+- spec/dstat_spec.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Utilities for parsing dstat data from dstat csv files.
+test_files:
+- spec/dstat-test.csv
+- spec/dstat_spec.rb