quietus 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3a5cc3af003537f8103ca7f78e41d5a38fdec69
-  data.tar.gz: 9e34862bc1838775b621a9d909c220a9a7f0379d
+  metadata.gz: 6d8410205dbca9178b2609a1a76788fdab743cba
+  data.tar.gz: fd7fa1a795b0eeff504db7dc6ef8f7f40b2c641f
 SHA512:
-  metadata.gz: 8f91b27aed0aa89614aec2a1c2ebb601695612bb698b541c56a7ae244b3593d7ca485e3b36451affb865fa7dbe71660e25577ff0a58a8ace575ff96e4e3d7793
-  data.tar.gz: 9661023616de348ab98c430dac8e2f1bd0427cf69d0f07c8a866a0ca1846a3ac20e5c0c94c917fea119eb5ae2d576e8079d9b71c9a5fb67e79d53d8dc11c7976
+  metadata.gz: 78dc5a4bd4def6ea16a223bf42328eea730e796f9bce5cd7a59e3f27730b9ca9ed8f68a7c73ed335a3637a93f32046a4189887c2c452968084d5c179d7af1085
+  data.tar.gz: 4a94d9417bc062b259cc391934bd4a4f71207e7cc34b37098d4d1cf719927481a2d16dcb2a062aa4d416f3f554e28643a050576e348b99e29a8c075d982b7d5c

data/README.md

@@ -7,17 +7,25 @@ Simple status check web server.
 
 ##Why
 
-You might want to use this to provide a status check to an AWS ELB where you don't have a web server in your app. Having a status check lets you quietly kill unhealthy instances and replace them. 
+You might want to use this to provide a status check to an AWS ELB where you don't have a web server in your app. Having a status check lets you quietly kill unhealthy instances and replace them.
 
-See these [AWS Docs](http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-maintain-instance-levels.html).
+See these AWS Docs
+- [Maintainging instance levels](http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-maintain-instance-levels.html)
+- [Health check API](http://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_HealthCheck.html)
+- [Configure the Health state of an instance](http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-configure-healthcheck.html)
 
 ##Usage
 
+###Passive (TCP Server only)
+
+This setup requires you to have an ELB setup monitoring the specified port for a
+TCP response.
+
 ```rb
 require 'quietus'
 
-optional_hostname = 'localhost'
-optional_port     = '2347'
+hostname = 'localhost'
+port     = '2347'
 
 # quietus runs your check in a loop, so you might want to sleep
 def your_status_check
@@ -27,10 +35,40 @@ end
 
 # quietus is blocking so you might want to run it in a thread or fork depending on your Ruby version
 t = Thread.new do
-  Quietus::Server.new(optional_hostname, optional_port) { your_status_check }
+  Quietus::PassiveServer.new(optional_hostname, optional_port) { your_status_check }
 end
 ```
 
-**The Quietus server will return a 200 if your_status_check is truthy, 500 otherwise**
+**The Passive Quietus server will accept a TCP connection if your_status_check is truthy, otherwise it will refuse**
 
 By default quietus runs on port 2347.
+
+###Active (uses AWS SDK to contact Health Check API)
+
+This setup will actively contact AWS to update instance health. Use this if you
+don't want an ELB.
+
+```rb
+require 'quietus'
+require 'aws-sdk'
+
+# You'll need to get an auto_scaling_instance from the API
+auto_scaling = AWS::AutoScaling.new
+auto_scaling_instance = auto_scaling.instances['i-12345678']
+
+# quietus runs your check in a loop, so you might want to sleep
+def your_status_check
+  sleep 1
+  is_my_app_healthy?
+end
+
+# quietus is blocking so you might want to run it in a thread or fork depending on your Ruby version
+t = Thread.new do
+  Quietus::ActiveServer.new(auto_scaling_instance) { your_status_check }
+end
+```
+
+**It's important to remember if your app simply crashes, using the active setup
+the health check API won't get updated.**
+
+

data/lib/quietus/active_server.rb

@@ -0,0 +1,29 @@
+module Quietus
+  class ActiveServer
+    attr_reader :instance_id, :respect_grace_period, :status
+
+    def initialize(auto_scaling_instance, respect_grace_period = true)
+      @respect_grace_period  = respect_grace_period
+      @auto_scaling_instance = auto_scaling_instance
+
+      server &Proc.new
+    end
+
+    private
+
+    def server(&proc)
+      loop do
+        new_status = proc.call
+        update new_status if new_status != status
+      end
+    end
+
+    def update(status)
+      @auto_scaling_instance.set_health(
+        status ? 'Healthy' : 'Unhealthy',
+        :should_respect_grace_period => respect_grace_period
+      )
+    end
+  end
+end
+

data/lib/quietus/passive_server.rb

@@ -0,0 +1,28 @@
+require "socket"
+
+module Quietus
+  class PassiveServer
+    attr_reader :port, :hostname
+
+    DEFAULT_HOSTNAME = 'localhost'
+    DEFAULT_PORT     = 2347
+
+    def initialize(hostname = nil, port = nil)
+      @hostname   = hostname || DEFAULT_HOSTNAME
+      @port       = port     || DEFAULT_PORT
+
+      server &Proc.new
+    end
+
+    private
+
+    def server(&proc)
+      loop { respond if proc.call }
+    end
+
+    def respond
+      TCPServer.open(hostname, port) { |s| s.accept.close }
+    end
+  end
+end
+

data/lib/quietus/version.rb

@@ -1,3 +1,3 @@
 module Quietus
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/quietus.rb

@@ -1,26 +1,9 @@
 require "quietus/version"
-require "socket"
 
-module Quietus
-  class Server
-    attr_reader :port, :hostname
-
-    def initialize(hostname = 'localhost', port = 2347)
-      @hostname   = hostname
-      @port       = port
-
-      server &Proc.new
-    end
+require "quietus/active_server"
+require "quietus/passive_server"
 
-    private
-
-    def server(&proc)
-      loop { respond if proc.call }
-    end
-
-    def respond
-      TCPServer.open(hostname, port) { |s| s.accept.close }
-    end
-  end
+module Quietus
+  # Space left deliberatly blank
 end
 

data/spec/active_server_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Quietus::ActiveServer do
+  context "creating" do
+    context "passed a truthy block" do
+      it "updates instance health to 'Healthy'" do
+        aws_instance = double('instance')
+        aws_instance.should_receive(:set_health).with(
+          'Healthy',
+          {
+            :should_respect_grace_period => true
+          }
+        ).and_raise RspecLoopStop
+
+        begin
+          Quietus::ActiveServer.new(aws_instance) { true }
+        rescue RspecLoopStop
+          # Done
+        end
+      end
+    end
+
+    context "passed a falsy block" do
+      it "updates instance health to 'Unhealthy'" do
+        aws_instance = double('instance')
+        aws_instance.should_receive(:set_health).with(
+          'Unhealthy',
+          {
+            :should_respect_grace_period => true
+          }
+        ).and_raise RspecLoopStop
+
+        begin
+          Quietus::ActiveServer.new(aws_instance) { false }
+        rescue RspecLoopStop
+          # Done
+        end
+      end
+    end
+  end
+end
+

data/spec/{quietus_spec.rb → passive_server_spec.rb}

@@ -1,14 +1,14 @@
 require 'spec_helper'
 require 'socket'
 
-describe Quietus::Server do
+describe Quietus::PassiveServer do
   context "creating" do
 
     context "passed a falsy block" do
       it "refuses a TCP connection" do
         pid = fork do
           Signal.trap("HUP") { exit }
-          Quietus::Server.new { false }
+          Quietus::PassiveServer.new { false }
         end
 
         sleep 1
@@ -24,7 +24,7 @@ describe Quietus::Server do
       it "allows a TCP connection" do
         pid = fork do
           Signal.trap("HUP") { exit }
-          Quietus::Server.new { true }
+          Quietus::PassiveServer.new { true }
         end
 
         sleep 1
@@ -38,3 +38,4 @@ describe Quietus::Server do
 
   end
 end
+

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 $: << File.join(File.dirname(__FILE__), '..', 'lib')
 
+class RspecLoopStop < Exception; end
+
 require 'pry'
 require 'quietus'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quietus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Robert Kenny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-24 00:00:00.000000000 Z
+date: 2014-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,9 +80,12 @@ files:
 - README.md
 - Rakefile
 - lib/quietus.rb
+- lib/quietus/active_server.rb
+- lib/quietus/passive_server.rb
 - lib/quietus/version.rb
 - quietus.gemspec
-- spec/quietus_spec.rb
+- spec/active_server_spec.rb
+- spec/passive_server_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/kenoir/quietus
 licenses: