proc_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d02762173ed67bc907bd6ef6339abfa4dc9cf7df
+  data.tar.gz: 728440954994def2629aa26059190917358ae542
+SHA512:
+  metadata.gz: 5229293647075b4fa4911d5e70bbc7a4c85597c028f97855900fa4d6dd294c07c31a7142f8c54d9e67b4ae6ed15fc6aef6d312a685ffb71a02921fc4119004e7
+  data.tar.gz: 1d3172a32f58b31b0b3cfa0412e529e2035bea4e2cdeb303235bab97a42bd94207f595a8f526a427d81c89b2ed9900587a012091009fc432cf1519799fd62956

data/.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_PATH: "./vendor/.bundle"
+BUNDLE_DISABLE_SHARED_GEMS: "true"

data/.gitignore

@@ -0,0 +1,11 @@
+/vendor/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in proc_parser.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    proc_parser (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.1.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  proc_parser!
+  rake (~> 12.1)
+  rspec (~> 3.6)
+
+BUNDLED WITH
+   1.15.4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,70 @@
+# proc_parser
+
+proc_parser provides a Ruby wrapper for /proc data such as those contained in
+/proc/mem_info, /proc/stat and /proc/loadavg.
+
+Interested in support of more proc files? Contributions are welcome! You can
+either create an [issue](https://github.com/EtienneM/mem_info/issues) or
+propose a [pull request](https://github.com/EtienneM/mem_info/pulls).
+
+Wondering the meaning of some fields? Read the manual with [`man 5
+proc`](https://linux.die.net/man/5/proc).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'proc_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install proc_parser
+
+## Usage
+
+```ruby
+meminfo = ProcParser::MemInfo
+memtotal = meminfo.memtotal
+memfree = meminfo.memfree
+```
+
+## Development
+
+After checking out the repositories, run `bin/setup` to install dependencies.
+Then, run `bundle exec rake spec` to run the tests. You can also run
+`bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+### Without installing Ruby globally
+
+On my work station, I prefer to use a Docker image with Ruby installed instead
+of installing Ruby locally. Hence, any `bundle …` command can be prefixed with
+`docker-compose run proc-parser`. For instance, running the tests is done with
+the command `docker-compose run proc-parser bundle exec rake spec`.
+
+## Acknowledgment
+
+This gem is a generalization of the wonderful work from
+[watsonian](https://github.com/watsonian/) and its
+[`mem_info`](https://github.com/watsonian/mem_info/) gem.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/EtienneM/proc_parser.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'proc_parser'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,12 @@
+version: '2'
+services:
+  proc-parser:
+    image: ruby:2.4.2
+    environment:
+      BUNDLE_BIN: "/usr/src/app/vendor/.bundle/ruby/2.4.0/bin"
+      BUNDLE_PATH: "/usr/src/app/vendor/.bundle/ruby/2.4.0"
+      BUNDLE_APP_CONFIG: "/usr/src/app/.bundle"
+    working_dir: /usr/src/app
+    volumes:
+      - ./:/usr/src/app/
+    command: "true"

data/lib/proc_parser.rb

@@ -0,0 +1,8 @@
+require 'proc_parser/version'
+
+module ProcParser
+  class NoProcData < RuntimeError; end
+end
+
+require 'proc_parser/cpu_stat'
+require 'proc_parser/mem_info'

data/lib/proc_parser/cpu_stat.rb

@@ -0,0 +1,69 @@
+module ProcParser
+  class CPUStat
+    #
+    # This class read CPU usage information from the /proc/stat file. The behavior for Kernel
+    # version prior to 2.5.41 is undefined.
+    #
+
+    attr_accessor :user, :nice, :system, :idle, :iowait, :irq, :softirq, :steal, :guest, :guest_nice
+    @@attributes = {
+      user:       1,
+      nice:       2,
+      system:     3,
+      idle:       4,
+      iowait:     5,
+      irq:        6,
+      softirq:    7,
+      steal:      8,
+      guest:      9,
+      guest_nice: 10,
+    }
+
+    attr_accessor :nb_cpu
+
+    def initialize(stat_file = '/proc/stat')
+      raise NoProcData, "This system doesn't have /proc/stat data." if !File.exist?(stat_file)
+
+      File.open(stat_file, 'r') do |file|
+        firstline = file.readline.strip.squeeze(' ').split(' ')
+        raise NoProcData, 'Unsupported format of /proc/stat' if firstline[0] != 'cpu'
+
+        @@attributes.each do |attribute, index|
+          instance_variable_set("@#{attribute}", firstline[index].to_i)
+        end
+
+        @nb_cpu = 0
+        file.each do |line|
+          splitted_line = line.strip.squeeze(' ').split(' ')
+          break if !splitted_line[0].start_with? 'cpu'
+          @nb_cpu += 1
+        end
+      end
+    end
+
+    #
+    ## Get the current CPU usage in percentage. It's a global percentage normalized on the number of
+    # CPU.
+    #
+    # The CPU usage is actually everything but the idle time of the CPU.
+    #
+    # cf. `htop` source code: https://github.com/hishamhm/htop/blob/e0209da88faf3b390d71ff174065abd407abfdfd/ProcessList.c#L947
+    # cf. man 5 proc
+    # cf. https://stackoverflow.com/a/23376195/1351436
+    #
+    def percentage_usage
+      # Guest time is already accounted in user time
+      user = @user - @guest
+      nice = @nice - @guest_nice
+
+      idlealltime = @idle + @iowait
+      systemalltime = @system + @irq + @softirq
+      virtalltime = @guest + @guest_nice
+      non_idlealltime = user + nice + systemalltime + @steal + virtalltime
+
+      total = idlealltime + non_idlealltime
+
+      return non_idlealltime / total.to_f / @nb_cpu
+    end
+  end
+end

data/lib/proc_parser/mem_info.rb

@@ -0,0 +1,102 @@
+module ProcParser
+  class MemInfo
+    #
+    # This class read memory information from the /proc/meminfo file.
+    #
+    # All the values returned by this class are in kilobytes.
+    #
+
+    # Contains the data in kilobytes
+    attr_accessor :memtotal, :memfree, :buffers, :cached, :swapcached, :active, :inactive,
+                  :active_anon, :inactive_anon, :active_file, :inactive_file, :unevictable,
+                  :mlocked, :swaptotal, :swapfree, :dirty, :writeback, :anonpages, :mapped,
+                  :slab, :sreclaimable, :sunreclaim, :pagetables, :nfs_unstable, :bounce,
+                  :writebacktmp, :commitlimit, :committed_as, :vmalloctotal, :vmallocused,
+                  :vmallochunk, :directmap4k, :directmap2m
+
+    @@attributes = {
+      memtotal: 'MemTotal',
+      memfree: 'MemFree',
+      buffers: 'Buffers',
+      cached: 'Cached',
+      swapcached: 'SwapCached',
+      active: 'Active',
+      inactive: 'Inactive',
+      active_anon: 'Active\(anon\)',
+      inactive_anon: 'Inactive\(anon\)',
+      active_file: 'Active\(file\)',
+      inactive_file: 'Inactive\(file\)',
+      unevictable: 'Unevictable',
+      mlocked: 'Mlocked',
+      swaptotal: 'SwapTotal',
+      swapfree: 'SwapFree',
+      dirty: 'Dirty',
+      writeback: 'Writeback',
+      anonpages: 'AnonPages',
+      mapped: 'Mapped',
+      slab: 'Slab',
+      sreclaimable: 'SReclaimable',
+      sunreclaim: 'SUnreclaim',
+      pagetables: 'PageTables',
+      nfs_unstable: 'NFS_Unstable',
+      bounce: 'Bounce',
+      writebacktmp: 'WritebackTmp',
+      commitlimit: 'CommitLimit',
+      committed_as: 'Committed_AS',
+      vmalloctotal: 'VmallocTotal',
+      vmallocused: 'VmallocUsed',
+      vmallocchunk: 'VmallocChunk',
+      directmap4k: 'DirectMap4k',
+      directmap2m: 'DirectMap2M',
+    }
+
+    def initialize(meminfo_file = '/proc/meminfo')
+      raise NoProcData, "This system doesn't have /proc/meminfo data." if !File.exist?(meminfo_file)
+
+      File.open(meminfo_file, 'r') do |file|
+        data = file.read
+        @@attributes.each_key do |attribute|
+          value, unit = regex_match(attribute, data)
+          if unit != 'kB'
+            raise NoProcData, 'Unsupported unit stored in meminfo.'
+          end
+          instance_variable_set("@#{attribute}", value.to_i)
+        end
+      end
+    end
+
+    # Memory currently in use.
+    #
+    # We substract the free amount of memory to the total.
+    def memused
+      @memtotal - @memfree
+    end
+
+    # Swap currently in use.
+    #
+    # We substract the free amount of swap to the total.
+    def swapused
+      @swaptotal - @swapfree
+    end
+
+    # Memory available in the system. It is not just the free memory.
+    #
+    # The available memory is actually what the `free` command line tool calls `-/+ buffers/cache`. It
+    # uses information from /proc/meminfo: it sums the MemFree, the Buffers and the Cached.
+    #
+    # cf. `free` source code: https://github.com/mmalecki/procps/blob/fe4c4a7314f32907b9f558ad0d8b8d0ff1cc76be/free.c#L97
+    # cf. man 5 proc
+    #
+    def free_buffers
+      @memfree + @buffers + @cached
+    end
+
+    private
+
+    def regex_match(attribute, line)
+      regex = Regexp.new("#{@@attributes[attribute]}:[[:space:]]*([[:digit:]]*) ([[:alpha:]]*)")
+      m = regex.match(line)
+      return m[1], m[2] if line.match? regex
+    end
+  end
+end

data/lib/proc_parser/version.rb

@@ -0,0 +1,3 @@
+module ProcParser
+  VERSION = '0.1.0'.freeze
+end

data/proc_parser.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'proc_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'proc_parser'
+  spec.version       = ProcParser::VERSION
+  spec.authors       = ['Étienne Michon']
+  spec.email         = ['etienne@scalingo.com']
+
+  spec.summary       = 'ProcParser provides a Ruby wrapper for /proc data'
+  spec.description   = 'ProcParser provides a Ruby wrapper for /proc data such as mem_info, stat
+                          and loadavg'
+  spec.homepage      = 'https://github.com/EtienneM/proc_parser'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 12.1'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: proc_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Étienne Michon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: |-
+  ProcParser provides a Ruby wrapper for /proc data such as mem_info, stat
+                            and loadavg
+email:
+- etienne@scalingo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/proc_parser.rb
+- lib/proc_parser/cpu_stat.rb
+- lib/proc_parser/mem_info.rb
+- lib/proc_parser/version.rb
+- proc_parser.gemspec
+homepage: https://github.com/EtienneM/proc_parser
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.6.13
+signing_key: 
+specification_version: 4
+summary: ProcParser provides a Ruby wrapper for /proc data
+test_files: []