autoscaler 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.0.2
+
+- Loosen Sidekiq version dependecy
+- Add changelog
+- Add changelog, readme, and examples to gem files list

data/README.md

@@ -0,0 +1,61 @@
+# Sidekiq Heroku Autoscaler
+
+[Sidekiq](https://github.com/mperham/sidekiq) performs background jobs.  While it's threading model allows it to scale easier than worker-pre-process background systems, people running test or lightly loaded systems on [Heroku](http://www.heroku.com/) still want to scale down to zero to avoid racking up charges.
+
+## Requirements
+
+Tested on Ruby 1.9.2 and Heroku Cedar stack.
+
+## Installation
+
+    gem install sidekiq
+
+## Getting Started
+
+This gem uses the [Herkou-Api](https://github.com/heroku/heroku.rb) gem, which requires an API key from Heroku.  It will also need the heroku app name.  By default, these are specified through environment variables.  You can also pass them to HerkouScaler explicitly.
+
+    HEROKU_API_KEY=.....
+    HEROKU_APP=....
+
+Install the middleware in your `Sidekiq.configure_` blocks
+
+    Sidekiq.configure_client do |config|
+      config.client_middleware do |chain|
+        chain.add Autoscaler::Sidekiq::Client, 'default' => Autoscaler::HerokuScaler.new
+      end
+    end
+
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.add(Autoscaler::Sidekiq::Server, Autoscaler::HerokuScaler.new, 60)
+      end
+    end
+
+## Limits and Challenges
+
+- HerokuScaler includes an attempt at current-worker cache that may be overcomplication, and doesn't work very well (see next)
+- Multiple threads often send scaling requests at once.  Heroku seems to handle this well.
+- Workers sleep-loop and are not actually returned to the pool; when a job or timeout happen, they can all release at once.
+
+### Long Jobs
+
+Since the shutdown check gets performed every time a job completes, the timeout will need to be longer than the longest job.  For mixed workloads, you might want to have multiple sidekiq processes defined.  I use one with many workers for general work, and a single-worker process for long import jobs.  See `examples/complex.rb`
+
+## Tests
+
+The project is setup to run RSpec with Guard.
+
+The HerokuScaler is not tested by default because it makes live API requests.  Specify `HEROKU_APP` and `HEROKU_API_KEY` on the command line, and then watch your app's logs.
+
+    HEROKU_APP=... HEROKU_API_KEY=... guard
+    heroku logs --app ...
+
+## Authors
+
+Justin Love, [@wondible](http://twitter.com/wondible), [https://github.com/JustinLove](https://github.com/JustinLove)
+
+Ported to Heroku-Api by Fix Peña, [https://github.com/fixr](https://github.com/fixr)
+
+## Licence
+
+Released under the [MIT license](http://www.opensource.org/licenses/mit-license.php).

data/examples/complex.rb

@@ -0,0 +1,40 @@
+require 'securerandom' # bug in Sidekiq as of 2.2.1
+require 'sidekiq'
+require 'autoscaler/sidekiq'
+require 'autoscaler/heroku_scaler'
+
+heroku = nil
+if ENV['HEROKU_APP']
+  heroku = {}
+  scaleable = %w[default import] - (ENV['ALWAYS'] || '').split(' ')
+  scaleable.each do |queue|
+    heroku[queue] = Autoscaler::HerokuScaler.new(
+      queue,
+      ENV['HEROKU_API_KEY'],
+      ENV['HEROKU_APP'])
+  end
+end
+
+Sidekiq.configure_client do |config|
+  if heroku
+    config.client_middleware do |chain|
+      chain.add Autoscaler::Sidekiq::Client, heroku
+    end
+  end
+end
+
+# define HEROKU_PROCESS in the Procfile:
+#
+#    default: env HEROKU_PROCESS=default bundle exec sidekiq -r ./background/boot.rb
+#    import:  env HEROKU_PROCESS=import bundle exec sidekiq -q import -c 1 -r ./background/boot.rb
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    if heroku && ENV['HEROKU_PROCESS'] && heroku[ENV['HEROKU_PROCESS']]
+      p "Setting up auto-scaledown"
+      chain.add(Autoscaler::Sidekiq::Server, heroku[ENV['HEROKU_PROCESS']], 60, [ENV['HEROKU_PROCESS']])
+    else
+      p "Not scaleable"
+    end
+  end
+end

data/examples/simple.rb

@@ -0,0 +1,28 @@
+require 'securerandom' # bug in Sidekiq as of 2.2.1
+require 'sidekiq'
+require 'autoscaler/sidekiq'
+require 'autoscaler/heroku_scaler'
+
+heroku = nil
+if ENV['HEROKU_APP']
+  heroku = Autoscaler::HerokuScaler.new
+end
+
+Sidekiq.configure_client do |config|
+  if heroku
+    config.client_middleware do |chain|
+      chain.add Autoscaler::Sidekiq::Client, 'default' => heroku
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    if heroku
+      p "Setting up auto-scaledown"
+      chain.add(Autoscaler::Sidekiq::Server, heroku, 60)
+    else
+      p "Not scaleable"
+    end
+  end
+end

data/lib/autoscaler/version.rb

@@ -1,4 +1,4 @@
 module Autoscaler
   # version number
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autoscaler
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-21 00:00:00.000000000 Z
+date: 2012-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -19,7 +19,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,7 +27,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: heroku-api
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,10 @@ files:
 - lib/autoscaler/sidekiq.rb
 - lib/autoscaler/version.rb
 - lib/autoscaler.rb
+- README.md
+- CHANGELOG.md
+- examples/complex.rb
+- examples/simple.rb
 - spec/autoscaler/heroku_scaler_spec.rb
 - spec/autoscaler/sidekiq_spec.rb
 - spec/spec_helper.rb