whacamole 0.2.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Njk4YWU0NWQyMzZjMjg4OWJhZGRlNTczYzIzNTllZmIyMmZkNDVmNQ==
+  data.tar.gz: !binary |-
+    NWU5OTM2Zjg0ZTY3ZDJkNzczMDg4MWMxODYzZTk5YzRlN2FiMTg3OA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZGY2MDllNzU4ZDg0Y2E5YTY4ODlhMTE3NTJmZDE5NjY0ZmJlZWY2OTVlZDgx
+    ZmUyZGU1ZTBhMWQ3MWVkZmMxZGU1OTEyZTIwZGVkMTdjYjM2M2IxZGRiNTgz
+    ZjBlOTM5MjVhNzQ0NzRlMTg2MGVhYTI5MzYxNzk1ZTg5MDA4YWQ=
+  data.tar.gz: !binary |-
+    OTY4MTM5NTU5NWJmMTQzOWQ5NzY1N2VlMWY2MDcyNjk2YjlkMWJmY2QyMGU4
+    MDNjYjkxYzZmNzcwMGJjMTk1ZjcxNjUzMzdiMjliNGQ2OGIzZWVlYjA1NTJh
+    NmQwNDRjZTRmOGZmMTA5ODVjN2EwM2FmYzMxODA1MmE4MzE0YjI=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whacamole (0.1.0)
+    whacamole (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -8,15 +8,15 @@ swapping to disk (aka get super slow).
 
 Here’s what Heroku says about dyno memory usage:
 
-> Dynos are available in 1X or 2X sizes and are allocated 512MB or 1024MB respectively.
+> Dynos are available in a few different sizes. The maximum amount of RAM available to your application depends on the dyno size you use.
 >
 > Dynos whose processes exceed their memory quota are identified by an R14 error in the logs. This doesn’t terminate the process, but it does warn of deteriorating application conditions: memory used above quota will swap out to disk, which substantially degrades dyno performance.
+> 
+> If the memory size of your dyno keeps growing until it reaches five times its quota (for a 1X dyno, 512MB x 5 = 2.5GB), the dyno manager will restart your dyno with an R15 error.
 >
-> If the memory size keeps growing until it reaches three times its quota, the dyno manager will restart your dyno with an R15 error.
->
-> - From https://devcenter.heroku.com/articles/dynos on 8/8/13
+> - From https://devcenter.heroku.com/articles/dynos on 3/12/14
 
-Heroku dynos swap to disk for up to 3GB. That is not good and that is the problem whacamole addresses.
+Heroku dynos swap to disk for up to 5GB (2X dynos) or up to THIRTY GIGABYTES (PX dynos). That is not good and that is the problem whacamole addresses.
 
 # Usage
 
@@ -45,6 +45,12 @@ end
 Whacamole.configure("ANOTHER HEROKU APP") do |config|
   config.api_token = ENV['HEROKU_API_TOKEN'] # you could also paste your token in here as a string
 end
+
+# you can specify which dynos to watch for each app (default: `web`):
+Whacamole.configure("HEROKU APP WITH MULTIPLE DYNO TYPES") do |config|
+  config.api_token = ENV['HEROKU_API_TOKEN'] # you could also paste your token in here as a string
+  config.dynos = %w{web worker}
+end
 ```
 
 Add whacamole to your Procfile, specifying the config file you created:
@@ -62,3 +68,31 @@ $ foreman start whacamole
 # on heroku
 $ heroku ps:scale whacamole=1 --app YOUR_APP_NAME
 ```
+
+# Events
+
+Each ping and restart is available to you, for example in case you want to see with your own eyes that it's working.
+
+Methods on DynoSize events
+ * event.process (the heroku process, eg "web.1")
+ * event.size (dyno size, eg 444.06)
+ * event.units (units for the size, eg "MB")
+
+Methods on DynoRestart events
+  * event.process (the heroku process, eg "web.1")
+  
+To access the events, add a handler in your config. Event handlers take a single argument, the event. This handler will log the event in your Heroku logs:
+
+```ruby
+Whacamole.configure("HEROKU APP NAME") do |config|
+  config.event_handler = lambda do |e|
+    puts e.inspect.to_s
+  end
+end
+```
+
+## Self Promotion
+
+If you like Whacamole, help spread the word! Tell your friends, or at the very least star the repo on github.
+
+For more heroku goodness, check out http://github.com/arches/table_print and http://github.com/arches/marco-polo

data/lib/whacamole.rb

@@ -16,7 +16,7 @@ module Whacamole
     threads = []
     @@config.each do |app_name, config|
       threads << Thread.new do
-        heroku = HerokuWrapper.new(app_name, config.api_token)
+        heroku = HerokuWrapper.new(app_name, config.api_token, config.dynos)
 
         while true
           stream_url = heroku.create_log_session
@@ -27,4 +27,3 @@ module Whacamole
     threads.collect(&:join)
   end
 end
-

data/lib/whacamole/config.rb

@@ -1,11 +1,11 @@
 module Whacamole
   class Config
-    attr_accessor :app_name, :api_token, :event_handler
+    attr_accessor :app_name, :api_token, :event_handler, :dynos
 
     def initialize(app_name)
       self.app_name = app_name
       self.event_handler ||= lambda { |e| puts e.inspect.to_s }
+      self.dynos ||= %w{web}
     end
   end
 end
-

data/lib/whacamole/heroku_wrapper.rb

@@ -4,13 +4,14 @@ require 'json'
 
 module Whacamole
   class HerokuWrapper
-    attr_accessor :api_token, :app_name
+    attr_accessor :api_token, :app_name, :dynos
 
     RESTART_RATE_LIMIT = 30*60
 
-    def initialize(app_name, api_token)
+    def initialize(app_name, api_token, dynos)
       self.app_name = app_name
       self.api_token = api_token
+      self.dynos = dynos
     end
 
     def create_log_session
@@ -69,4 +70,3 @@ module Whacamole
     end
   end
 end
-

data/lib/whacamole/stream.rb

@@ -9,6 +9,7 @@ module Whacamole
     def initialize(url, restart_handler, &blk)
       @url = url
       @restart_handler = restart_handler
+      @dynos = restart_handler.dynos
       @event_handler = blk
     end
 
@@ -50,21 +51,22 @@ module Whacamole
 
     def memory_size_from_chunk(chunk)
       sizes = []
+      dynos_regexp = Regexp.new('(' + @dynos.join('|') + ')\.\d+')
 
       # new log format
       chunk.split("\n").select{|line| line.include? "sample#memory_total"}.each do |line|
-        dyno = line.match(/web\.\d+/)
+        dyno = line.match(dynos_regexp)
         next unless dyno
         size = line.match(/sample#memory_total=([\d\.]+)/)
-        sizes << [dyno[0], size[1]]
+        sizes << [dyno[0], size[1]] unless size.nil?
       end
 
       # old log format
       chunk.split("\n").select{|line| line.include? "measure=memory_total"}.each do |line|
-        dyno = line.match(/web\.\d+/)
+        dyno = line.match(dynos_regexp)
         next unless dyno
         size = line.match(/val=([\d\.]+)/)
-        sizes << [dyno[0], size[1]]
+        sizes << [dyno[0], size[1]] unless size.nil?
       end
 
       sizes
@@ -87,6 +89,3 @@ module Whacamole
     end
   end
 end
-
-
-

data/lib/whacamole/version.rb

@@ -1,4 +1,4 @@
 module Whacamole
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end
 

data/spec/config_spec.rb

@@ -6,6 +6,10 @@ describe Whacamole::Config do
       c = Whacamole::Config.new("production")
       c.app_name.should == "production"
     end
+
+    it "sets default dyno to watch to web" do
+      c = Whacamole::Config.new("production")
+      c.dynos.should == %w{web}
+    end
   end
 end
-

data/spec/heroku_wrapper_spec.rb

@@ -2,7 +2,13 @@ require 'spec_helper'
 
 # TODO: use VCR instead of these method expectations
 describe Whacamole::HerokuWrapper do
-  let(:h) { Whacamole::HerokuWrapper.new("staging", "foobar") }
+  let(:h) { Whacamole::HerokuWrapper.new("staging", "foobar", %w{web worker}) }
+
+  describe "dynos" do
+    it "returns dyno types to monitor as given to initialize" do
+      h.dynos.should == %w{web worker}
+    end
+  end
 
   describe "authorization" do
     it "base64-encodes the api token and a preceding colon" do

data/spec/stream_spec.rb

@@ -16,6 +16,10 @@ class RestartHandler
   def restart(process)
     true
   end
+
+  def dynos
+    %w{web worker}
+  end
 end
 
 describe Whacamole::Stream do
@@ -67,6 +71,19 @@ describe Whacamole::Stream do
       end
     end
 
+    it "handles dyno types specified in restart handler" do
+      stream.dispatch_handlers <<-CHUNK
+          2013-08-22T16:39:22.919536+00:00 heroku[web.2]: source=web.2 dyno=heroku.772639.a334caa8-736c-48b3-bac2-d366f75d7fa0 sample#memory_total=101MB sample#memory_rss=581.75MB sample#memory_cache=0.16MB sample#memory_swap=0.03MB sample#memory_pgpgin=0pages sample#memory_pgpgout=179329pages
+          2013-08-22T16:39:22.919536+00:00 heroku[worker.3]: source=worker.3 dyno=heroku.772639.a334caa8-736c-48b3-bac2-d366f75d7fa0 sample#memory_total=101MB sample#memory_rss=581.75MB sample#memory_cache=0.16MB sample#memory_swap=0.03MB sample#memory_pgpgin=0pages sample#memory_pgpgout=179329pages
+          2013-08-22T16:39:22.919536+00:00 heroku[whacamole.1]: source=whacamole.1 dyno=heroku.772639.a334caa8-736c-48b3-bac2-d366f75d7fa0 sample#memory_total=1001MB sample#memory_rss=581.75MB sample#memory_cache=0.16MB sample#memory_swap=0.03MB sample#memory_pgpgin=0pages sample#memory_pgpgout=179329pages
+      CHUNK
+
+      eh.events.length.should == 2
+
+      eh.events.first.process.should == "web.2"
+      eh.events.last.process.should == "worker.3"
+    end
+
     context "when memory usages is over the threshold" do
       it "kicks off a restart" do
         restart_handler.should_receive(:restart).with("web.2")

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: whacamole
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -73,27 +68,26 @@ files:
 homepage: http://github.com/arches/whacamole
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: restart heroku dynos that run out of RAM instead of swapping to disk
 test_files:
 - spec/config_spec.rb