servicemonitor 0.0.16 → 0.0.18

data/LICENSE

@@ -7,7 +7,7 @@ Foundation (FSF), version {3.0}[http://www.gnu.org/licenses/gpl-3.0.txt]
 or version {2.0}[http://www.gnu.org/licenses/gpl-2.0.txt]
 or the Ruby-specific license terms (see below).
 
-The rservicebus project leader (Guy Irvine) reserves the right to add future
+The ServiceMonitor project leader (Guy Irvine) reserves the right to add future
 versions of the GPL (and no other licenses) as published by the FSF to
 the licensing terms.
 

data/bin/servicemonitor

@@ -11,20 +11,14 @@ require "MonitorType/Threshold"
 require "MonitorType/Beanstalk"
 require "MonitorType/Dir"
 require "MonitorType/FluidDb"
+require "MonitorType/Process"
 require "MonitorManager"
+require "helper_functions"
+
 
 #Don't buffer stdout
 $stdout.sync = true
 
-def log( string, verbose=false )
-    type = verbose ? "VERB" : "INFO"
-	if !ENV["VERBOSE"].nil? || verbose==false then
-        timestamp = Time.new.strftime( "%Y-%m-%d %H:%M:%S" )
-        puts "[#{type}] #{timestamp} :: #{string}"
-    end
-end
-
-
 if ARGV.length == 1 then
         dslName = ARGV[0]
 else
@@ -47,7 +41,7 @@ begin
     rescue SystemExit=>e
 #    rescue SIGTERM=>e
     rescue Exception=>e
+puts "What the ..."
         puts e.class.name
         puts e.message
 end
-

data/lib/Alert/Email.rb

@@ -7,6 +7,9 @@ class Alert_Email
 	def initialize( sender, destination, body )
 		@sender = sender
 		@body = body
+
+		@smtp_address = ENV['smtp_address'].nil? ? 'localhost' : ENV['smtp_address']
+        	@smtp_port = ENV['smtp_port'].nil? ? 25 : ENV['smtp_port']
         
         if destination.is_a? Array then
             @destination = "<#{destination.join( ">,<" )}>"
@@ -25,15 +28,16 @@ Subject: #{ENV['APP_NAME']} Alert
 .
 MESSAGE_END
 
-Net::SMTP.start('localhost') do |smtp|
+Net::SMTP.start(@smtp_address,@smtp_port) do |smtp|
   smtp.send_message message, @sender,
                              @destination
 end
 
 rescue Errno::ECONNREFUSED => e
-    puts "*** Conection refused while attempting to connect to SMTP server"
-    puts "*** Recipient, #{@destination}. Body,"
-    puts "*** #{@body}"
+    string = "*** Conection refused while attempting to connect to SMTP server\n"
+    string = "#{string}*** Recipient, #{@destination}. Body,\n"
+    string = "#{string}*** #{@body}\n"
+    puts string
 	end
 end
 

data/lib/MonitorManager.rb

@@ -13,7 +13,6 @@ class MonitorManager
 		while true do
             @list.each do |m|
                 begin
-                    m.sanitise
                     m.run
                     rescue MonitorTypeExceptionHandled => e
                     m.alert( e.message )
@@ -23,14 +22,15 @@ class MonitorManager
 		end
         
         rescue Interrupt => e
-        puts "Exiting on request ..."
+        string = "Exiting on request ...\n"
+        puts string
 
         rescue Exception => e
-        puts e.class.name
-        puts "*** This is really unexpected."
-        messageLoop = false
-        puts "Message: " + e.message
-        puts e.backtrace
+        string = "#{e.class.name}\n"
+        string = "#{string}*** This is really unexpected.\n"
+        string = "#{string}Message: #{e.message}\n"
+        string = "#{string}e.backtrace\n"
+        puts string
     end
 end
 

data/lib/MonitorType.rb

@@ -1,66 +1,86 @@
 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.
+# It essentially indicates if an error case was expected
 #
 #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
 
+class MonitorTypeParameterMissingError<MonitorTypeExceptionHandled
+end
+
+class MonitorTypeMustHaveNameError<MonitorTypeParameterMissingError
+end
+
+class MonitorTypeMustHaveSenderEmailAddressForEmailAlertError<MonitorTypeParameterMissingError
+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"
-            puts "*** :name => <name of monitor>"
-            abort
+            string = "*** Monitor parameter missing, name"
+            string = "#{string}*** :name => <name of monitor>"
+            raise MonitorTypeMustHaveNameError.new(string)
         end
         @params = params
         @block = params[:block] if !params[:block].nil?
         @name = params[:name]
         @email = params[:email]
         if !@email.nil? then
+            #Sender email address from ENV allows for a single sender across all alerts
+            #Checking params before ENV allows a particular entry to be different
             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
+                    string = "*** Alert parameter missing, email_sender"
+                    string = "#[string}*** An email recipient has been specified for monitor, #{@name}, but no email sender has been specified"
+                    string = "#[string}*** :email_sender => <email of sender>"
+                    string = "#[string}*** or, a catch all environment variable"
+                    string = "#[string}*** EMAIL_SENDER=<email of sender>"
+
+                    raise MonitorTypeMustHaveSenderEmailAddressForEmailAlertError.new(string)
+                    else
                     @sender_email = ENV["EMAIL_SENDER"]
                 end
-            else
+                else
                 @sender_email = params[:admin_email]
             end
         end
-        
+
         cron_string = params[:cron] || "0 1 * * *"
         @cron = CronParser.new(cron_string)
         @next = Time.now - 1
-        
+
         log "Loaded Monitor, #{@name}."
     end
     
     #Overload this method if any parameters should be checked in context
-    def sanitise
+    def extractParams
+    end
+    
+    #Overload this method if any parameters should be checked in context
+    def setup
+    end
+    
+    #Overload this method if any parameters should be checked in context
+    def teardown
     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.
@@ -70,8 +90,10 @@ class MonitorType
             begin
                 @next = @cron.next( Time.now )
                 log "Monitor, #{@name}, next run time, #{@next}"
-                self.sanitise
+                self.extractParams
+                self.setup
                 self.process
+                self.teardown
                 rescue MonitorTypeExceptionHandled => e
                 self.alert( e.message )
             end

data/lib/MonitorType/Beanstalk.rb

@@ -3,42 +3,38 @@ 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
+    #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"
+	def extractParams()
+        @connection_string = @params[:beanstalk] || "localhost:11300"
 
-        if params[:queue].nil? then
-            puts "*** Beanstalk parameter missing, queue"
-            puts "*** :queue => <queue name>"
-            abort
+        if @params[:queue].nil? then
+            string = "*** Beanstalk parameter missing, queue\n"
+            string = "#{string}*** :queue => <queue name>"
+            raise MonitorTypeParameterMissingError.new(string)
         end
-        @queue = params[:queue]
+        @queue = @params[:queue]
         
         @context_sentence = "Checking number of jobs in queue, #{@queue}"
-
-		self.sanitise
-        rescue MonitorTypeExceptionHandled => e
-        puts e.message
-        abort()
+        
 	end
     
+    def setup
+        @beanstalk = Beanstalk::Pool.new([@connection_string])
+    end
+    
+    
 	def getValue
         count = 0
         begin
-        tubeStats = @beanstalk.stats_tube(@queue)
-        count = tubeStats["current-jobs-ready"]
-        rescue Beanstalk::NotFoundError=>e
+            tubeStats = @beanstalk.stats_tube(@queue)
+            count = tubeStats["current-jobs-ready"]
+            rescue Beanstalk::NotFoundError=>e
         end
-
+        
 		return count
 	end
 end

data/lib/MonitorType/Dir.rb

@@ -3,14 +3,26 @@ require "MonitorType/Threshold"
 #A directory class for checking how many files are in a directory
 class MonitorType_Dir<MonitorType_Threshold
     
-	def sanitise
-        inputDir = Dir.new( @path )
-		@path = inputDir.path
-        if !File.writable?( @path ) then
-            puts "*** Warning. Directory is not writable, #{@path}."
-            puts "*** Warning. Make the directory, #{@path}, writable and try again."
+    #Extract parameters
+    #
+    # @param [String] path Path to directory to check
+    def extractParams()
+        if @params[:path].nil? then
+            string = "*** Dir parameter missing, path\n"
+            string = "#{string}*** :path => <path to directory to be monitored>"
+            raise MonitorTypeParameterMissingError.new(string)
         end
+        @path = @params[:path]
+        
+        @context_sentence = "Checking number of files in, #{@path}"
+    end
 
+
+	def setup
+        inputDir = Dir.new( @path )
+		@path = inputDir.path
+        @params[:dir] = inputDir
+        
         rescue Errno::ENOENT => e
         string = "***** Directory does not exist, #{@path}.\n"
         string = "#{string}***** Create the directory, #{@path}, and try again.\n"
@@ -22,27 +34,7 @@ class MonitorType_Dir<MonitorType_Threshold
         string = "#{string}***** eg, rm #{@path} && mkdir #{@path}"
         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
-            puts "*** Dir parameter missing, path"
-            puts "*** :path => <path to directory to be monitored>"
-            abort
-        end
-		@path = params[:path]
-
-        @context_sentence = "Checking number of files in, #{@path}"
-
-		self.sanitise
-    rescue MonitorTypeExceptionHandled => e
-        puts e.message
-        abort()
-	end
-
+    
 	def getValue
 		return Dir.glob( "#{@path}/*" ).length
 	end

data/lib/MonitorType/FluidDb.rb

@@ -9,66 +9,62 @@ require "MonitorType/Threshold"
 
 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 )
-            rescue Exception=>e
-            puts "*** FluidDb encountered an error while connecting to the db"
-            puts "*** Error: #{e.message}"
-            puts "*** uri: #{@uri}"
-            puts "*** Please fix the error and run again"
-            abort()
-        end
-
-        begin
-        value = @fluidDb.queryForValue( @sql, [] )
-        rescue Exception=>e
-            puts "*** FluidDb encountered an error while running the sql"
-            puts "*** sql: #{@sql}"
-            puts "*** Please fix the query and run again"
-            abort()
-        end
-	end
-    
-    #Constructor: Extract parameters
+    #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
-            puts "*** FluidDb parameter missing, uri"
-            puts "*** :uri => <uri pointing to db to be monitored>"
-            abort
+	def extractParams
+        if @params[:uri].nil? then
+            string = "*** FluidDb parameter missing, uri\n"
+            string = "#{string}*** :uri => <uri pointing to db to be monitored>"
+            raise MonitorTypeParameterMissingError.new(string)
         end
         begin
-            @uri = URI.parse( params[:uri] )
-        rescue URI::InvalidURIError=>e
-            puts "*** FluidDb encountered an error while parsing the uri"
-            puts "*** uri: #{params[:uri]}"
-            puts "*** Please fix the uri and run again"
-            abort()
+            @uri = URI.parse( @params[:uri] )
+            rescue URI::InvalidURIError=>e
+            string = "*** FluidDb encountered an error while parsing the uri"
+            string = "#{string}*** uri: #{@params[:uri]}"
+            string = "#{string}*** Please fix the uri and run again"
+            raise MonitorTypeParameterMissingError.new(string)
         end
         
-        if params[:sql].nil? then
-            puts "*** FluidDb parameter missing, sql"
-            puts "*** :sql => <sql statement, producing a single column, single row which yeidls a number>"
-            abort
+        if @params[:sql].nil? then
+            string = "*** FluidDb parameter missing, sql"
+            string = "#{string}*** :sql => <sql statement, producing a single column, single row which yeidls a number>"
+            raise MonitorTypeParameterMissingError.new(string)
         end
-        @sql = params[:sql]
-
+        @sql = @params[:sql]
+        
         @context_sentence = "Checking result of sql query, #{@sql}"
+        
+	end
+    
+    #Create the connection to the db, and get the value
+    #This ensures that all params are correct.
+	def setup
 
-		self.sanitise
-        rescue MonitorTypeExceptionHandled => e
-        puts e.message
-        abort()
+        begin
+            @fluidDb = FluidDb.Db( @uri )
+            rescue Exception=>e
+            string = "*** FluidDb encountered an error while connecting to the db\n"
+            string = "#{string}*** Error: #{e.message}\n"
+            string = "#{string}*** uri: #{@uri}\n"
+            string = "#{string}*** Please 3fix the error and run again\n"
+            raise MonitorTypeExceptionHandled.new(string)
+        end
+
+        @params[:fluidDb] = @fluidDb
 	end
     
 	def getValue
-        return @fluidDb.queryForValue( @sql, [] )
+        begin
+            return @fluidDb.queryForValue( @sql, [] )
+            rescue Exception=>e
+            string = "*** FluidDb encountered an error while running the sql\n"
+            string = "#{string}*** sql: #{@sql}\n"
+            string = "#{string}*** Please fix the query and run again\n"
+            raise MonitorTypeExceptionHandled.new(string)
+        end
 	end
 end
 

data/lib/MonitorType/Process.rb

@@ -0,0 +1,51 @@
+require "MonitorType/Threshold"
+
+#A class for checking if a Process is running in Unix based systems
+class MonitorType_Process<MonitorType_Threshold
+
+	def sanitise
+		#Ensure that the process name contains a single character surrounded by square brackets
+		@process_name = @process_name.insert(0,'[').insert(2,']') unless @process_name =~ /^.*\[.+\].*/
+	end
+
+	def initialize(params)
+		super(params)
+
+		if params[:process_name].nil? then
+			puts "*** Process Name parameter missing, process_name"
+			puts "*** :process_name => <name of the process to be monitored>"
+			abort
+		end
+		@process_name = params[:process_name]
+
+		puts "#{@process_name}", "result: #{(@process_name =~ /^(.*\[{1}.+\]{1}.*)$|^(\w+)$/) == 0}"
+
+		unless (@process_name =~ /^(.*\[{1}.+\]{1}.*)$|^(\w+)$/) == 0 then
+			puts "*** Process Name parameter doest not match the required pattern, #{@process_name}"
+			puts "*** :process_name => <plain string, or a string with one or more characters enclosed in square brackets, i.e. 'foo', '[f]oo' or '[foo]'>"
+			abort
+		end
+
+		puts "*** Min value will be ignored, setting to 1" unless (params[:min].nil? || params[:min] == 0)
+		@min = 1
+
+		puts "*** Max value will be ignored, setting to nil" unless params[:max].nil?
+		@max = nil
+
+		@context_sentence = "Checking that process is running, #{@process_name}"
+
+		self.sanitise
+	rescue MonitorTypeExceptionHandled => e
+		puts e.message
+		abort
+	end
+
+	def getValue
+		return `ps aux | grep #{@process_name}`.length
+	end
+
+end
+
+def process(params)
+	$a.add(MonitorType_Process.new(params))
+end

data/lib/MonitorType/Threshold.rb

@@ -19,9 +19,10 @@ class MonitorType_Threshold<MonitorType
             value = self.getValue
             else
             value = @block.call( @params )
-            puts "value: #{value}"
+            string = "value: #{value}\n"
+            puts string
         end
-    
+
         self.check( value )
     end
 

data/lib/helper_functions.rb

@@ -0,0 +1,11 @@
+def log( string, verbose=false )
+    return if ENV["TESTING"]=="true"
+    
+    type = verbose ? "VERB" : "INFO"
+	if !ENV["VERBOSE"].nil? || verbose==false then
+        timestamp = Time.new.strftime( "%Y-%m-%d %H:%M:%S" )
+        puts "[#{type}] #{timestamp} :: #{string}"
+    end
+end
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: servicemonitor
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-02 00:00:00.000000000 Z
+date: 2013-12-30 00:00:00.000000000 Z
 dependencies: []
-description: Monitor various parts of the system
+description: The fastest way to reliably monitor your system.
 email: guy@guyirvine.com
 executables:
 - servicemonitor
@@ -20,10 +20,12 @@ extra_rdoc_files: []
 files:
 - lib/Alert/Email.rb
 - lib/Alert.rb
+- lib/helper_functions.rb
 - lib/MonitorManager.rb
 - lib/MonitorType/Beanstalk.rb
 - lib/MonitorType/Dir.rb
 - lib/MonitorType/FluidDb.rb
+- lib/MonitorType/Process.rb
 - lib/MonitorType/Threshold.rb
 - lib/MonitorType.rb
 - bin/servicemonitor