memstat_csv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 626691ce626f8adc5b37e68ee61dbb55d05f2870
+  data.tar.gz: 2f78252ba92d7553065886996a929fa1243af5f9
+SHA512:
+  metadata.gz: 3a24627857b3a9f006f89bc6dae9431af3857adba7f9341475dd5350c4bfad83435c42dce7f42440720ee50ca97a8affe0bf22f35ec64a81b6f0707b35eb72b9
+  data.tar.gz: f79129d75b80730a77b64277b00a109571569671cef86543b0e00addef212fce0df6a723a5723b013eff195512563675d178d567e691da541f7fb31fd4bb5aa9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ServeBox
+
+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,60 @@
+# MemstatCsv
+
+memstat_csv starts a thread which logs to a CSV file the memory usage for
+debugging or visualization. It is based on the
+[memstat](https://github.com/kenn/memstat) gem and uses the information
+provided by `/proc/PID/status` :
+
+* peak: Peak memory size
+* size: Virtual memory size
+* lck: Lock memory size
+* hwm: "High water mark" (peak resident set size)
+* rss: Resident set size
+* data, stk, exe: Size of the data, stack and text segments
+* lib: Shared library code size
+* pte: Page table entries size
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'memstat_csv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memstat_csv
+
+## Usage
+
+```
+# Start collecting data
+mem_logger=MemstatCSV::Logger.new
+# ...
+# Stop collecting data
+Thread.kill(mem_logger)
+```
+
+By default, the data is collected approximately every second and data is written
+in a CSV file named 'memlog-PID.csv' in the system temp directory (e.g.
+  `/tmp/`). If you need to override these default settings, use the `sleep_time`
+and `basedir` options:
+
+```
+mem_logger=MemstatCSV::Logger.new(sleep_time: 0.5, basedir: '.')
+# ...
+Thread.kill(mem_logger)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/memstat_csv/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => [:test]

data/lib/memstat_csv.rb

@@ -0,0 +1,54 @@
+require 'memstat_csv/version'
+require 'memstat'
+require 'fileutils'
+require 'csv'
+
+module MemstatCSV
+
+  class Logger < Thread
+
+    def initialize(options={})
+      prepare(options)
+      super do
+        monitor
+      end
+    end
+
+    private
+
+    def monitor
+      @csv=CSV.open(@path, 'wb')
+      @csv.sync=true
+      @csv << headers
+      while true
+        @memstat=Memstat::Proc::Status.new(pid: Process.pid)
+        @csv << [(Time.now - @start_time).round(3)] + stats
+        sleep @sleep_time
+      end
+    end
+
+    def prepare(options={})
+      @sleep_time = options[:sleep_time] || 1
+      basedir = File.expand_path(options[:basedir] || Dir.tmpdir)
+      FileUtils.mkdir_p(basedir) unless File.directory?(basedir)
+      @path = File.join(basedir, "memlog-#{Process.pid}.csv")
+      @start_time=Time.now
+    end
+
+    def headers
+      ['time (s)'] +
+        Memstat::Proc::Status::FIELDS +
+        Memstat::Proc::Status::FIELDS.map{|f| "#{f} (MB)"}
+    end
+
+    def stats
+      Memstat::Proc::Status::FIELDS.map{ |f|
+        @memstat.send(f)
+      } + Memstat::Proc::Status::FIELDS.map{ |f|
+        @memstat.send(f) / 1024**2
+      }
+    end
+
+  end
+
+end

data/lib/memstat_csv/version.rb

@@ -0,0 +1,3 @@
+module MemstatCsv
+  VERSION = "0.1.0"
+end

data/memstat_csv.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memstat_csv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "memstat_csv"
+  spec.version       = MemstatCsv::VERSION
+  spec.authors       = ["Jef Mathiot"]
+  spec.email         = ["jmathiot@servebox.com"]
+  spec.summary       = %q{Log memory statistics to a CSV file.}
+  spec.description   = %q{Start a thread to log memory statistics to a CSV file. Based on memstat.}
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'mocha', '~> 1.1', '>= 1.1.0'
+  spec.add_development_dependency 'minitest', '~> 5.4', '>= 5.4.1'
+
+  spec.add_dependency "memstat", "~> 0.1.0", ">= 0.1.3"
+end

data/spec/memstat_csv_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'csv'
+
+describe MemstatCSV::Logger do
+
+  it 'logs memory statistics' do
+    logger = MemstatCSV::Logger.new(basedir: './tmp', sleep_time: 0.1)
+    # Yes, I know...
+    sleep 1
+    Thread.kill(logger)
+    csv = CSV.read(File.expand_path("./tmp/memlog-#{Process.pid}.csv"))
+    csv.size.must_be :>=, 2
+    # Remove headers row and check its contents
+    csv.shift.must_equal [
+      "time (s)",
+      "peak",
+      "size",
+      "lck",
+      "pin",
+      "hwm",
+      "rss",
+      "data",
+      "stk",
+      "exe",
+      "lib",
+      "pte",
+      "swap",
+      "peak (MB)",
+      "size (MB)",
+      "lck (MB)",
+      "pin (MB)",
+      "hwm (MB)",
+      "rss (MB)",
+      "data (MB)",
+      "stk (MB)",
+      "exe (MB)",
+      "lib (MB)",
+      "pte (MB)",
+      "swap (MB)"
+    ]
+    # Verify content of each remaining row
+    csv.each do |row|
+      row.shift.must_match /^\d(\.\d{0,3})?$/
+      row.each do |cell|
+        cell.to_i.must_be :>=, 0
+        cell.to_i.to_s.must_equal cell
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'memstat_csv'
+require 'minitest'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'mocha/setup'

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: memstat_csv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jef Mathiot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.1
+- !ruby/object:Gem::Dependency
+  name: memstat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+description: Start a thread to log memory statistics to a CSV file. Based on memstat.
+email:
+- jmathiot@servebox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/memstat_csv.rb
+- lib/memstat_csv/version.rb
+- memstat_csv.gemspec
+- spec/memstat_csv_spec.rb
+- spec/spec_helper.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: Log memory statistics to a CSV file.
+test_files:
+- spec/memstat_csv_spec.rb
+- spec/spec_helper.rb
+has_rdoc: