sonic 0.0.1 → 0.0.2

data/README.md

@@ -12,15 +12,63 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ rails g sonic
 
-Or install it yourself as:
+## Usage
 
-    $ gem install sonic
+Sonic is configured via a simple DSL. Service checks are added by
+updating the file in `config/intializers/sonic_config.rb`
 
-## Usage
+Currently three types of services can be checked, http, tcp, and amqp.
+
+Here's an example sonic_config.rb file
+
+```ruby
+module Sonic
+  checks = []
+
+  checks << Sonic.service_checker do
+    protocol :http
+    host 'myhttpserver'
+    port 80
+    path 'path/to/check'
+  end
+
+  checks << Sonic.service_checker do
+    protocol :amqp
+    host 'myrabbitmqserver'
+    port 5672
+  end
+
+  checks << Sonic.service_checker do
+    protocol :tcp
+    host 'mytcpserver'
+    port 12345
+    payload 'some command'
+  end
+
+  SONIC_CHECKS = checks
+end
+```
+
+Sonic also comes with a Clockwork clock file that can be executed that
+will check the configured services every 3 mintues. This file can be
+executed via your Procfile or whatever daemonizer your using. For
+example you could add this to your Profile
+
+    sonic_clock:  bundle exec clockwork lib/sonic_clock.rb
+
+## Rails Engine
+
+The service checks are published to a json file in your rails public
+folder at `public/sonic/results.json`. A very simple view is available
+that will let you see your results. Include the routes by adding the
+folowing to your `routes.rb` file
+
+    mount Sonic::Engine => "/sonic", :as => "sonic"
 
-TODO: Write usage instructions here
+You can then view the status of your services by visiting `sonic/` or
+`sonic/results.json`
 
 ## Contributing
 

data/lib/sonic/service_checker.rb

@@ -22,6 +22,8 @@ module Sonic
     end
 
     def check_service()
+      @response = nil
+      @error = nil
       case protocol
       when :http, :https
         http = Protocol::HTTP.new(self)

data/lib/sonic/version.rb

@@ -1,3 +1,3 @@
 module Sonic
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sonic
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-20 00:00:00.000000000 Z
+date: 2013-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails