linux_process_memory 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31ab74b4c6400c74e5b44f8e566b3814f4967aad8f6921c243c9d6cc9c8cec6b
-  data.tar.gz: 9fad9bf95d085146dcdb427f09c5a1670e49b65f56c611f726caa2e003ac9d7b
+  metadata.gz: 323bf18a6925ba84406e8dce172f96bea086a8ff013f12ce974108e0b1edff83
+  data.tar.gz: cfcbd536e9e04e87a479b65145f748a52bb2c3350a5590322361346f8a5b23e3
 SHA512:
-  metadata.gz: 34e6e1eb617e34c402355a13441585cb0f8c38bf239da87be5f04257815ef9d4ce1342f4c9ab9c1531fd85247a379ab88d1a040e4b37c3e91293930024147b7e
-  data.tar.gz: 90e4549cb6d9d3428343d7cdc0d4f0e01193b8b5a0b5df626390816367ceff839fd69f9e91c2f25edcc4e48188344b40a6101fe3431e6d141a685b1cc8133db4
+  metadata.gz: cf5448a57d266966057cf8b3e85cc20ad2e17196197c90e1dca10cf8105ce5260517e323ae642599b2aa4779795d0366ce9a29c95ff8be23faca8e0f1f59d781
+  data.tar.gz: ba219e353e2d94534c42f3ff401105d065a5e8d3472a758599cc49b5fff2a679f538d7f8f4aae88e4b5b53311bb8f43703a8a929434e0ff071a7e1657f6095ad

data/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.1
+
+### Fixed
+- Handle race condition where the process exits between checking for and reading its smaps_rollup file; memory stats are now returned as zeroes instead of raising `Errno::ENOENT`.
+- Return zeroes instead of raising `Errno::EACCES` when the process is not readable by the current user.
+- Ignore blank lines when parsing smaps data.
+- Raise `ArgumentError` for unknown units even on non-Linux platforms instead of silently returning -1.
+
 ## 1.0.0
 
 ### Added

data/README.md

@@ -2,6 +2,7 @@
 
 [![Continuous Integration](https://github.com/bdurand/linux_process_memory/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/linux_process_memory/actions/workflows/continuous_integration.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Gem Version](https://badge.fury.io/rb/linux_process_memory.svg)](https://badge.fury.io/rb/linux_process_memory)
 
 Ruby gem to get a breakdown of the memory being used by a Linux process. It is specific to Linux and will not work on other operating systems even if they are Linux-like (i.e. MacOS, Windows, FreeBSD, etc.). The breakdown takes into account shared memory and swap memory. It is most useful for monitoring memory usage of processes that use shared memory.
 
@@ -39,7 +40,7 @@ memory.unique # same as uss
 memory.referenced # => memory actively referenced by the process (i.e. non-freeable memory)
 ```
 
-These measurements tend to be the mose useful ones especially if your processes are using shared memory:
+These measurements tend to be the most useful ones especially if your processes are using shared memory:
 
 - [Resident Set Size](https://en.wikipedia.org/wiki/Resident_set_size)
 - [Proportional Set Size](https://en.wikipedia.org/wiki/Proportional_set_size)

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/linux_process_memory.rb

@@ -46,7 +46,7 @@ class LinuxProcessMemory
   # @param units [Symbol] The units to return the memory usage in.
   #   Valid values are :bytes, :kilobytes, :megabytes, :gigabytes, :kb, :mb, :gb, :k, :m, :g.
   #   Defaults to :bytes.
-  # @return [Numberic]
+  # @return [Numeric]
   def total(units = :bytes)
     convert_units(@stats[:Rss] + @stats[:Swap], units)
   end
@@ -56,7 +56,7 @@ class LinuxProcessMemory
   # @param units [Symbol] The units to return the memory usage in.
   #   Valid values are :bytes, :kilobytes, :megabytes, :gigabytes, :kb, :mb, :gb, :k, :m, :g.
   #   Defaults to :bytes.
-  # @return [Numberic]
+  # @return [Numeric]
   def rss(units = :bytes)
     convert_units(@stats[:Rss], units)
   end
@@ -68,7 +68,7 @@ class LinuxProcessMemory
   # @param units [Symbol] The units to return the memory usage in.
   #   Valid values are :bytes, :kilobytes, :megabytes, :gigabytes, :kb, :mb, :gb, :k, :m, :g.
   #   Defaults to :bytes.
-  # @return [Numberic]
+  # @return [Numeric]
   def pss(units = :bytes)
     convert_units(@stats[:Pss], units)
   end
@@ -80,7 +80,7 @@ class LinuxProcessMemory
   # @param units [Symbol] The units to return the memory usage in.
   #   Valid values are :bytes, :kilobytes, :megabytes, :gigabytes, :kb, :mb, :gb, :k, :m, :g.
   #   Defaults to :bytes.
-  # @return [Numberic]
+  # @return [Numeric]
   def uss(units = :bytes)
     convert_units(@stats[:Private_Clean] + @stats[:Private_Dirty], units)
   end
@@ -92,7 +92,7 @@ class LinuxProcessMemory
   # @param units [Symbol] The units to return the memory usage in.
   #   Valid values are :bytes, :kilobytes, :megabytes, :gigabytes, :kb, :mb, :gb, :k, :m, :g.
   #   Defaults to :bytes.
-  # @return [Numberic]
+  # @return [Numeric]
   def swap(units = :bytes)
     convert_units(@stats[:Swap], units)
   end
@@ -102,7 +102,7 @@ class LinuxProcessMemory
   # @param units [Symbol] The units to return the memory usage in.
   #   Valid values are :bytes, :kilobytes, :megabytes, :gigabytes, :kb, :mb, :gb, :k, :m, :g.
   #   Defaults to :bytes.
-  # @return [Numberic]
+  # @return [Numeric]
   def shared(units = :bytes)
     convert_units(@stats[:Shared_Clean] + @stats[:Shared_Dirty], units)
   end
@@ -113,7 +113,7 @@ class LinuxProcessMemory
   # @param units [Symbol] The units to return the memory usage in.
   #   Valid values are :bytes, :kilobytes, :megabytes, :gigabytes, :kb, :mb, :gb, :k, :m, :g.
   #   Defaults to :bytes.
-  # @return [Numberic]
+  # @return [Numeric]
   def referenced(units = :bytes)
     convert_units(@stats[:Referenced], units)
   end
@@ -124,10 +124,19 @@ class LinuxProcessMemory
     stats = Hash.new(0)
     return stats unless File.exist?(smap_rollup_file)
 
-    data = File.read(smap_rollup_file).split("\n")
+    begin
+      contents = File.read(smap_rollup_file)
+    rescue Errno::ENOENT, Errno::EACCES, Errno::ESRCH
+      # The process exited or is not readable by the current user.
+      return stats
+    end
+
+    data = contents.split("\n")
     data.shift # remove header
     data.each do |line|
       key, value, unit = line.split
+      next if key.nil?
+
       key = key.chomp(":").to_sym
 
       multiplier = UNIT_CONVERSION.fetch(unit.to_s.downcase, 1)
@@ -139,11 +148,10 @@ class LinuxProcessMemory
   end
 
   def convert_units(value, units)
-    return -1 if value < 0
-
     divisor = UNIT_CONVERSION[units.to_s.downcase]
     raise ArgumentError.new("Unknown units: #{units}") unless divisor
 
+    return -1 if value < 0
     return value if divisor == 1
 
     value.to_f / divisor

data/linux_process_memory.gemspec

@@ -5,10 +5,15 @@ Gem::Specification.new do |spec|
   spec.email = ["bbdurand@gmail.com"]
 
   spec.summary = "Get a breakdown of the memory being used by a Linux process including resident, shared, private, and swap memory."
-
   spec.homepage = "https://github.com/bdurand/linux_process_memory"
   spec.license = "MIT"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md"
+  }
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   ignore_files = %w[

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: linux_process_memory
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brian Durand
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,7 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - bbdurand@gmail.com
 executables: []
@@ -40,8 +38,10 @@ files:
 homepage: https://github.com/bdurand/linux_process_memory
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/bdurand/linux_process_memory
+  source_code_uri: https://github.com/bdurand/linux_process_memory
+  changelog_uri: https://github.com/bdurand/linux_process_memory/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -56,8 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Get a breakdown of the memory being used by a Linux process including resident,
   shared, private, and swap memory.