memory_monitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4f3b3846408e492e0139a3e62e08a15d92778f9
+  data.tar.gz: 4e4b2e68dbae6f5725f5bc451f9fc58cc1c5a179
+SHA512:
+  metadata.gz: 66d6f6b773d4297d3210e4e89370f84681f382f0a6668ead38d81e5ab2a6e78aabaff00b8f613bedd94a76af8600118be11f957e05f5f154cd43b9cfe2a14777
+  data.tar.gz: c4c3f92ee07b84939cb2a073cef23144ef44f68e3d886f89bd43edc2c0ea7665ed9a26488f27d5098c62ace43cea8c6d4f87c2e53c6a9061e5b727e1c39fddf8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+
+rvm:
+  - 2.3.0
+
+before_install: gem install bundler -v 1.13.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Loco2 Ltd.
+
+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,58 @@
+# `memory_monitor`
+
+This program is used to run a command with a memory limit.
+
+If the command exceeds the memory limit, it will receive a `SIGTERM` to
+exit gracefully. If it fails to exit gracefully within a timeout, it
+will receive a `SIGKILL` to exit ungracefully.
+
+The memory measurement used is [*resident set
+size*](https://en.wikichip.org/wiki/resident_set_size).
+
+## Example
+
+
+```
+$ bin/memory_monitor --limit 20 --interval 0.1 --timeout 0.1 ruby -e 'trap("TERM", "IGNORE"); a=[]; loop { a << "foo" * 500000; puts "hi"; sleep 0.01 }'
+hi
+hi
+hi
+hi
+hi
+hi
+hi
+[memory_monitor] process memory 22.0MB exceeded limit 20MB, sending SIGTERM
+hi
+hi
+hi
+hi
+hi
+hi
+hi
+hi
+hi
+[memory_monitor] process failed to stop after 0.1s, sending SIGKILL
+```
+
+## Intended use
+
+We are using this to monitor our Docker container processes to ensure
+they get restarted after a memory leak occurs. Within the container, we
+simply want the program to exit when its memory usage is too high. The
+container orchestration system will then notice that the container has
+died, and start a new one.
+
+## Treatment of subprocesses
+
+If the command spawns any subprocesses, they will also be checked.  We
+don't check the total memory usage of the process and its subprocesses,
+we check each one individually. If either the main process or any of its
+subprocesses exceeds the limit, the main process gets killed.
+(Signalling individual subprocesses while keeping the main process alive
+would be more complex and is not worth it.)
+
+## Bugs/features
+
+* Memory usage is measured by shelling out to the `ps` command; the
+  current implementation may be incompatible with some systems.
+* Tested with Ruby 2.3, but may work on prior versions too.

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/memory_monitor

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require_relative "../lib/memory_monitor"
+
+options = {}
+
+prev = nil
+args = ARGV.take_while { |arg|
+  val = arg.start_with?("-") || prev && prev.start_with?("-")
+  prev = arg
+  val
+}
+
+unless args.include?("-l") || args.include?("--limit")
+  args = ["--help"]
+end
+
+OptionParser.new { |opts|
+  opts.banner = "Usage: #{$0} [OPTIONS] [COMMAND]\n\n"
+
+  opts.on("-l", "--limit LIMIT", "Memory limit for any one process (MB, required)") do |v|
+    options[:limit] = v.to_i
+  end
+
+  opts.on("-t", "--timeout TIMEOUT", "Timeout (seconds, default: 2)") do |v|
+    options[:timeout] = v.to_f
+  end
+
+  opts.on("-i", "--interval INTERVAL", "Memory check interval (seconds, default: 1)") do |v|
+    options[:interval] = v.to_f
+  end
+}.parse(args)
+
+exit MemoryMonitor.run(ARGV.drop(args.length), options)

data/lib/memory_monitor.rb

@@ -0,0 +1,89 @@
+require_relative "memory_monitor/version"
+
+class MemoryMonitor
+  attr_reader :command, :limit, :timeout, :interval, :pid, :pgid,
+              :memory_in_kilobytes, :memory_in_megabytes
+
+  SIGNALS = %w(HUP INT QUIT USR1 USR2 TERM)
+
+  def self.run(*args)
+    new(*args).run
+  end
+
+  def initialize(command, limit:, timeout: 2, interval: 1)
+    @command  = command
+    @limit    = limit
+    @timeout  = timeout
+    @interval = interval
+  end
+
+  def run
+    forward_signals
+
+    @pid  = Process.spawn(*command, pgroup: true)
+    @pgid = Process.getpgid(pid)
+
+    Thread.abort_on_exception = true
+    Thread.new { monitor }
+
+    Process.wait pid
+
+    if $?.success?
+      $?.exitstatus
+    else
+      false
+    end
+  end
+
+  def limit_in_kilobytes
+    limit * 1024
+  end
+
+  def monitor
+    loop do
+      @memory_in_kilobytes =
+        `ps -o pgrp= -o rss=`
+          .split("\n")
+          .map { |line| line.split(" ").map(&:to_i) }
+          .select { |pgid, _| pgid == self.pgid }
+          .map { |_, size| size }
+          .max
+
+      @memory_in_megabytes = (memory_in_kilobytes / 1024).round(1)
+
+      if memory_in_kilobytes > limit_in_kilobytes
+        term
+        sleep timeout
+        kill
+      end
+
+      sleep interval
+    end
+  end
+
+  def term
+    log "process memory #{memory_in_megabytes}MB exceeded limit #{limit}MB, sending SIGTERM"
+    Process.kill("TERM", -pgid)
+  end
+
+  def kill
+    log "process failed to stop after #{timeout}s, sending SIGKILL"
+    Process.kill("KILL", -pgid)
+  end
+
+  def log(message)
+    $stderr.puts "[memory_monitor] #{message}"
+  end
+
+  def forward_signals
+    SIGNALS.each do |signal|
+      Signal.trap(signal) do
+        begin
+          Process.kill(signal, pid) if pid
+        rescue Errno::ESRCH
+          # pid doesn't exist
+        end
+      end
+    end
+  end
+end

data/lib/memory_monitor/version.rb

@@ -0,0 +1,3 @@
+class MemoryMonitor
+  VERSION = "0.1.0"
+end

data/memory_monitor.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memory_monitor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "memory_monitor"
+  spec.version       = MemoryMonitor::VERSION
+  spec.authors       = ["Jon Leighton"]
+  spec.email         = ["jon@loco2.com"]
+
+  spec.summary       = %q{Restart a process when memory usage is too high}
+  spec.description   = %q{Restart a process when memory usage is too high}
+  spec.homepage      = "https://github.com/loco2/memory_monitor"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: memory_monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Leighton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Restart a process when memory usage is too high
+email:
+- jon@loco2.com
+executables:
+- memory_monitor
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/memory_monitor
+- lib/memory_monitor.rb
+- lib/memory_monitor/version.rb
+- memory_monitor.gemspec
+homepage: https://github.com/loco2/memory_monitor
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Restart a process when memory usage is too high
+test_files: []