Heroku Resque Autoscaler

Build Status Code Climate

Uses Resque Job Hooks and the Heroku API gem to autoscale Heroku Resque workers

Inspired by @darkhelmet's Auto-scale Your Resque Workers On Heroku

Current Version

0.1.2

Requirements

Installation

Gemfile

Add this line to your application's Gemfile:

gem 'heroku_resque_autoscaler'

Manual

Or install it yourself:

gem install heroku_resque_autoscaler

Usage

Set defaults in an initializer, defaults are shown:

HerokuResqueAutoscaler.configure do |config|
  config.heroku_api_key  = ENV["HEROKU_API_KEY"]
  config.heroku_app_name = ENV["HEROKU_APP_NAME"]
end

Export you environment variables wherever you do that:

export HEROKU_API_KEY=heroku_api_key
export HEROKU_APP_NAME=heroku_app_name

Your Resque workers should extend HerokuResqueAutoscaler:

class AutoscaledJob
  extend HerokuResqueAutoscaler

  def self.perform
    # Do something
  end
end

You can optionally configure a maximum number of workers to scale up to in your configuration block.

HerokuResqueAutoscaler.configure do |config|
  config.max_resque_workers  = ENV["MAX_RESQUE_WORKERS"] 
end

Authors

Contributing

  1. Fork it
  2. Get it running
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Write your code and specs
  5. Commit your changes (git commit -am 'Add some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

If you find bugs, have feature requests or questions, please file an issue.

Specs

rspec spec

Coverage

rspec spec
open coverage/index.html

Releases

vi lib/heroku_resque_autoscaler/version.rb # change version
vi README.md # change version
rake release

License

Copyright (c) 2012 G5

MIT License

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.