linux_proc_mem 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b711c603c2e49c96540e5c7504e7efc1cb4acf7f
+  data.tar.gz: 7d865a3cd96dab21f3880c1892f0bcaf7d47d8b8
+SHA512:
+  metadata.gz: 669d96f74dee8c55f79e8d757a7eb00b8d214d5c7e624e07cdbf01ee05910caacfc69a666df7b48c4bd65234580877744e9b9f6943d1f7185965dfc107958452
+  data.tar.gz: 302a8adf2e8fa4a18dbc4f0801df87f80df59aae4133417ab4fa76ab8efee5e3935f570a9466c9b3807f8fad302f54c604ebecead99cf684162584db602b91b2

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+proc-mem-gem

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Klaus Meyer
+
+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,38 @@
+# LinuxProcMem
+
+Get memory usage of a process including all child-processes (linux only).
+
+Uses `get_process_mem` gem for reading the memory from proc filesystem and adds a small layer to handle the child processes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'linux_proc_mem'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install linux_proc_mem
+
+## Usage
+
+```ruby
+require 'linux_proc_mem'
+pid = 1234
+bytes = LinuxProcMem.get_bytes(pid)
+puts "process #{pid} including childs is using #{bytes} bytes of system memory"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/klausmeyer/linux_proc_mem/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/linux_proc_mem/version.rb

@@ -0,0 +1,3 @@
+module LinuxProcMem
+  VERSION = "0.0.1"
+end

data/lib/linux_proc_mem.rb

@@ -0,0 +1,29 @@
+require "linux_proc_mem/version"
+require "get_process_mem"
+
+module LinuxProcMem
+  extend self
+
+  def get_bytes(pid)
+    file = Pathname.new("/proc/#{pid}/smaps")
+    raise "File #{file} not found!" unless File.exists?(file.to_s)
+    GetProcessMem.new.linux_memory(file) + child_pids(pid).inject(0) { |sum, cpid| sum += get_child_bytes(cpid) }
+  end
+
+  def child_pids(pid)
+    Dir["/proc/#{pid}/task/*/children"].map { |file| pids_from_file(file) }.flatten
+  end
+
+  private
+
+  # NOTE: This method is used as mock target to prevent
+  # too deep stack level during tests :)
+  def get_child_bytes(pid)
+    get_bytes(pid)
+  end
+
+  def pids_from_file(file)
+    File.read(file).split(/\s/).map(&:to_i)
+  end
+end
+

data/linux_proc_mem.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'linux_proc_mem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "linux_proc_mem"
+  spec.version       = LinuxProcMem::VERSION
+  spec.authors       = ["Klaus Meyer"]
+  spec.email         = ["spam@klaus-meyer.net"]
+  spec.summary       = "Get full memory usage of processes on linux"
+  spec.description   = "Get memory usage of processes including their child processes.\n" +
+                       "Works on Linux only."
+  spec.homepage      = "https://github.com/klausmeyer/linux_proc_mem"
+  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_dependency "get_process_mem", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/spec/linux_proc_mem_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe LinuxProcMem do
+  let(:pid) { 1234 }
+  let(:child_pids) { [1235, 1236, 1237, 1238] }
+
+  describe '.get_bytes(pid)' do
+    let(:process_mem) { double('GetProcessMem', linux_memory: 500.0) }
+
+    before do
+      allow(File).to receive(:exists?) { true }
+      allow(GetProcessMem).to receive(:new) { process_mem }
+      allow(LinuxProcMem).to receive(:child_pids) { child_pids }
+      allow(LinuxProcMem).to receive(:get_child_bytes) { 500.0 }
+    end
+
+    it 'returns the memory usage of pid and all childs in bytes' do
+      expect(LinuxProcMem.get_bytes(pid).to_f).to eq 2500.0
+    end
+  end
+
+  describe '.child_pids(pid)' do
+    context 'when the proc file exists' do
+      before do
+        allow(Dir).to receive(:[]) { ["/proc/#{pid}/task/#{pid}/children"] }
+        allow(File).to receive(:read) { child_pids.join(' ') }
+      end
+
+      it 'returns an array of child pids' do
+        expect(LinuxProcMem.child_pids(pid)).to eq child_pids
+      end
+    end
+
+    context 'when the proc file does not exists' do
+      before do
+        allow(Dir).to receive(:[]) { [] }
+      end
+
+      it 'returns an empty array' do
+        expect(LinuxProcMem.child_pids(pid)).to eq []
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+Bundler.setup
+Bundler.require(:default, :development, :test)
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: linux_proc_mem
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Klaus Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: get_process_mem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: |-
+  Get memory usage of processes including their child processes.
+  Works on Linux only.
+email:
+- spam@klaus-meyer.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/linux_proc_mem.rb
+- lib/linux_proc_mem/version.rb
+- linux_proc_mem.gemspec
+- spec/linux_proc_mem_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/klausmeyer/linux_proc_mem
+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: Get full memory usage of processes on linux
+test_files:
+- spec/linux_proc_mem_spec.rb
+- spec/spec_helper.rb