servicemonitor 0.0.12 → 0.0.13

data/README.md

@@ -1,7 +1,18 @@
 #ServiceMonitor
 
-Monitor various parts of the system
+Monitor various parts of a system
 
 ##Principles
 	#This is aimed at people with computer knowledge
 	#The DSL should be clean to read, at the expense of a steeper learning curve
+    #Tell users what is wrong as precisley as possible, with possible remedy's
+
+##Get it
+    #gem install servicemonitor
+
+##Run it
+    #Have a look at the dsl's in the Example directory
+    #servicemonitor <path to dsl>
+
+##Notes
+    #Plays well with upstart and foreman

data/bin/servicemonitor

@@ -24,27 +24,30 @@ def log( string, verbose=false )
     end
 end
 
+
 if ARGV.length == 1 then
         dslName = ARGV[0]
 else
         abort( "Usage: monitor <path to dsl>" )
 end
 
+#Need to remove file name extension 
+ENV["APP_NAME"] = File.basename( dslName ) if ENV["APP_NAME"].nil?
 
 $a = MonitorManager.new
 
 log "Loading dsl, #{dslName}"
 begin
-load dslName
-$a.run
-rescue ArgumentError=>e
-    puts "*** Your dsl is not formatted correctly"
-    puts "*** Ensure each line has the format,"
-    puts "***   <command>, [:arg=>value]"
-rescue SystemExit=>e
-rescue SIGTERM=>e
-rescue Exception=>e
-    puts e.class.name
-    puts e.message
+    load dslName
+    $a.run
+    rescue ArgumentError=>e
+        puts "*** Your dsl is not formatted correctly"
+        puts "*** Ensure each line has the format,"
+        puts "***   <command>, [:arg=>value]"
+    rescue SystemExit=>e
+#    rescue SIGTERM=>e
+    rescue Exception=>e
+        puts e.class.name
+        puts e.message
 end
 

data/lib/Alert.rb

@@ -1,4 +1,4 @@
-
+#Base class / Interface for implementing alert types
 class Alert
     
 	def Send( destination, body )

data/lib/Alert/Email.rb

@@ -1,6 +1,8 @@
 require "net/smtp"
 require "Alert"
 
+#Email alert class
+#Uses localhost for sending email - Probably need to change this in the future.
 class Alert_Email
 	def initialize( destination, body )
 		@destination = destination
@@ -10,9 +12,9 @@ class Alert_Email
 	def Send
 
 message = <<MESSAGE_END
-From: Agrimetrics <girvine@lic.co.nz>
+From: #{ENV['APP_NAME']} <girvine@lic.co.nz>
 To: #{@destination}
-Subject: Agrimetrics Alert
+Subject: #{ENV['APP_NAME']} Alert
 
 #{@body}
 .

data/lib/MonitorManager.rb

@@ -8,6 +8,7 @@ class MonitorManager
         @list.push monitor
     end
     
+    #The main run loop
     def run
 		while true do
             @list.each do |m|
@@ -18,12 +19,12 @@ class MonitorManager
                     m.alert( e.message )
                 end
             end
-            sleep 0.5
+            sleep 0.2
 		end
         
         rescue Interrupt => e
         puts "Exiting on request ..."
-        
+
         rescue Exception => e
         puts e.class.name
         puts "*** This is really unexpected."

data/lib/MonitorType.rb

@@ -1,10 +1,23 @@
 require 'parse-cron'
 
+#This is provided for reporting purposes.
+# If this is raised on startup, the process will fail, and stop running.
+# If this is raised after startup, the process will report, but keep running.
+#
+#The idea is to provide clear direction to the user to fix the error, but
+# not stop all monitors in case of a production issue.
 class MonitorTypeExceptionHandled<StandardError
 end
 
+#Base class for Monitors
+#
+#Given that this is a DSL, it extracts named parameters from a hash in order to provide
+#more precise reporting of errors, without spewing syntax errors at a user
 class MonitorType
     
+    #Check that all required parameters have been passed in
+    #Make sure that any errors encountered are reported in a way that
+    # fixing the error is made easier
     def initialize( params )
         if params[:name].nil? then
             puts "*** Monitor parameter missing, name"
@@ -13,6 +26,22 @@ class MonitorType
         end
         @name = params[:name]
         @email = params[:email]
+        if !@email.nil? then
+            if params[:email_sender].nil? then
+                if ENV["EMAIL_SENDER"].nil? then
+                    puts "*** Alert parameter missing, email_sender"
+                    puts "*** An email recipient has been specified for monitor, #{@name}, but no email sender has been specified"
+                    puts "*** :email_sender => <email of sender>"
+                    puts "*** or, a catch all environment variable"
+                    puts "*** EMAIL_SENDER=<email of sender>"
+                    abort
+                else
+                    @admin_email = ENV["EMAIL_SENDER"]
+                end
+            else
+                @admin_email = params[:admin_email]
+            end
+        end
         
         cron_string = params[:cron] || "0 1 * * *"
         @cron = CronParser.new(cron_string)
@@ -21,14 +50,19 @@ class MonitorType
         log "Loaded Monitor, #{@name}."
     end
     
-    #Overload this method if any parameters should be checked
+    #Overload this method if any parameters should be checked in context
     def sanitise
     end
     
+    #Check if the monitor has tripped
     def process
         raise "Method needs to be overridden"
     end
     
+    #An extention of the main run loop.
+    #Each monitor is responsible for knowing when it should run, so this function
+    #is called pretty much continuosuly.
+    #
     def run
         if Time.now > @next then
             begin
@@ -37,18 +71,20 @@ class MonitorType
                 self.sanitise
                 self.process
                 rescue MonitorTypeExceptionHandled => e
-                m.alert( e.message )
+                self.alert( e.message )
             end
         end
     end
     
-    
+    #Called when a monitor has been tripped
+    #
+    # @param [String] string A description of the trip that occurred
 	def alert( string )
         body = "#{@name} tripped.\n#{string}"
         puts "*** "
 		if !@email.nil? then
 			Alert_Email.new( @email, body ).Send
-            puts "Emailed, @email, Body, #{body}"
+            puts "Emailed, #{@email}"
             else
             puts body
 		end

data/lib/MonitorType/Beanstalk.rb

@@ -1,15 +1,21 @@
 require "beanstalk-client"
 require "MonitorType/Threshold"
 
+#A Beanstalk class for checking how many msgs are in a Queue
 class MonitorType_Beanstalk<MonitorType_Threshold
-    
+
 	def sanitise
         @beanstalk = Beanstalk::Pool.new([@connection_string])
 	end
     
+    #Constructor: Extract parameters
+    #
+    # @param [String] beanstalk Optional connection string. Default to local
+    # @param [String] queue Name of queue to monitor
 	def initialize( params )
 		super( params )
         @connection_string = params[:beanstalk] || "localhost:11300"
+
         if params[:queue].nil? then
             puts "*** Beanstalk parameter missing, queue"
             puts "*** :queue => <queue name>"

data/lib/MonitorType/Dir.rb

@@ -1,5 +1,6 @@
 require "MonitorType/Threshold"
 
+#A directory class for checking how many files are in a directory
 class MonitorType_Dir<MonitorType_Threshold
     
 	def sanitise
@@ -22,6 +23,9 @@ class MonitorType_Dir<MonitorType_Threshold
         raise MonitorTypeExceptionHandled.new(string)
 	end
 
+    #Constructor: Extract parameters
+    #
+    # @param [String] path Path to directory to check
 	def initialize( params )
 		super( params )
         if params[:path].nil? then

data/lib/MonitorType/FluidDb.rb

@@ -1,8 +1,16 @@
 require "FluidDb"
 require "MonitorType/Threshold"
 
+#A database class for checking a single number against a threshold.
+# For example,
+#  get the max timestamp from a table as a date.
+#  subtract this from now
+#  => check that the number is not greater than 2
+
 class MonitorType_FluidDb<MonitorType_Threshold
     
+    #Create the connection to the db, and get the value
+    #This ensures that all params are correct.
 	def sanitise
         begin
             @fluidDb = FluidDb.Db( @uri )
@@ -13,7 +21,7 @@ class MonitorType_FluidDb<MonitorType_Threshold
             puts "*** Please fix the error and run again"
             abort()
         end
-        
+
         begin
         value = @fluidDb.queryForValue( @sql, [] )
         rescue Exception=>e
@@ -24,6 +32,10 @@ class MonitorType_FluidDb<MonitorType_Threshold
         end
 	end
     
+    #Constructor: Extract parameters
+    #
+    # @param [String] uri Connection string to db
+    # @param [String] sql SQL statement to gather a single value
 	def initialize( params )
 		super( params )
         if params[:uri].nil? then

data/lib/MonitorType/Threshold.rb

@@ -1,12 +1,15 @@
 
+#A base class for checking a number against a min and/or max value
 class MonitorType_Threshold<MonitorType
 
+    #See super method for generic description
 	def initialize( params )
         @min = params[:min] ||= 0
         @max = params[:max]
 		super( params )
 	end
 
+    #Provides the means to check a value against thresholds
 	def check( value, context_sentence )
         value = value.to_i
         if !@min.nil? && value < @min then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: servicemonitor
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-26 00:00:00.000000000 Z
+date: 2013-10-27 00:00:00.000000000 Z
 dependencies: []
 description: Monitor various parts of the system
 email: guy@guyirvine.com