get_process_mem 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40e47a8db99d1a0aa017234b19201977d0d5ffd7
-  data.tar.gz: e6f6c78ed5e072ba3e1c61ca8485e04f470e19e0
+  metadata.gz: 1926d125b830fc4f0f99e8a4a74d68e98ff26e53
+  data.tar.gz: 49a31e4c798e3b8b9985ee2e7a5f0fbf347e1ec9
 SHA512:
-  metadata.gz: 35a0c27762550925839a2c6722d3e759bb77568e1a7badf46ddaa81c5907ee1c7e4c122b9e9bc0b772ce573c3d4b08b5626ec40bf71f5491c6a5250f1ac05893
-  data.tar.gz: 1ff60c90b5f3b47526b86a5ea7bcb4d40068a4aa67a424246bcde6bc25a2cfb2b43dd03de2806c6e8b8be2943e28d3fdbce4eaeff565496d2f1ee6aa15e045d9
+  metadata.gz: fce55634e47e6282a8fa42d2dd2df39a201c180612a70a6e87fce95dfbf313080fbbe46a80f00b21e62c40b99d9d304c35bcfa1adbb768b6b0e67d1409111bc0
+  data.tar.gz: cdcbe4cae20d5af9d53a79ec37f89cf2bfdb2d7d211114f78fa89b56cf732c3d39ca6ea39417da13ee1d393a772f8ecc63389ab7b7e26836907238088d29d0fd

data/.gitignore

@@ -1 +1,2 @@
 *.gem
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.1.0
+
+- Default to using PSS for linux (#2 & #3) @ksoderstrom
+- Correct for bit shifting truncation (#4) @ksoderstrom
+
+## 0.0.1
+
+- Initial

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/schneems/get_process_mem.png?branch=master)](https://travis-ci.org/schneems/get_process_mem)
 
-Do you need to get the memory useage of a process? Great because this library does that.
+Do you need to get the memory usage of a process? Great because this library does that.
 
 ## Install
 
@@ -28,7 +28,7 @@ mem.mb    # => 24.28125
 mem.gb    # => 0.023712158203125
 ```
 
-Note: all numeric values returned as a float except bytes which is an integer.
+Note: All numeric values returned as a float except bytes which is an integer.
 
 Get memory usage of another process:
 
@@ -47,7 +47,13 @@ mem.inspect
 `rm tmplog`
 ```
 
-For memory size we return the RSS or the [Resident Set Size](http://en.wikipedia.org/wiki/Resident_set_size), basically how much memory the program takes up in RAM at the time. It's all I needed for the project.
+On Linux, which provides `/proc/<pid>/smaps`, the default memory type returned is PSS, or "proportional set size", where shared memory is divided by the number of processes sharing it. On other platforms, the size returned is the RSS or the [Resident Set Size](http://en.wikipedia.org/wiki/Resident_set_size), basically how much memory the program takes up in RAM at the time, including all the shared memory.
+
+The memory type can be specified by passing an options hash:
+
+```ruby
+GetProcessMem.new(Process.pid, mem_type: 'rss')
+```
 
 
 

data/lib/get_process_mem.rb

@@ -6,14 +6,14 @@ class GetProcessMem
   MB_TO_BYTE = 1_048_576     # 1024**2 = 1_048_576
   GB_TO_BYTE = 1_073_741_824 # 1024**3 = 1_073_741_824
   CONVERSION = { "kb" => KB_TO_BYTE, "mb" => MB_TO_BYTE, "gb" => GB_TO_BYTE}
-  MEM_TYPE   = "rss" # http://en.wikipedia.org/wiki/Resident_set_size
   attr_reader :pid
 
-  def initialize(pid = Process.pid, mem_type = MEM_TYPE)
-    @process_file = Pathname.new "/proc/#{pid}/status"
+  def initialize(pid = Process.pid, options = {})
+    @process_file = Pathname.new "/proc/#{pid}/smaps"
     @pid          = pid
     @linux        = @process_file.exist?
-    self.mem_type = mem_type
+    options[:mem_type] ||= @linux ? 'pss' : 'rss'
+    self.mem_type = options[:mem_type]
   end
 
   def linux?
@@ -65,17 +65,25 @@ class GetProcessMem
   def mem_type_for_linux
     case mem_type
     when 'rss'
-      'VmRSS'
+      'Rss'
+    when 'pss'
+      'Pss'
     end
   end
 
-  # linux stores memory info in a file "/proc/#{pid}/status"
+  # linux stores memory info in a file "/proc/#{pid}/smaps"
   # If it's available it uses less resources than shelling out to ps
+  # It also allows us to use Pss (the process' proportional share of
+  # the mapping that is resident in RAM) as mem_type
   def linux_memory
-    line = @process_file.each_line.detect {|line| line.include? mem_type_for_linux }
-    return unless line
-    return unless (name, value, unit = line.split(nil)).length == 3
-    CONVERSION[unit.downcase] * value.to_i
+    lines = @process_file.each_line.select {|line| line.include? mem_type_for_linux }
+    return unless lines.length > 0
+    lines.reduce(0) do |sum, line|
+      return unless (name, value, unit = line.split(nil)).length == 3
+      # The PSS value is truncated, and adding 0.5 should average this out
+      value = value.to_f + 0.5 if mem_type == 'pss'
+      sum += CONVERSION[unit.downcase] * value.to_f
+    end
   end
 end
 

data/lib/get_process_mem/version.rb

@@ -1,3 +1,3 @@
 class GetProcessMem
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: get_process_mem
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -33,8 +33,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - get_process_mem.gemspec
@@ -62,11 +62,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Use GetProcessMem to find out the amount of RAM used by any process
 test_files:
 - test/get_process_mem_test.rb
 - test/test_helper.rb
-has_rdoc: 

data/Gemfile.lock

@@ -1,16 +0,0 @@
-PATH
-  remote: .
-  specs:
-    get_process_mem (0.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    rake (10.1.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  get_process_mem!
-  rake (~> 10.1)