what 0.2.7 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76f5b8ecf552ae3e9be47ddb3dac0bc0563a1fec
+  data.tar.gz: d09ff6b7677d83e629bab958b5d5c4802505714b
+SHA512:
+  metadata.gz: e2664f1e98896d28f1d5f55b2f28bf83ff781f3d1d2529ebbffe9c67048e2de981a6ef1bf8618d3431596a5614f6796f5019d95c84a21b1b521b2f7545bd0cfd
+  data.tar.gz: b471ae59e93c4d062f88aac1d5bfe8b59fc56e7e1c6c733bfd75c57e3003f7aa4aaa14cd4a201a8c2ff8fb2c821a207e9b84316f4f57edbffe719c4446bff169

data/Gemfile

@@ -1,4 +1,6 @@
 source "http://rubygems.org"
 
+gem "pry"
+
 # Specify your gem's dependencies in what.gemspec
 gemspec

data/Rakefile

@@ -1,2 +1,32 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+# Example session:
+# [1] pry(main)> mod = What::Modules::Disk.new({}, nil)
+# => #<Celluloid::ActorProxy(What::Modules::Disk:0x3fe77443812c) ... >
+# [2] pry(main)> mod.check
+# => {"size"=>"391Gi",
+#  "used"=>"251Gi",
+#  "avail"=>"139Gi",
+#  "use%"=>65,
+#  "warning%"=>90,
+#  "alert%"=>99,
+#  "regexp"=>"/$"}
+# [3] pry(main)> mod.status
+# => {"type"=>"disk",
+#  "health"=>"ok",
+#  "details"=>
+#   {"size"=>"391Gi",
+#    "used"=>"251Gi",
+#    "avail"=>"139Gi",
+#    "use%"=>65,
+#    "warning%"=>90,
+#    "alert%"=>99,
+#    "regexp"=>"/$"}}
+desc "Start a REPL with all Bunch modules loaded"
+task :repl do
+  require "pry"
+  require "what"
+  What::Modules.load_all
+  Pry.start
+end

data/example/modules/custom_module.rb

@@ -15,10 +15,10 @@ class What::Modules::CustomModule < What::Modules::Base
     @hellos = 1
   end
 
-  # The check! method is called every Config['interval'] seconds. It should
+  # The check method is called every Config['interval'] seconds. It should
   # collect whatever information is needed and put it into instance vars.
   # (optional)
-  def check!
+  def check
     @hellos = Kernel.rand(4) + 1
   end
 

data/lib/what/config.rb

@@ -1,6 +1,3 @@
-
-require 'yaml'
-
 module What
   class Config
     DEFAULTS = {

data/lib/what/helpers.rb

@@ -32,9 +32,5 @@ module What
       word.downcase!
       word
     end
-
-    def self.curl(uri)
-      yield(Excon.get(uri).body)
-    end
   end
 end

data/lib/what/modules/base.rb

@@ -1,33 +1,73 @@
 module What
   class Modules::Base
+    include Celluloid
 
     attr_reader :interval
 
-    def initialize(params={})
+    def initialize(params, output)
       defaults = (self.class)::DEFAULTS rescue {}
       @name = params['name']
       @config = defaults.merge(params['config'] || {})
       @max = params['max'] || 'alert'
-      # Use global interval setting if not set on a
-      # per module basis
       @interval = params['interval'] || Config['interval']
+      @output = output
+      @failures = 0
       initialize_module
     end
 
     def initialize_module
     end
 
+    def start_monitoring
+      @output[identifier] = nil
+
+      loop do
+        check
+        @output[identifier] = status
+        sleep interval
+      end
+    rescue Exception => e
+      # stop looping -- the Monitor will restart if necessary
+      @failures += 1
+      output = shared_status.merge(
+        "health" => "alert",
+        "error" => "#{e.class}: #{e.message}",
+        "failures" => @failures
+      )
+      puts "Error in module:\n#{YAML.dump(output)}"
+      @output[identifier] = output
+    end
+
     def name
       Helpers.underscore(self.class.name.split('::').last)
     end
 
-    def check!
+    # A unique identifier that we can use to match results up with this
+    # specific instance. This is necessary because Celluloid weirds identity.
+    def identifier
+      object_id
+    end
+
+    # This method should be overridden. The implementation here is for
+    # backwards compatibility with older modules that implement check!
+    # instead of check.
+    def check
+      check!
+    end
+
+    # This method must be overridden.
+    def health
+      raise "Module #{self.class.name} doesn't override 'health'"
+    end
+
+    # This method may be overridden, to provide extra details based on the
+    # results of the check.
+    def details
+      {}
     end
 
     def status
-      status = {}
-      status['name'] = @name if @name
-      status['type'] = name # FIXME
+      status = shared_status
       status['health'] = if @max == 'ok' || health == 'ok'
                            'ok'
                          elsif @max == 'warning' || health == 'warning'
@@ -39,12 +79,11 @@ module What
       status
     end
 
-    def health
-      raise "Module #{self.class.name} doesn't override 'health'"
-    end
-
-    def details
-      {}
+    def shared_status
+      status = {}
+      status['name'] = @name if @name
+      status['type'] = name # FIXME
+      status
     end
   end
 end

data/lib/what/modules/disk.rb

@@ -10,7 +10,7 @@ module What
       @regexp = Regexp.new(@config['regexp'])
     end
 
-    def check!
+    def check
       line = `df -h`.split("\n").grep(@regexp).first
       @info = if line
                 fields = line.split(/\s+/)

data/lib/what/modules/existence.rb

@@ -8,7 +8,7 @@ module What
       @paths = {}
     end
 
-    def check!
+    def check
       @config['paths'].each do |path|
         if Dir[path].count == 0
           @paths[path] = false

data/lib/what/modules/memory.rb

@@ -5,7 +5,7 @@ module What
       'alert'   => '90%'
     }
 
-    def check!
+    def check
       fields = self.memory_details
       @info = if fields.size == 2
                 {

data/lib/what/modules/process.rb

@@ -5,7 +5,7 @@ module What
       @processes = []
     end
 
-    def check!
+    def check
       @processes = `ps aux`.split("\n").grep(@regexp).map do |ln|
                      ln =~ /^\w+\s+(\d+).*(\d+:\d\d(?:\.\d\d)?) (.*)$/
                      {'pid' => $1, 'cpu_time' => $2, 'proctitle' => $3.strip}

data/lib/what/modules/unicorn.rb

@@ -9,7 +9,7 @@ module What
       @unicorns = []
     end
 
-    def check!
+    def check
       @unicorns = `ps aux`.split("\n").grep(/unicorn_rails worker/).map do |ln|
                     ln =~ /^\w+\s+(\d+).*(\d+:\d\d(?:\.\d\d)?) unicorn/
                     {'pid' => $1, 'cpu_time' => $2}

data/lib/what/modules/what.rb

@@ -8,9 +8,10 @@ module What
       @whats = {}
     end
 
-    def check!
+    def check
       @config.map do |name, uri|
-        Helpers.curl(uri) { |body| @whats[name] = JSON.parse(body) rescue nil }
+        body = open(uri).read
+        @whats[name] = JSON.parse(body) rescue nil
       end
     end
 

data/lib/what/modules.rb

@@ -1,58 +1,29 @@
-require 'what/config'
+require "what/config"
 
 module What
   module Modules
-
-    def self.default_modules_full_path
-      File.join(File.dirname(__FILE__), 'modules')
-    end
-
-    def self.config_module_full_paths
-      (Config['module_paths'] || []).map do |p|
-        if p.match(%r(^/))
-          p
-        else
-          File.join(Config['base'], p)
-        end
-      end
-    end
-
-    # load all modules defined in what/modules, in addition to any paths
-    # specified in the config file.
+    # Load all modules from any paths specified in the config file.
     def self.load_all
-      require 'what/modules/base'
-
-      require_dir(self.default_modules_full_path)
-
-      self.config_module_full_paths.each do |path|
+      config_module_full_paths.each do |path|
         require_dir(path)
       end
     end
 
-    def self.load_module(module_name)
-      require 'what/modules/base'
-
-      loaded = false
-
-      short_module_name = module_name.sub(/\.rb$/, '')
+    def self.config_module_full_paths
+      paths = Config["module_paths"] || []
 
-      ([self.default_modules_full_path] + self.config_module_full_paths).each do |path|
-        candidate = File.join(path, short_module_name)
-        if File.exists?("#{candidate}.rb")
-          loaded = require candidate
-        end
+      paths.map do |path|
+        path.include?("/") ? path : File.join(Config["base"], path)
       end
-
-      loaded
     end
 
-    private
-
     def self.require_dir(path)
       Dir[File.join(path, '*.rb')].each do |fn|
         require fn
       end
     end
-
   end
 end
+
+require "what/modules/base"
+What::Modules.require_dir File.expand_path("../modules", __FILE__)

data/lib/what/monitor.rb

@@ -1,57 +1,46 @@
-
-require 'what/modules'
-require 'what/helpers'
-
 module What
   class Monitor
-
-    # don't worry, these method names are ironic
-
-    def initialize(modules)
-      @modules = modules.map do |mod|
-        name = Helpers.camelize(mod.delete('type'))
-        Modules.const_get(name).new(mod)
-      end
-    end
-
+    # don't worry, this method name is ironic
     def go!
-      Thread.abort_on_exception = true
-      @threads = @modules.collect do |mod|
-        Thread.new do
-          loop do
-            mod.check!
-            Thread.current[:status] = mod.status
-            sleep mod.interval
-          end
-        end
+      # For now, use a hash as the centralized collection point for data. We
+      # can't use a method on the module because Celluloid will block that call
+      # until after whatever method is currently running, which could be
+      # unacceptably slow. We could use a fancy thread-safe data structure
+      # instead of a hash, but the GIL means hash assignment and reading are
+      # safe as long as we're on MRI.
+      @results = {}
+      @modules = Config['modules'].map do |config_hash|
+        name     = Helpers.camelize(config_hash.delete('type'))
+        klass    = Modules.const_get(name)
+        instance = klass.new(config_hash, @results)
+        {
+          class: klass,
+          config_hash: config_hash,
+          module: instance,
+          id: instance.identifier
+        }
       end
-    end
 
-    def do_it(interval)
-      loop do
-        statuses = []
-        healths = []
-        @threads.each do |th|
-          if th[:status]
-            healths << th[:status]['health']
-            statuses << th[:status]
-          end
-        end
-        yield Helpers.overall_health(healths), statuses
-        sleep interval
+      @modules.each do |mod|
+        mod[:module].async.start_monitoring
       end
     end
 
-    def self.go!
-      monitor = new Config['modules']
-      monitor.go!
-      Thread.new do 
-        monitor.do_it(Config['interval']) do |health, statuses|
-          Status['health'] = health
-          Status['details'] = statuses          
+    def status
+      statuses = []
+      healths = []
+
+      @modules.each do |mod|
+        status = @results[mod[:id]] || {"health" => nil}
+        healths << status['health']
+        statuses << status
+
+        if status["error"] && status["failures"] < 6
+          mod[:module].async.start_monitoring
         end
       end
-    end
 
+      {"health" => Helpers.overall_health(healths), "details" => statuses}
+    end
   end
 end

data/lib/what/server.rb

@@ -3,17 +3,19 @@ module What
     def initialize
       Modules.load_all
       Formatters.load_all
-      Monitor.go!
+      @monitor = Monitor.new
+      @monitor.go!
     end
 
     def call(env)
       if Config['secret_token'] && Config['secret_token'] != env['QUERY_STRING']
         [403, {'Content-Type' => 'text/plain'}, ["403 Forbidden\n"]]
       else
+        status = @monitor.status
         [
-          Status['health'] != 'alert' ? 200 : 503,
+          status['health'] != 'alert' ? 200 : 503,
           {'Content-Type' => Formatter.mime},
-          [Formatter.format(Status.all)]
+          [Formatter.format(status)]
         ]
       end
     end

data/lib/what/version.rb

@@ -1,3 +1,3 @@
 module What
-  VERSION = "0.2.7"
+  VERSION = "0.3.0"
 end

data/lib/what.rb

@@ -5,7 +5,8 @@ require 'json'
 require 'yaml'
 require 'webrick'
 require 'rack'
-require 'excon'
+require 'open-uri'
+require 'celluloid'
 
 require 'what/config'
 require 'what/formatter'
@@ -14,5 +15,4 @@ require 'what/helpers'
 require 'what/modules'
 require 'what/monitor'
 require 'what/server'
-require 'what/status'
 require 'what/version'

data/what.gemspec

@@ -24,6 +24,6 @@ EOS
   s.require_paths = ["lib"]
 
   s.add_dependency("rack", ">= 1.1.2")
-  s.add_dependency("excon", "~> 0.13.4")
   s.add_dependency("json")
+  s.add_dependency("celluloid")
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: what
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Ryan Fitzgerald
@@ -11,73 +10,61 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-11 00:00:00.000000000 Z
+date: 2013-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.2
-    none: false
-  name: rack
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.2
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: json
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.13.4
-    none: false
-  name: excon
+        version: '0'
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.13.4
-    none: false
+        version: '0'
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: json
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-description: ! 'What uses WEBrick to serve a JSON object representing the state of
-  services
-
+description: |
+  What uses WEBrick to serve a JSON object representing the state of services
   running on a machine. It currently includes modules for monitoring Unicorn
-
   workers, checking for the existence of files and processes, and combining
-
   the output of other What servers.
-
-'
 email:
 - rwfitzge@gmail.com
 - rpjlower@gmail.com
 - colin.t.curtin@gmail.com
 executables:
 - what
-- whatch
 - whatsup
 extensions: []
 extra_rdoc_files: []
@@ -88,12 +75,10 @@ files:
 - README.md
 - Rakefile
 - bin/what
-- bin/whatch
 - bin/whatsup
 - example/modules/custom_module.rb
 - example/what.yml
 - lib/what.rb
-- lib/what/ch.rb
 - lib/what/config.rb
 - lib/what/formatter.rb
 - lib/what/formatters.rb
@@ -111,32 +96,30 @@ files:
 - lib/what/modules/what.rb
 - lib/what/monitor.rb
 - lib/what/server.rb
-- lib/what/status.rb
 - lib/what/sup.rb
 - lib/what/version.rb
 - what.gemspec
 homepage: http://academia.edu/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: what
-rubygems_version: 1.8.24
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple server monitoring tool
 test_files: []

data/bin/whatch

@@ -1,39 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-require 'optparse'
-require 'what/version'
-require 'what/ch'
-
-options = Struct.new(:interval, :all).new
-
-opts = OptionParser.new do |opts|
-  opts.banner = "Usage: what [options] module_name1 [ module_name2 ... ]"
-  opts.separator ""
-
-  opts.on_tail('-v', '--version', 'Show the version number.') do
-    puts What::VERSION
-    exit
-  end
-
-  opts.on_tail('-h', '--help', 'Show this message.') do
-    puts opts
-    exit
-  end
-
-  opts.on('-c', '--config FILE', 'Specify the location of the YAML config file.') do |fn|
-    What::Config.load(fn)
-  end
-
-  opts.on('-n', '--interval SECS', 'Run module check every SECS seconds.') do |secs|
-    options.interval = secs
-  end
-
-  opts.on_tail('-a', '--all', 'Load all modules specified in config option (which must be present too).') do
-    options.all = true
-  end
-
-end
-opts.parse!(ARGV)
-
-What::Ch.run(ARGV, options)

data/lib/what/ch.rb

@@ -1,65 +0,0 @@
-## Impletments the whatsch CLI for running modules from the command line
-
-require 'what/config'
-require 'what/modules'
-require 'what/monitor'
-
-module What
-  class Ch
-
-    def self.run(module_names, opts)
-      new(module_names, opts).run
-    end
-
-    def initialize(module_names, opts)
-      if opts.all && !Config.loaded?
-        self.error "Use all: No config given to read for module names"
-      end
-
-      if 0 == module_names.size && !opts.all
-        self.error "No module names given"
-      end
-
-      @modules = if What::Config.loaded?
-                   if opts.all
-                     What::Config['modules']
-                   else
-                     What::Config['modules'].select{|m| module_names.include?(m['name'])}
-                   end          
-                 else
-                   What::Config.set_defaults
-                   module_names.uniq.map{|mn| {'type' => mn, 'name' => mn} }
-                 end
-      
-      if 0 == @modules.size
-        self.error "No modules to use"
-      end      
-
-      @interval = (opts.interval || 10).to_i
-    end
-
-    def run
-      @modules.each do |m|
-        unless Modules.load_module(m['type'])
-          self.error("Unknown module #{m['type']}")
-        end
-      end
-      @monitor = Monitor.new(@modules)
-      @monitor.go!
-      @monitor.do_it(@interval) do |health, statuses|
-        self.report health, statuses
-      end
-    end
-
-    def report(health, statuses)
-      $stdout.puts health
-      $stdout.puts statuses.inspect
-    end
-
-    def error(message)
-      $stderr.puts message
-      exit(1)
-    end
-
-  end
-end

data/lib/what/status.rb

@@ -1,17 +0,0 @@
-module What
-  class Status
-    @status = {}
-
-    def self.[](attr)
-      @status[attr]
-    end
-
-    def self.[]=(attr, val)
-      @status[attr] = val
-    end
-
-    def self.all
-      @status
-    end
-  end
-end