alicorn 0.2.2 → 0.3.0

data/README.rdoc

@@ -1,8 +1,30 @@
-= alicorn
+= Alicorn: Auto-scaler for Unicorn webserver
 
-An experimental auto-scaler for Eric Wong's {unicorn}[http://unicorn.bogomips.org] webserver.
+An experimental auto-scaler for Eric Wong's {Unicorn}[http://unicorn.bogomips.org] 
+webserver. Designed for Unicorn webservers running with the {Raindrops}[raindrops.bogomips.org]
+middleware enabled. It depends on the "active" and "queued" fields reported by
+Raindrops, and so only works on Linux.
 
-== Contributing to alicorn
+== Usage
+
+Alicorn ships with two executables, alicorn and alicorn-profiler.
+
+alicorn: this is the main command-line utility: run alicorn --help to see the 
+list of options and learn how to configure it. 
+
+alicorn-profiler: this is a tool to help determine useful parameters for alicorn.
+it's recommended that you run alicorn in dry-run and verbose mode for awhile, 
+collect the resulting logs, and feed those through alicorn-profiler to get a 
+handle on what settings you'll need. Same story, run alicorn-profiler --help to
+figure out what the options are and how you can tweak them.
+
+== Versioning
+
+Alicorn attempts to follow the {Semantic Versioning Specification}[semver.org].
+Every release in the 0.x series should be considered a DEVELOPMENT version. 
+The public API should not be considered stable.
+
+== Contributing
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -12,8 +34,14 @@ An experimental auto-scaler for Eric Wong's {unicorn}[http://unicorn.bogomips.or
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+== Credits
+
+Alicorn is maintained by {Ben Somers}[http://github.com/bensomers] and is 
+funded by {Rafter}[http://www.rafter.com]. Huge thanks to Eric 
+Wong and the rest of the {Unicorn}[http://unicorn.bogomips.org] and 
+{Raindrops}[http://raindrops.bogomips.org] contributors.
+
 == Copyright
 
 Copyright (c) 2012 Ben Somers. See LICENSE.txt for
 further details.
-

data/alicorn.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = "alicorn"
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Somers"]
-  s.date = "2012-05-22"
+  s.date = "2012-05-29"
   s.description = "Highly configurable dumb auto-scaler for managing unicorn web servers"
   s.email = "somers.ben@gmail.com"
-  s.executables = ["alicorn", "alicorn_profiler"]
+  s.executables = ["alicorn", "alicorn-profiler"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -26,9 +26,11 @@ Gem::Specification.new do |s|
     "Rakefile",
     "alicorn.gemspec",
     "bin/alicorn",
-    "bin/alicorn_profiler",
+    "bin/alicorn-profiler",
+    "example/config.yml",
     "lib/alicorn.rb",
     "lib/alicorn/dataset.rb",
+    "lib/alicorn/errors.rb",
     "lib/alicorn/log_parser.rb",
     "lib/alicorn/profiler.rb",
     "lib/alicorn/scaler.rb",

data/bin/alicorn

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 $:.push File.join(File.dirname(__FILE__),'..','lib')
+require 'yaml'
 require 'optparse'
 require 'alicorn'
 
@@ -56,6 +57,10 @@ data sets. \n\nUsage: alicorn [options]"
     options[:log_path] = v
   end
 
+  opts.on("-c", "--config PATH", String, "path for stored options - write a yaml file containing all options") do |v|
+    options[:config_path] = v
+  end
+
   opts.on("-v", "--[no-]verbose", "turn on to write profiling info") do
     options[:verbose] = true
   end
@@ -65,6 +70,14 @@ data sets. \n\nUsage: alicorn [options]"
   end
 
 end.parse!
+
+if options[:config_path]
+  options = YAML.load_file(File.open(options[:config_path]))
+  # I prefer symbol keys, but nobody ever writes yamls with symbol keys, so convert them
+  options = options.inject({}) { |memo, pair| memo.store(pair.first.to_sym, pair.last); memo }
+end
+
 raise OptionParser::MissingArgument.new("--max-workers is a mandatory argument") unless options[:max_workers]
 
+
 Alicorn::Scaler.new(options).scale

data/example/config.yml

@@ -0,0 +1,11 @@
+:min_workers: 2
+:max_workers: 25
+:buffer: 2
+:target_ratio: 1.3
+:url: localhost/_raindrops
+:sample_count: 30
+:delay: 0.5
+:app_name: unicorn
+:log_path: test.log
+:verbose: false
+:dry_run: true

data/lib/alicorn/errors.rb

@@ -0,0 +1,6 @@
+module Alicorn
+  class AlicornError < StandardError; end
+  class NoUnicornsError < AlicornError; end
+  class NoMasterError < AlicornError; end
+  class AmbiguousMasterError < AlicornError; end
+end

data/lib/alicorn/scaler.rb

@@ -1,6 +1,7 @@
 require 'curl'
 require 'logger'
 require 'alicorn/dataset'
+require 'alicorn/errors'
 
 module Alicorn
   class Scaler
@@ -40,9 +41,9 @@ module Alicorn
           sleep(signal_delay) # Make sure unicorn doesn't discard repeated signals
         end
       end
-    rescue Exception => e
+    rescue StandardError => e
       logger.error "exception occurred: #{e.class}\n\n#{e.message}"
-      raise e
+      raise e unless e.is_a?(AmbiguousMasterError) # AmbiguousMasters are fine, usually just indicate a restart
     end
 
     def auto_scale(data, worker_count)
@@ -106,11 +107,11 @@ module Alicorn
     def find_master_pid(unicorns)
       master_lines = unicorns.select { |line| line.match /master/ }
       if master_lines.size == 0
-        raise "No unicorn master processes detected. You may still be starting up."
+        raise NoMasterError.new("No unicorn master processes detected. You may still be starting up.")
       elsif master_lines.size > 1
-        raise "Too many unicorn master processes detected. You may be restarting, or have an app name collision: #{master_lines}"
+        raise AmbiguousMasterError.new("Too many unicorn master processes detected. You may be restarting, or have an app name collision: #{master_lines}")
       elsif master_lines.first.match /\(old\)/
-        raise "Old master process detected. You may be restarting: #{master_lines.first}"
+        raise AmbiguousMasterError.new("Old master process detected. You may be restarting: #{master_lines.first}")
       else
         master_lines.first.split.first.to_i
       end
@@ -123,7 +124,7 @@ module Alicorn
     def find_unicorns
       ptable = grep_process_list.split("\n")
       unicorns = ptable.select { |line| line.match(/unicorn/) && line.match(/#{Regexp.escape(app_name)}/) }
-      raise "Could not find any unicorn processes" if unicorns.empty?
+      raise NoUnicornsError.new("Could not find any unicorn processes") if unicorns.empty?
 
       unicorns.map(&:strip)
     end

data/lib/alicorn/version.rb

@@ -1,3 +1,3 @@
 module Alicorn
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/test/test_scaler.rb

@@ -26,7 +26,7 @@ class TestScaler < Test::Unit::TestCase
       end
 
       should "raise an error" do
-        exception = assert_raise(RuntimeError) do
+        exception = assert_raise(Alicorn::NoUnicornsError) do
           @scaler.scale
         end
         assert_equal "Could not find any unicorn processes", exception.message
@@ -41,7 +41,7 @@ class TestScaler < Test::Unit::TestCase
       end
 
       should "raise an error" do
-        exception = assert_raise(RuntimeError) do
+        exception = assert_raise(Alicorn::NoMasterError) do
           @scaler.scale
         end
         assert_match /No unicorn master processes/, exception.message
@@ -55,11 +55,9 @@ class TestScaler < Test::Unit::TestCase
         @scaler.stubs(:grep_process_list).returns(plist)
       end
 
-      should "raise an error" do
-        exception = assert_raise(RuntimeError) do
-          @scaler.scale
-        end
-        assert_match /Too many unicorn master processes/, exception.message
+      should "die quietly" do
+        @scaler.expects(:auto_scale).never
+        @scaler.scale
       end
     end
 
@@ -70,11 +68,9 @@ class TestScaler < Test::Unit::TestCase
         @scaler.stubs(:grep_process_list).returns(plist)
       end
 
-      should "raise an error" do
-        exception = assert_raise(RuntimeError) do
-          @scaler.scale
-        end
-        assert_match /Old master process detected/, exception.message
+      should "die quietly" do
+        @scaler.expects(:auto_scale).never
+        @scaler.scale
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alicorn
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-23 00:00:00.000000000 Z
+date: 2012-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
-  requirement: &70109358372400 !ruby/object:Gem::Requirement
+  requirement: &70222522833040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70109358372400
+  version_requirements: *70222522833040
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70109358371920 !ruby/object:Gem::Requirement
+  requirement: &70222522832560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.1
   type: :development
   prerelease: false
-  version_requirements: *70109358371920
+  version_requirements: *70222522832560
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70109358371440 !ruby/object:Gem::Requirement
+  requirement: &70222522832080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70109358371440
+  version_requirements: *70222522832080
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70109358370960 !ruby/object:Gem::Requirement
+  requirement: &70222522831600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *70109358370960
+  version_requirements: *70222522831600
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70109358370480 !ruby/object:Gem::Requirement
+  requirement: &70222522831120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70109358370480
+  version_requirements: *70222522831120
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70109358369960 !ruby/object:Gem::Requirement
+  requirement: &70222522830640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.11.4
   type: :development
   prerelease: false
-  version_requirements: *70109358369960
+  version_requirements: *70222522830640
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70109358369460 !ruby/object:Gem::Requirement
+  requirement: &70222522830160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,12 +87,12 @@ dependencies:
         version: 0.6.4
   type: :development
   prerelease: false
-  version_requirements: *70109358369460
+  version_requirements: *70222522830160
 description: Highly configurable dumb auto-scaler for managing unicorn web servers
 email: somers.ben@gmail.com
 executables:
 - alicorn
-- alicorn_profiler
+- alicorn-profiler
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
@@ -106,9 +106,11 @@ files:
 - Rakefile
 - alicorn.gemspec
 - bin/alicorn
-- bin/alicorn_profiler
+- bin/alicorn-profiler
+- example/config.yml
 - lib/alicorn.rb
 - lib/alicorn/dataset.rb
+- lib/alicorn/errors.rb
 - lib/alicorn/log_parser.rb
 - lib/alicorn/profiler.rb
 - lib/alicorn/scaler.rb
@@ -133,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3046697900382344279
+      hash: -82603868672489802
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: