snipr 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
-SHA512: 
-  metadata.gz: fa11945d45829fb5f7ef8d2bfc641109d18d6f238b233c16b1fa2a5e13e1a595164cf1933db78583e90d925b471b09662fab1b19bb63a74e6859a711310e3cd1
-  data.tar.gz: de1f5f425b757abd09630cc232a417db1ade1c8506042a41a7939e15ecd650789fabb827d7ccf4c3dba3ef2f7dfd280224ab0643ca02476b531dca8b6e29ff81
 SHA1: 
-  metadata.gz: a133c18251342f631b0a254bce7546f26ff97e80
-  data.tar.gz: 48a55cc801d8f376bdb0cc7302eea605153e5a90
+  data.tar.gz: 0432d5218407fc9b0a154390e2ac486f87e6df94
+  metadata.gz: d415fed3259b55fbfaa03a951951f79ed5620fde
+SHA512: 
+  data.tar.gz: bc24aca5874832df60f75758f0958e96628af0bcedbb2ab7284dff51cadd46cc2af3c31e125f4808b7695cc25ad497e8be9291e71818fc6ddd3162ccda56f3e8
+  metadata.gz: cc023afbc9374259e1f1923b1c720e8ad6e1729fe9809c3adffb36855a849a76488f99f3e0b97812cfe25ef4a26057a1e03ce927089bd8c309dd2ca76b29bb4b

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 #### Culling Runaway Resque Workers
 ```
-Usage: reap_resque_workers [options]
+Usage: snipe [options]
 
 Can be used to reap runaway resque workers that have exceeded too much memory
 use, CPU use, or time alive.  By default, this sends USR1 to the parent worker
@@ -30,23 +30,32 @@ process, which causes it to immediately kill the runaway child.  The parent
 will then spawn another child to continue work.
 
 Options:
-    -m, --memory [BYTES]             Workers using more than some bytes size of
-                                     memory
-    -c, --cpu [PERCENTAGE]           workers using more than a percentage of CPU
-    -a, --alive [SECONDS]            Workers that have been alive for some
+    -i, --include [PATTERN]          Pattern that must be matched for a process
+                                     to be included
+    -e, --exclude [PATTERN]          Pattern hat must NOT be matched for a
+                                     process to be included
+    -m, --memory [BYTES]             Processes using more than some bytes size
+                                     of memory
+    -c, --cpu [PERCENTAGE]           Processes using more than a percentage of
+                                     CPU
+    -a, --alive [SECONDS]            Processes that have been alive for some
                                      length of time in seconds
-    -s, --signal [SIGNAL]            Signal to send to the worker's parent.
-                                     Defaults to USR1.
+    -s, --signal [SIGNAL]            Signal to send to the targetted process or
+                                     its parent.  Defaults to KILL.
     -d, --dry-run                    Perform a dry run which will identify
-                                     workers to be reaped but not send any
-                                     signals
+                                     processes to be targetted but does not send
+                                     any signals
+```
+
+Here is an example of a command that we use at ShippingEasy to reap runaway
+resque workers that have been running for longer than 24 hours:
+
+```
+snipe -i resque -i processing -e scheduler -a 86400
 ```
 
 #### TODO
 * Better readme docs
-* General purpose command that lets you specify process filter options & signal
-  to send to arbitrary processes
-* A command that targets bloated unicorn workers
 
 ## Contributing
 

data/bin/snipe

@@ -0,0 +1,141 @@
+#!/usr/bin/ruby
+require 'ostruct'
+require 'optparse'
+
+options = OpenStruct.new({
+  :includes => [],
+  :excludes => [],
+  :signal => 'KILL',
+  :target_parent => false
+})
+
+parser = OptionParser.new do |config|
+  config.banner = "Usage: snipe [options]"
+  config.separator ""
+  config.separator "Target a process for signals using include/exclude regex"
+  config.separator "patterns and memory use, cpu use or time alive conditions."
+  config.separator "By default, this sends KILL (9) to the targetted process,"
+  config.separator "but options can be used to override the signal or to "
+  config.separator "target the parent process instead."
+  config.separator ""
+  config.separator "Options:"
+
+  desc = "Pattern that must be matched for a process to be included"
+  config.on("-i", "--include [PATTERN]", desc) do |pattern|
+    options.includes << /#{pattern}/i
+  end
+
+  desc = "Pattern that must NOT be matched for a process to be included"
+  config.on("-e", "--exclude [PATTERN]", desc) do |pattern|
+    options.excludes << /#{pattern}/i
+  end
+
+  desc = "Processes using more than some bytes size of memory"
+  config.on("-m", "--memory [BYTES]", desc) do |bytes|
+    options.bytes = bytes.to_i
+  end
+
+  desc = "Processes using more than a percentage of CPU"
+  config.on("-c", "--cpu [PERCENTAGE]", desc) do |cpu|
+    options.cpu = cpu.to_f
+  end
+
+  desc = "Processes that have been alive for some length of time in seconds"
+  config.on("-a", "--alive [SECONDS]", desc) do |sec|
+    options.alive = sec.to_i
+  end
+
+  desc = "Signal to send to the targetted process or its parent.  Defaults to KILL."
+  config.on("-s", "--signal [SIGNAL]", desc) do |signal|
+    options.signal = signal
+  end
+
+  desc = "Send the signal to the parent of the targetted process"
+  config.on("-p", "--parent", desc) do
+    options.target_parent = true
+  end
+
+  desc = "Perform a dry run which will identify processes to be targetted but not send any signals"
+  config.on("-d", "--dry-run", desc) do
+    options.no_signals = true
+  end
+end.parse!
+
+# TODO remove me
+$: << 'lib'
+
+require 'snipr'
+output = Snipr::Output.new
+
+if options.includes.empty?
+  output.err("error - You must specify an include pattern with -i")
+  Kernel.exit(-1)
+end
+
+unless options.bytes || options.keys || options.alive
+  output.err("error - You must specify at least one of -m, -c or -a")
+  Kernel.exit(-1)
+end
+
+output.info("*** DRY RUN ***") if options.no_signals
+
+signaller = Snipr::ProcessSignaller.new do |signaller|
+  options.includes.each do |pattern|
+    signaller.include pattern
+  end
+  options.excludes.each do |pattern|
+    signaller.exclude pattern
+  end
+  signaller.signal          options.signal
+  signaller.target_parent   options.target_parent
+  signaller.dry_run if options.no_signals
+
+  if options.bytes
+    signaller.memory_greater_than(options.bytes)
+  end
+
+  if options.cpu
+    signaller.cpu_greater_than(options.cpu)
+  end
+
+  if options.alive
+    signaller.alive_longer_than(options.alive)
+  end
+
+  signaller.on_no_processes do
+    output.info("no runaways found")
+  end
+
+  signaller.after_signal do |signal, process|
+    if options.target_parent
+      msg = "sent #{signal} to process #{process.ppid} to act on child " +
+            "#{process.pid}"
+    else
+      msg = "sent #{signal} to process #{process.pid}"
+    end
+
+    output.info(msg)
+
+    msg = "memory:#{process.memory} cpu:#{process.cpu} time_alive: " +
+          "#{process.seconds_alive} command: #{process.command}"
+    output.info(msg)
+  end
+
+  signaller.on_error do |error, signal, process|
+    raise error
+    if signal && process
+      if options.target_parent
+        msg = "error sending #{signal} to #{process.ppid} to act on " +
+              "#{process.pid}: #{error}"
+      else
+        msg = "error sending #{signal} to #{process.pid}: #{error}"
+      end
+    else
+      msg = "error: #{error}"
+    end
+    output.err(msg)
+    Kernel.exit(-1)
+  end
+end
+
+signaller.send_signals

data/lib/snipr/version.rb

@@ -1,3 +1,3 @@
 module Snipr
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: snipr
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors: 
 - Lance Woodson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-09-09 00:00:00 Z
+date: 2014-11-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -60,7 +60,7 @@ description: |
 email: 
 - lance@webmaneuvers.com
 executables: 
-- reap_resque_workers
+- snipe
 extensions: []
 
 extra_rdoc_files: []
@@ -73,7 +73,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/reap_resque_workers
+- bin/snipe
 - lib/snipr.rb
 - lib/snipr/output.rb
 - lib/snipr/process_locator.rb

data/bin/reap_resque_workers

@@ -1,107 +0,0 @@
-#!/usr/bin/ruby
-require 'ostruct'
-require 'optparse'
-
-options = OpenStruct.new({
-  :signal => 'USR1'
-})
-
-parser = OptionParser.new do |config|
-  config.banner = "Usage: reap_resque_workers [options]"
-  config.separator ""
-  config.separator "Can be used to reap runaway resque workers " +
-                   "that have exceeded too much memory use, " +
-                   "CPU use, or time alive."
-  config.separator "By default, this sends USR1 to the parent worker " +
-                   "process, which causes it to immediately kill " +
-                   "the runaway"
-  config.separator "child.  The parent will then spawn another child to " +
-                   "continue work."
-  config.separator ""
-  config.separator "Options:"
-
-  desc = "Workers using more than some bytes size of memory"
-  config.on("-m", "--memory [BYTES]", desc) do |bytes|
-    options.bytes = bytes.to_i
-  end
-
-  desc = "workers using more than a percentage of CPU"
-  config.on("-c", "--cpu [PERCENTAGE]", desc) do |cpu|
-    options.cpu = cpu.to_f
-  end
-
-  desc = "Workers that have been alive for some length of time in seconds"
-  config.on("-a", "--alive [SECONDS]", desc) do |sec|
-    options.alive = sec.to_i
-  end
-
-  desc = "Signal to send to the worker's parent.  Defaults to USR1."
-  config.on("-s", "--signal [SIGNAL]", desc) do |signal|
-    options.signal = signal
-  end
-
-  desc = "Perform a dry run which will identify workers to be reaped but not send any signals"
-  config.on("-d", "--dry-run", desc) do
-    options.no_signals = true
-  end
-end.parse!
-
-# TODO remove me
-$: << 'lib'
-
-require 'snipr'
-output = Snipr::Output.new
-
-unless options.bytes || options.keys || options.alive
-  output.err("error - You must specify at least one of -m, -c or -a")
-  Kernel.exit(-1)
-end
-
-output.info("*** DRY RUN ***") if options.no_signals
-
-signaller = Snipr::ProcessSignaller.new do |signaller|
-  signaller.signal          options.signal
-  signaller.target_parent   true
-  signaller.include         /resque/
-  signaller.include         /processing/i
-  signaller.exclude         /scheduler/i
-  signaller.dry_run if options.no_signals
-
-  if options.bytes
-    signaller.memory_greater_than(options.bytes)
-  end
-
-  if options.cpu
-    signaller.cpu_greater_than(options.cpu)
-  end
-
-  if options.alive
-    signaller.alive_longer_than(options.alive)
-  end
-
-  signaller.on_no_processes do
-    output.info("no runaways found")
-  end
-
-  signaller.after_signal do |signal, process|
-    msg = "sent #{signal} to worker #{process.ppid} to gracefully shutdown " +
-          "child #{process.pid}"
-    output.info(msg)
-
-    msg = "memory:#{process.memory} cpu:#{process.cpu} time_alive: " +
-          "#{process.seconds_alive} command: #{process.command}"
-    output.info(msg)
-  end
-
-  signaller.on_error do |error, signal, process|
-    raise error
-    if signal && process
-      output.err("error sending #{signal} to #{process.ppid} to gracefully shutdown #{process.pid}: #{error}")
-    else
-      output.err("error: #{error}")
-      Kernel.exit(-1)
-    end
-  end
-end
-
-signaller.send_signals