what 0.0.3 → 0.0.4

data/README.md

@@ -0,0 +1,24 @@
+What? A simple server monitoring tool.
+======================================
+
+What is still in the early stages of development.
+
+Right now, the example config file monitors Unicorn workers. Observe:
+
+    $ what -c example/what.yml >/dev/null 2>&1 &
+    [1] 2392
+    $ curl localhost:9428
+    {"unicorn":{"details":[{"cpu_time":"0:00.02","pid":"11023"},{"cpu_time":"0:00.02","pid":"11022"}],"health":"ok","workers":2},"health":"ok"}
+    $ sudo /etc/init.d/unicorn stop
+    $ curl localhost:9428
+    {"unicorn":{"details":[],"health":"alert","workers":0},"health":"alert"}
+
+When the health value of any module is set to "alert" instead of "ok",
+the HTTP request returns 503 instead of 200. This means What can easily
+be used in conjunction with monitoring tools like Pingdom.
+
+Writing monitoring modules is easy: the only requirement is that they
+implement a `health` method, which returns `:ok`, `:warning`, or `:alert`.
+They can also implement a `details` method, which returns the hash
+that's included in the HTTP response. See the included `What::Modules::Base`
+and `What::Modules::Unicorn` classes for the implementation details.

data/example/what.yml

@@ -10,17 +10,13 @@ interval: 10
 ### List all modules to be monitored.
 modules:
 - unicorn
-# - ram
-# - redis
-# - dir
-# - whatever
 
 ### Pass parameters into modules.
-# module_config:
-#   ram:
-#     min: nil
-#   dir:
-#     path: '/mnt/datastore'
+module_config:
+  unicorn:
+    # minimum number of workers before warning and alert statuses
+    warning: 1
+    alert: 0
 
 ### Specify any other config files to load.
 # configs:

data/lib/what/modules/base.rb

@@ -1,6 +1,6 @@
 class What::Modules::Base
   def initialize
-    @config = What::Config[self.name]
+    @config = What::Config['module_config'] && What::Config['module_config'][self.name]
   end
 
   def name
@@ -8,7 +8,6 @@ class What::Modules::Base
   end
 
   def check!
-    raise "Module #{self.class.name} doesn't override 'check!'"
   end
 
   def status
@@ -23,4 +22,3 @@ class What::Modules::Base
     {}
   end
 end
-

data/lib/what/modules/unicorn.rb

@@ -9,8 +9,10 @@ class What::Modules::Unicorn < What::Modules::Base
   end
 
   def health
-    if @unicorns.count > 0
+    if @unicorns.count > @config['warning']
       :ok
+    elsif @unicorns.count > @config['alert']
+      :warning
     else
       :alert
     end

data/lib/what/monitor.rb

@@ -1,4 +1,5 @@
 class What::Monitor
+  # don't worry, these method names are ironic
   def self.go!
     @modules = What::Config['modules'].map do |m|
       name = What::Helpers.camelize(m)

data/lib/what/version.rb

@@ -1,3 +1,3 @@
 module What
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: what
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
-  version: 0.0.3
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Ryan Lower
@@ -22,6 +27,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -33,6 +41,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -51,6 +62,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - bin/what
 - example/what.yml
@@ -79,17 +91,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: what
-rubygems_version: 1.5.2
+rubygems_version: 1.5.1
 signing_key: 
 specification_version: 3
 summary: Modular server monitoring with JSON endpoint