SheepDog 0.1.0.20110705 → 0.2.0.20120314

data/AUTHORS

@@ -1,2 +1,3 @@
-= Muriel Salvan (murielsalvan@users.sourceforge.net)
+= Muriel Salvan (muriel@x-aeon.com)
 * 0.1.0.20110705
+* 0.2.0.20120314

data/ChangeLog

@@ -1,4 +1,25 @@
-= StatsCollect Release History
+= SheepDog Release History
+
+== 0.2.0.20120314 (Alpha)
+
+* Added rUtilAnts dependency in the release file.
+* Adapted release info to last version of Ruby Packager.
+* Removed rdoc warning in documentation.
+* Adapted to Ruby's standard conventions.
+* Updated Copyright information.
+* Updated email address of Muriel Salvan.
+* Adapted comments to match a better RDoc syntax.
+* Adapted to new version of rUtilAnts.
+* Adding possibility to add conditions to monitors.
+* Added a common file that can define common methods.
+* Added Monitors/Top to monitor global values returned by top command (configuration example file modified).
+* Monitors/LogFile: Increased robustness in case of a previous SheepDog crash.
+* Monitors/LogFile: Added possibility to not specify a filter in logs parsing.
+* Monitors/Process: Added possibility to monitor resident memory per process (example configuration file updated).
+* Bug correction: Notifiers/SendMail: Multi reports were sending only the last report.
+* Bug correction: Notifiers/StdOut: Multi reports were sending only the last report.
+* Bug correction: Notifiers/SendMail: Notifications could not be sent when grouped.
+* Bug correction: Notifiers/StdOut: Notifications could not be sent when grouped.
 
 == 0.1.0.20110705 (Alpha)
 

data/LICENSE

@@ -6,7 +6,7 @@ This list is found in the file named AUTHORS.
 The AUTHORS and LICENSE files have to be included in any release of software
 embedding source code of this package, or using it as a derivative software.
 
-Copyright (c) 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+Copyright (c) 2011 - 2012 Muriel Salvan (muriel@x-aeon.com)
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

data/README

@@ -1,6 +1,3 @@
--- This file is best viewed when processed by rdoc.
-++
-
 = Sheep Dog
 
 Simple command line tool that monitors files and processes and sends notifications or take corrective actions when problems arise. Monitor log files for errors, processes CPU and memory consumption (can kill if exceeding), respawn dead processes.
@@ -11,8 +8,8 @@ Check the website at http://sheepdogsys.sourceforge.net
 
 == Who wrote it ?
 
-Check the AUTHORS[link:files/AUTHORS.html] file.
+Check the AUTHORS[link:AUTHORS.html] file.
 
 == What is the license ?
 
-You can find out in the LICENSE[link:files/LICENSE.html] file.
+You can find out in the LICENSE[link:LICENSE.html] file.

data/ReleaseInfo

@@ -2,7 +2,7 @@
 # This file has been generated by RubyPackager during a delivery.
 # More info about RubyPackager: http://rubypackager.sourceforge.net
 {
-  :Version => '0.1.0.20110705',
-  :Tags => [ 'Alpha' ],
-  :DevStatus => 'Alpha'
+  :version => '0.2.0.20120314',
+  :tags => [ 'Alpha' ],
+  :dev_status => 'Alpha'
 }

data/bin/sheepdog.rb

@@ -1,24 +1,24 @@
 #!/bin/env ruby
 #--
-# Copyright (c) 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2011 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
 require 'rUtilAnts/Logging'
-RUtilAnts::Logging::initializeLogging('','')
+RUtilAnts::Logging::install_logger_on_object
 require 'tmpdir'
 lLogFile = "#{Dir.tmpdir}/SheepDog_#{Process.pid}.log"
-setLogFile(lLogFile)
-logInfo 'Starting SheepDog'
+set_log_file(lLogFile)
+log_info 'Starting SheepDog'
 require 'sheepdog/Executor'
 
 lConfFileName = ARGV[0]
 if (lConfFileName == nil)
-  logErr "Usage: sheepdog.rb <ConfigFileName>"
+  log_err "Usage: sheepdog.rb <ConfigFileName>"
 elsif (File.exists?(lConfFileName))
   SheepDog::Executor.new.execute(eval(File.read(lConfFileName)))
 else
-  logErr "Missing file: #{lConfFileName}"
+  log_err "Missing file: #{lConfFileName}"
 end
 
 File.unlink(lLogFile)

data/lib/sheepdog/Common.rb

@@ -0,0 +1,33 @@
+#--
+# Copyright (c) 2011 - 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module SheepDog
+
+  module Common
+
+    # Convert a string representing a memory quantity to its integer value.
+    # Useful to decode top output, that uses k and m for its quantities.
+    #
+    # Parameters::
+    # * *iStrValue* (_String_): The value as a string
+    # Return::
+    # * _Integer_: Corresponding value
+    def quantity2Int(iStrValue)
+      rResult = nil
+
+      if (iStrValue[-1..-1] == 'k')
+        rResult = iStrValue[0..-2].to_i * 1024
+      elsif (iStrValue[-1..-1] == 'm')
+        rResult = iStrValue[0..-2].to_i * 1024 * 1024
+      else
+        rResult = iStrValue.to_i
+      end
+
+      return rResult
+    end
+
+  end
+
+end

data/lib/sheepdog/Executor.rb

@@ -1,10 +1,11 @@
 #--
-# Copyright (c) 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2011 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
 require 'time'
 require 'fileutils'
+require 'sheepdog/Common'
 require 'sheepdog/Report'
 
 module SheepDog
@@ -15,14 +16,14 @@ module SheepDog
     def initialize
       # Parse plugins
       require 'rUtilAnts/Plugins'
-      RUtilAnts::Plugins::initializePlugins
-      parsePluginsFromDir('Notifiers', "#{File.expand_path(File.dirname(__FILE__))}/Notifiers", 'SheepDog::Notifiers')
-      parsePluginsFromDir('Monitors', "#{File.expand_path(File.dirname(__FILE__))}/Monitors", 'SheepDog::Monitors')
+      RUtilAnts::Plugins::install_plugins_on_object
+      parse_plugins_from_dir('Notifiers', "#{File.expand_path(File.dirname(__FILE__))}/Notifiers", 'SheepDog::Notifiers')
+      parse_plugins_from_dir('Monitors', "#{File.expand_path(File.dirname(__FILE__))}/Monitors", 'SheepDog::Monitors')
     end
 
     # Execute a given configuration
     #
-    # Parameters:
+    # Parameters::
     # * *iConf* (<em>map<Symbol,Object></em>): The sheep dog configuration
     def execute(iConf)
       # Get the local database, storing dates of last reports sent...
@@ -49,125 +50,73 @@ module SheepDog
       lDelayedReports = {}
       # Loop through the objects to monitor
       iConf[:Monitors].each do |iMonitorName, iMonitorInfo|
-        # Check that it is a known monitor, by accessing the plugin
-        lMonitorPluginInstance, lError = getPluginInstance('Monitors', iMonitorInfo[:Type])
-        if (lMonitorPluginInstance == nil)
-          # Unknown monitor
-          logErr "Unknown Monitor #{iMonitorInfo[:Type]}: #{lError}. Ignoring corresponding monitoring process. Please check configuration."
-        else
-          # Create the report to be filled by this process
-          lReport = Report.new
-          # Create the monitor configuration dir
-          lMonitorDir = "#{iConf[:WorkingDir]}/#{iMonitorName}"
-          FileUtils::mkdir_p(lMonitorDir)
-          # Set instance variables and methods for this monitor
-          lMonitorPluginInstance.instance_variable_set(:@SheepDogConf, iConf)
-          lMonitorPluginInstance.instance_variable_set(:@Report, lReport)
-          lMonitorPluginInstance.instance_variable_set(:@MonitorDir, lMonitorDir)
-          if (!lMonitorPluginInstance.respond_to?(:report))
-            # Report an entry
-            #
-            # Parameters:
-            # * *iEntry* (_String_): Entry to be reported
-            def lMonitorPluginInstance.report(iEntry)
-              @Report.addEntry(iEntry)
-              logInfo "Report: #{iEntry}"
+        # First check if conditions are met
+        if ((iMonitorInfo[:Conditions] == nil) or
+            (checkConditions(iMonitorInfo[:Conditions])))
+          # Check that it is a known monitor, by accessing the plugin
+          lMonitorPluginInstance, lError = get_plugin_instance('Monitors', iMonitorInfo[:Type])
+          if (lMonitorPluginInstance == nil)
+            # Unknown monitor
+            log_err "Unknown Monitor #{iMonitorInfo[:Type]}: #{lError}. Ignoring corresponding monitoring process. Please check configuration."
+          else
+            # Create the report to be filled by this process
+            lReport = Report.new
+            # Create the monitor configuration dir
+            lMonitorDir = "#{iConf[:WorkingDir]}/#{iMonitorName}"
+            FileUtils::mkdir_p(lMonitorDir)
+            # Set instance variables and methods for this monitor
+            lMonitorPluginInstance.instance_variable_set(:@SheepDogConf, iConf)
+            lMonitorPluginInstance.instance_variable_set(:@Report, lReport)
+            lMonitorPluginInstance.instance_variable_set(:@MonitorDir, lMonitorDir)
+            if (!lMonitorPluginInstance.respond_to?(:report))
+              # Report an entry
+              #
+              # Parameters::
+              # * *iEntry* (_String_): Entry to be reported
+              def lMonitorPluginInstance.report(iEntry)
+                @Report.addEntry(iEntry)
+                log_info "Report: #{iEntry}"
+              end
             end
-          end
-          # Call this monitor
-          begin
-            logInfo "Executing monitoring process #{iMonitorName} ..."
-            lMonitorPluginInstance.execute(iMonitorInfo)
-          rescue Exception
-            logErr "Exception while executing monitor #{iMonitorName}: #{$!}.\n#{$!.backtrace.join("\n")}"
-            report "!!! Exception while executing monitor #{iMonitorName}: #{$!}.\n#{$!.backtrace.join("\n")}"
-          end
-          # If this report is not empty, save it in a file
-          lCurrentReportFileName = nil
-          lCurrentReportTime = nil
-          if (!lReport.empty?)
-            lCurrentReportTime = Time.now.utc
-            lCurrentReportFileName = "#{lMonitorDir}/Report_#{lCurrentReportTime.strftime('%Y-%m-%d-%H-%M-%S')}"
-            File.open(lCurrentReportFileName, 'w') do |oFile|
-              oFile.write(Marshal.dump(lReport))
+            # Call this monitor
+            begin
+              log_info "Executing monitoring process #{iMonitorName} ..."
+              lMonitorPluginInstance.execute(iMonitorInfo)
+            rescue Exception
+              log_err "Exception while executing monitor #{iMonitorName}: #{$!}.\n#{$!.backtrace.join("\n")}"
+              report "!!! Exception while executing monitor #{iMonitorName}: #{$!}.\n#{$!.backtrace.join("\n")}"
             end
-          end
-          # Get the list of reports to send, per time
-          # map< Time, FileName >
-          lReportFiles = {}
-          Dir.glob("#{lMonitorDir}/Report_*").each do |iReportFile|
-            lMatch = File.basename(iReportFile).match(/^Report_(\d\d\d\d)-(\d\d)-(\d\d)-(\d\d)-(\d\d)-(\d\d)$/)
-            if (lMatch == nil)
-              logErr "Invalid file report name: #{iReportFile}. Ignoring it."
-            else
-              lReportFiles[Time.parse("#{lMatch[1]}-#{lMatch[2]}-#{lMatch[3]} #{lMatch[4]}:#{lMatch[5]}:#{lMatch[6]} UTC")] = iReportFile
+            # If this report is not empty, save it in a file
+            lCurrentReportFileName = nil
+            lCurrentReportTime = nil
+            if (!lReport.empty?)
+              lCurrentReportTime = Time.now.utc
+              lCurrentReportFileName = "#{lMonitorDir}/Report_#{lCurrentReportTime.strftime('%Y-%m-%d-%H-%M-%S')}"
+              File.open(lCurrentReportFileName, 'w') do |oFile|
+                oFile.write(Marshal.dump(lReport))
+              end
             end
-          end
-          # For each report file, compute the list of notifiers that will send it
-          if (!lReportFiles.empty?)
-            # There are some report files to be (maybe) sent.
-            # Loop through the notifiers.
-            iMonitorInfo[:Notifiers].each do |iNotifierName, iNotifierConf|
-              lNotifierID = iNotifierConf[:Type]
-              if (iNotifierConf[:GroupReports] == nil)
-                # Send the report now if it exists
-                if (lCurrentReportFileName != nil)
-                  # Send [iMonitorInfo, [lCurrentReportFileName]] to iNotifierName
-                  if (iNotifierConf[:GroupWithOtherMonitors] == true)
-                    if (lGroupedMonitorReports[lNotifierID] == nil)
-                      lGroupedMonitorReports[lNotifierID] = {}
-                    end
-                    if (lGroupedMonitorReports[lNotifierID][iMonitorName] == nil)
-                      lGroupedMonitorReports[lNotifierID][iMonitorName] = []
-                    end
-                    lGroupedMonitorReports[lNotifierID][iMonitorName] << [ iNotifierConf, [ lCurrentReportFileName ] ]
-                  else
-                    notify(iConf, {lNotifierID => {iMonitorName => [ [ iNotifierConf, [lCurrentReportFileName] ] ] }}, lDelayedReports)
-                  end
-                  lSentReports[lCurrentReportFileName] = nil
-                  # Remember last report sent
-                  if (lDatabase[:LastReportsSent][iMonitorName] == nil)
-                    lDatabase[:LastReportsSent][iMonitorName] = {}
-                  end
-                  lDatabase[:LastReportsSent][iMonitorName][iNotifierName] = lCurrentReportTime
-                end
+            # Get the list of reports to send, per time
+            # map< Time, FileName >
+            lReportFiles = {}
+            Dir.glob("#{lMonitorDir}/Report_*").each do |iReportFile|
+              lMatch = File.basename(iReportFile).match(/^Report_(\d\d\d\d)-(\d\d)-(\d\d)-(\d\d)-(\d\d)-(\d\d)$/)
+              if (lMatch == nil)
+                log_err "Invalid file report name: #{iReportFile}. Ignoring it."
               else
-                # Get the interval in seconds
-                lSecsInterval = getSecsInterval(iNotifierConf[:GroupReports])
-                # Maybe we don't want to send reports now
-                # Get the last time we sent reports for this one
-                if ((lDatabase[:LastReportsSent][iMonitorName] != nil) and
-                    (lDatabase[:LastReportsSent][iMonitorName][iNotifierName] != nil) and
-                    ((Time.now.utc - lDatabase[:LastReportsSent][iMonitorName][iNotifierName]) < lSecsInterval))
-                  # Reports from last one sent to the most recent one are marked to be sent later
-                  lReportFiles.each do |iReportTime, iReportFileName|
-                    if (iReportTime > lDatabase[:LastReportsSent][iMonitorName][iNotifierName])
-                      # This report will be sent another time
-                      lDelayedReports[iReportFileName] = nil
-                    end
-                  end
-                else
-                  # Send all corresponding reports now
-                  lLastReportSentDate = nil
-                  if ((lDatabase[:LastReportsSent][iMonitorName] != nil) and
-                      (lDatabase[:LastReportsSent][iMonitorName][iNotifierName] != nil))
-                    lLastReportSentDate = lDatabase[:LastReportsSent][iMonitorName][iNotifierName]
-                  else
-                    lLastReportSentDate = Time.parse('1970-01-01 00:00:00 UTC')
-                  end
-                  lReportFilesToSend = []
-                  lLastReportTime = Time.parse('1970-01-01 00:00:00 UTC')
-                  lReportFiles.each do |iReportTime, iReportFileName|
-                    if (iReportTime > lLastReportSentDate)
-                      lReportFilesToSend << iReportFileName
-                      lSentReports[iReportFileName] = nil
-                      if (iReportTime > lLastReportTime)
-                        lLastReportTime = iReportTime
-                      end
-                    end
-                  end
-                  if (!lReportFilesToSend.empty?)
-                    # Send [iMonitorInfo, lReportFilesToSend] to iNotifierName
+                lReportFiles[Time.parse("#{lMatch[1]}-#{lMatch[2]}-#{lMatch[3]} #{lMatch[4]}:#{lMatch[5]}:#{lMatch[6]} UTC")] = iReportFile
+              end
+            end
+            # For each report file, compute the list of notifiers that will send it
+            if (!lReportFiles.empty?)
+              # There are some report files to be (maybe) sent.
+              # Loop through the notifiers.
+              iMonitorInfo[:Notifiers].each do |iNotifierName, iNotifierConf|
+                lNotifierID = iNotifierConf[:Type]
+                if (iNotifierConf[:GroupReports] == nil)
+                  # Send the report now if it exists
+                  if (lCurrentReportFileName != nil)
+                    # Send [iMonitorInfo, [lCurrentReportFileName]] to iNotifierName
                     if (iNotifierConf[:GroupWithOtherMonitors] == true)
                       if (lGroupedMonitorReports[lNotifierID] == nil)
                         lGroupedMonitorReports[lNotifierID] = {}
@@ -175,15 +124,71 @@ module SheepDog
                       if (lGroupedMonitorReports[lNotifierID][iMonitorName] == nil)
                         lGroupedMonitorReports[lNotifierID][iMonitorName] = []
                       end
-                      lGroupedMonitorReports[lNotifierID][iMonitorName] << [ iNotifierConf, lReportFilesToSend ]
+                      lGroupedMonitorReports[lNotifierID][iMonitorName] << [ iNotifierConf, [ lCurrentReportFileName ] ]
                     else
-                      notify(iConf, {lNotifierID => {iMonitorName => [ [ iNotifierConf, lReportFilesToSend ] ]}}, lDelayedReports)
+                      notify(iConf, {lNotifierID => {iMonitorName => [ [ iNotifierConf, [lCurrentReportFileName] ] ] }}, lDelayedReports)
                     end
+                    lSentReports[lCurrentReportFileName] = nil
                     # Remember last report sent
                     if (lDatabase[:LastReportsSent][iMonitorName] == nil)
                       lDatabase[:LastReportsSent][iMonitorName] = {}
                     end
-                    lDatabase[:LastReportsSent][iMonitorName][iNotifierName] = lLastReportTime
+                    lDatabase[:LastReportsSent][iMonitorName][iNotifierName] = lCurrentReportTime
+                  end
+                else
+                  # Get the interval in seconds
+                  lSecsInterval = getSecsInterval(iNotifierConf[:GroupReports])
+                  # Maybe we don't want to send reports now
+                  # Get the last time we sent reports for this one
+                  if ((lDatabase[:LastReportsSent][iMonitorName] != nil) and
+                      (lDatabase[:LastReportsSent][iMonitorName][iNotifierName] != nil) and
+                      ((Time.now.utc - lDatabase[:LastReportsSent][iMonitorName][iNotifierName]) < lSecsInterval))
+                    # Reports from last one sent to the most recent one are marked to be sent later
+                    lReportFiles.each do |iReportTime, iReportFileName|
+                      if (iReportTime > lDatabase[:LastReportsSent][iMonitorName][iNotifierName])
+                        # This report will be sent another time
+                        lDelayedReports[iReportFileName] = nil
+                      end
+                    end
+                  else
+                    # Send all corresponding reports now
+                    lLastReportSentDate = nil
+                    if ((lDatabase[:LastReportsSent][iMonitorName] != nil) and
+                        (lDatabase[:LastReportsSent][iMonitorName][iNotifierName] != nil))
+                      lLastReportSentDate = lDatabase[:LastReportsSent][iMonitorName][iNotifierName]
+                    else
+                      lLastReportSentDate = Time.parse('1970-01-01 00:00:00 UTC')
+                    end
+                    lReportFilesToSend = []
+                    lLastReportTime = Time.parse('1970-01-01 00:00:00 UTC')
+                    lReportFiles.each do |iReportTime, iReportFileName|
+                      if (iReportTime > lLastReportSentDate)
+                        lReportFilesToSend << iReportFileName
+                        lSentReports[iReportFileName] = nil
+                        if (iReportTime > lLastReportTime)
+                          lLastReportTime = iReportTime
+                        end
+                      end
+                    end
+                    if (!lReportFilesToSend.empty?)
+                      # Send [iMonitorInfo, lReportFilesToSend] to iNotifierName
+                      if (iNotifierConf[:GroupWithOtherMonitors] == true)
+                        if (lGroupedMonitorReports[lNotifierID] == nil)
+                          lGroupedMonitorReports[lNotifierID] = {}
+                        end
+                        if (lGroupedMonitorReports[lNotifierID][iMonitorName] == nil)
+                          lGroupedMonitorReports[lNotifierID][iMonitorName] = []
+                        end
+                        lGroupedMonitorReports[lNotifierID][iMonitorName] << [ iNotifierConf, lReportFilesToSend ]
+                      else
+                        notify(iConf, {lNotifierID => {iMonitorName => [ [ iNotifierConf, lReportFilesToSend ] ]}}, lDelayedReports)
+                      end
+                      # Remember last report sent
+                      if (lDatabase[:LastReportsSent][iMonitorName] == nil)
+                        lDatabase[:LastReportsSent][iMonitorName] = {}
+                      end
+                      lDatabase[:LastReportsSent][iMonitorName][iNotifierName] = lLastReportTime
+                    end
                   end
                 end
               end
@@ -203,7 +208,7 @@ module SheepDog
       end
       # Log reports to be sent delayed
       lDelayedReports.keys.each do |iReportFileName|
-        logInfo "Report to be sent later: #{iReportFileName}"
+        log_info "Report to be sent later: #{iReportFileName}"
       end
 
       # Write back database
@@ -214,19 +219,46 @@ module SheepDog
 
     private
 
+    # Check conditions
+    #
+    # Parameters::
+    # * *iConditions* (<em>map<Symbol,Object></em>): The conditions to check
+    # Return::
+    # * _Boolean_: Are the conditions respected ?
+    def checkConditions(iConditions)
+      rPassed = true
+
+      if (iConditions[:TimeRanges] != nil)
+        require 'time'
+        # If current time falls into at least 1 range of the list, it's ok.
+        lNow = Time.parse(Time.now.utc.strftime('2001-01-01 %H:%m:%S UTC')).utc
+        rPassed = false
+        iConditions[:TimeRanges].each do |iTimeRangeInfo|
+          iBeginTime, iEndTime = iTimeRangeInfo.map { |iStrTime| Time.parse("2001-01-01 #{iStrTime}").utc }
+          rPassed = ((lNow >= iBeginTime) and
+                     (lNow <= iEndTime))
+          if (rPassed)
+            break
+          end
+        end
+      end
+
+      return rPassed
+    end
+
     # Process notifications to be sent.
     #
-    # Parameters:
+    # Parameters::
     # * *iConf* (<em>map<Symbol,Object></em>): SheepDog config
-    # * *iNotificationsInfo* (<em>map<NotifierName,map<MonitorName,list<[NotifierConf,list<ReportFileName>]>>></em>): The list of report files to send along with their notifier config, per monitor name, per notifier name
+    # * *iNotificationsInfo* (<em>map<NotifierName,map<MonitorName,list< [NotifierConf,list<ReportFileName>] >>></em>): The list of report files to send along with their notifier config, per monitor name, per notifier name
     # * *ioErrorReports* (<em>map<ReportFileName,nil></em>): The set of report file names that could not be sent through notifications
     def notify(iConf, iNotificationsInfo, ioErrorReports)
       iNotificationsInfo.each do |iNotifierName, iNotifierNotificationsInfo|
         # Find this notifier
         if (iConf[:Notifiers][iNotifierName] == nil)
-          logErr "Unknown notifier named #{iNotifierName}. Ignoring notifications to be sent there. Please check configuration."
+          log_err "Unknown notifier named #{iNotifierName}. Ignoring notifications to be sent there. Please check configuration."
         else
-          accessPlugin('Notifiers', iConf[:Notifiers][iNotifierName][:Type]) do |iNotifierPlugin|
+          access_plugin('Notifiers', iConf[:Notifiers][iNotifierName][:Type]) do |iNotifierPlugin|
             # List of reports to send through this notifier
             # list< Report >
             lLstReports = []
@@ -241,7 +273,7 @@ module SheepDog
                   begin
                     lReport = Marshal.load(File.read(iReportFileName))
                   rescue Exception
-                    logErr "Invalid report stored in file #{iReportFileName}: #{$!}.\n#{$!.backtrace.join("\n")}"
+                    log_err "Invalid report stored in file #{iReportFileName}: #{$!}.\n#{$!.backtrace.join("\n")}"
                     ioErrorReports[iReportFileName] = nil
                     lReport = nil
                   end
@@ -257,10 +289,10 @@ module SheepDog
               end
             end
             begin
-              logInfo "===== Send notification to #{iNotifierName} of #{lLstReports.size} reports..."
-              iNotifierPlugin.sendNotification(iConf[:Notifiers][iNotifierName], lLstReports)
+              log_info "===== Send notification to #{iNotifierName} of #{lLstReports.size} reports..."
+              iNotifierPlugin.send_notification(iConf[:Notifiers][iNotifierName], lLstReports)
             rescue Exception
-              logErr "Exception while sending notification from #{iNotifierName} for reports #{lReportFilesSet.keys.join(', ')}: #{$!}.\n#{$!.backtrace.join("\n")}"
+              log_err "Exception while sending notification from #{iNotifierName} for reports #{lReportFilesSet.keys.join(', ')}: #{$!}.\n#{$!.backtrace.join("\n")}"
               ioErrorReports.merge!(lReportFilesSet)
             end
           end
@@ -270,15 +302,15 @@ module SheepDog
 
     # Get the number of seconds defined in a configuration
     #
-    # Parameters:
+    # Parameters::
     # * *iConf* (<em>map<Symbol,Object></em>): The configuration
-    # Return:
+    # Return::
     # * _Fixnum_: The number of seconds
     def getSecsInterval(iConf)
       if (iConf[:Interval_Secs] != nil)
         return iConf[:Interval_Secs]
       else
-        logErr "Unable to decode interval from #{iConf.inspect}"
+        log_err "Unable to decode interval from #{iConf.inspect}"
         return 0
       end
     end

data/lib/sheepdog/Monitors/LogFile.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2011 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
@@ -11,14 +11,19 @@ module SheepDog
 
       # Execute the monitoring process for a given configuration
       #
-      # Parameters:
+      # Parameters::
       # * *iConf* (<em>map<Symbol,Object></em>): The monitor configuration
       def execute(iConf)
         # Get past values
         lReadValuesFileName = "#{@MonitorDir}/ReadValues"
         lReadValues = nil
         if (File.exists?(lReadValuesFileName))
-          lReadValues = Marshal.load(File.read(lReadValuesFileName))
+          begin
+            lReadValues = Marshal.load(File.read(lReadValuesFileName))
+          rescue Exception
+            report "Error while reading previously read values: #{$!}"
+            lReadValues = nil
+          end
         else
           lReadValues = {
             :LastPos => 0,
@@ -41,16 +46,20 @@ module SheepDog
               iFile.seek(lStartPos)
               iFile.read.split("\n").each do |iLine|
                 # Match the line against filters
-                lMatch = false
-                iConf[:Filters].each do |iFilter|
-                  if (iLine.match(iFilter) != nil)
-                    lMatch = true
-                    break
-                  end
-                end
-                if (lMatch)
-                  # Report this line
+                if (iConf[:Filters] == nil)
                   report iLine
+                else
+                  lMatch = false
+                  iConf[:Filters].each do |iFilter|
+                    if (iLine.match(iFilter) != nil)
+                      lMatch = true
+                      break
+                    end
+                  end
+                  if (lMatch)
+                    # Report this line
+                    report iLine
+                  end
                 end
               end
               lReadValues[:LastPos] = iFile.pos

data/lib/sheepdog/Monitors/Process.rb

@@ -1,10 +1,10 @@
 #--
-# Copyright (c) 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2011 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
 require 'rUtilAnts/Misc'
-RUtilAnts::Misc::initializeMisc
+RUtilAnts::Misc::install_misc_on_object
 
 module SheepDog
 
@@ -14,7 +14,7 @@ module SheepDog
 
       # Execute the monitoring process for a given configuration
       #
-      # Parameters:
+      # Parameters::
       # * *iConf* (<em>map<Symbol,Object></em>): The monitor configuration
       def execute(iConf)
         # Get the list of processes
@@ -50,7 +50,7 @@ module SheepDog
           # Maybe we want to execute something
           if (iConf.has_key?(:ExecuteIfMissing))
             report "Missing process. Executing \"#{iConf[:ExecuteIfMissing][:CmdLine]}\" from \"#{iConf[:ExecuteIfMissing][:Pwd]}\":"
-            changeDir(iConf[:ExecuteIfMissing][:Pwd]) do
+            change_dir(iConf[:ExecuteIfMissing][:Pwd]) do
               report `#{iConf[:ExecuteIfMissing][:CmdLine]}`
             end
           end
@@ -60,7 +60,7 @@ module SheepDog
           # map< Integer, nil >
           lAboveLimitsPIDs = {}
           lLstPIDs.each do |iPID|
-            lCPUPercent, lMemPercent, lVirtualSize = getPIDMetrics(iPID)
+            lCPUPercent, lMemPercent, lVirtualSize, lResidentSize = getPIDMetrics(iPID)
             # Challenge metrics against limits
             if ((iConf[:Limits].has_key?(:CPUPercent)) and
                 (lCPUPercent > iConf[:Limits][:CPUPercent]))
@@ -77,6 +77,11 @@ module SheepDog
               report "PID #{iPID} exceeds virtual mem size limit: #{lVirtualSize} > #{iConf[:Limits][:VirtualMemSize]}"
               lAboveLimitsPIDs[iPID] = nil
             end
+            if ((iConf[:Limits].has_key?(:ResidentMemSize)) and
+                (lResidentSize > iConf[:Limits][:ResidentMemSize]))
+              report "PID #{iPID} exceeds resident mem size limit: #{lResidentSize} > #{iConf[:Limits][:ResidentMemSize]}"
+              lAboveLimitsPIDs[iPID] = nil
+            end
           end
           if (!lAboveLimitsPIDs.empty?)
             # What to do with PIDs exceeding limits ?
@@ -91,14 +96,17 @@ module SheepDog
 
       private
 
+      include SheepDog::Common
+
       # Get metrics of a PID
       #
-      # Parameters:
+      # Parameters::
       # * *iPID* (_Integer_): The PID to get metrics from
-      # Return:
+      # Return::
       # * _Float_: The CPU percentage
       # * _Float_: The mem percentage
       # * _Integer_: The total virtual memory size
+      # * _Integer_: The total resident memory size
       def getPIDMetrics(iPID)
         rCPUPercent = nil
         rMemPercent = nil
@@ -106,11 +114,13 @@ module SheepDog
 
         # From top
         lTopOutput = `top -n1 -p#{iPID} -b | tail -2 | head -1`.strip
-        lMatch = lTopOutput.match(/^\d+\s+\S+\s+\d+\s+\d+\s+\S+\s+\S+\s+\d+\s+\S+\s+(\S+)\s+(\S+)\s+\S+\s+.+$/)
+        lMatch = lTopOutput.match(/^\d+\s+\S+\s+\d+\s+\d+\s+\S+\s+(\S+)\s+\d+\s+\S+\s+(\S+)\s+(\S+)\s+\S+\s+.+$/)
         if (lMatch == nil)
           report "Unable to decode top output for PID #{iPID}: \"#{lTopOutput}\""
         else
-          rCPUPercent, rMemPercent = lMatch[1..2].map { |iStrValue| iStrValue.to_f }
+          # Convert RES column to integer
+          rRESValue = quantity2Int(lMatch[1])
+          rCPUPercent, rMemPercent = lMatch[2..3].map { |iStrValue| iStrValue.to_f }
         end
         # From proc/<PID>/stat
         lStatOutput = `cat /proc/#{iPID}/stat`.strip
@@ -121,7 +131,7 @@ module SheepDog
           rVS = lMatch[1].to_i
         end
 
-        return rCPUPercent, rMemPercent, rVS
+        return rCPUPercent, rMemPercent, rVS, rRESValue
       end
 
     end

data/lib/sheepdog/Monitors/Top.rb

@@ -0,0 +1,63 @@
+#--
+# Copyright (c) 2011 - 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'rUtilAnts/Misc'
+RUtilAnts::Misc::install_misc_on_object
+
+module SheepDog
+
+  module Monitors
+
+    class Top
+
+      include SheepDog::Common
+
+      # Execute the monitoring process for a given configuration
+      #
+      # Parameters::
+      # * *iConf* (<em>map<Symbol,Object></em>): The monitor configuration
+      def execute(iConf)
+        lLstTopOutput = `top -b -p0 -n1 | head -4`.split("\n").map { |iLine| iLine.strip }
+        # The loads
+        if (iConf[:Limits][:Loads] != nil)
+          lLine = lLstTopOutput[0]
+          lMatch = lLine.match(/load average: ([^,]+), ([^,]+), ([^,]+)$/)
+          if (lMatch == nil)
+            report "Unable to decode top output for loads: \"#{lLine}\"."
+          else
+            lTopValues = lMatch[1..3].map { |iStrValue| iStrValue.to_f }
+            3.times do |iIdx|
+              if ((iConf[:Limits][:Loads][iIdx] != nil) and
+                  (lTopValues[iIdx] > iConf[:Limits][:Loads][iIdx]))
+                report "Value ##{iIdx} of load exceeds limit: #{lTopValues[iIdx]} > #{iConf[:Limits][:Loads][iIdx]}"
+              end
+            end
+          end
+        end
+        # The memory
+        if (iConf[:Limits][:Memory] != nil)
+          lLine = lLstTopOutput[3]
+          lMatch = lLine.match(/\s+(\S+) used,\s+(\S+) free/)
+          if (lMatch == nil)
+            report "Unable to decode top output for memory: \"#{lLine}\"."
+          else
+            lMemUsed, lMemFree = lMatch[1..2].map { |iStrValue| quantity2Int(iStrValue) }
+            if ((iConf[:Limits][:Memory][:MaxUsed] != nil) and
+                (lMemUsed > iConf[:Limits][:Memory][:MaxUsed]))
+              report "Used memory exceed maximal limit: #{lMemUsed} > #{iConf[:Limits][:Memory][:MaxUsed]}"
+            end
+            if ((iConf[:Limits][:Memory][:MinFree] != nil) and
+                (lMemFree < iConf[:Limits][:Memory][:MinFree]))
+              report "Free memory below minimal limit: #{lMemFree} < #{iConf[:Limits][:Memory][:MinFree]}"
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/sheepdog/Notifiers/SendMail.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010 - 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2010 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
@@ -11,19 +11,20 @@ module SheepDog
 
       # Send notifications for a given list of reports.
       #
-      # Parameters:
+      # Parameters::
       # * *iConf* (<em>map<Symbol,Object></em>): The notifier config
       # * *iLstReports* (<em>list<Report></em>): List of reports to notify
-      def sendNotification(iConf, iLstReports)
+      def send_notification(iConf, iLstReports)
         lTitle = nil
         lMessage = nil
         if (iLstReports.size > 1)
           lTitle = "#{iLstReports.size} reports"
+          lMessage = ''
           iLstReports.each_with_index do |iReport, iIdx|
             lMessage << "===============================================\n"
             lMessage << "========== Report #{iIdx+1} (#{iReport.CreationTime.utc.strftime('%Y-%m-%d %H:%M:%S')} UTC from #{iReport.ReportFileName}): #{iReport.Title}\n"
             lMessage << iReport.getSimpleText
-            lMessage << "===============================================\n\n"
+            lMessage << "\n===============================================\n\n"
           end
         else
           lReport = iLstReports.first

data/lib/sheepdog/Notifiers/StdOut.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2011 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
@@ -11,19 +11,20 @@ module SheepDog
 
       # Send notifications for a given list of reports.
       #
-      # Parameters:
+      # Parameters::
       # * *iConf* (<em>map<Symbol,Object></em>): The notifier config
       # * *iLstReports* (<em>list<Report></em>): List of reports to notify
-      def sendNotification(iConf, iLstReports)
+      def send_notification(iConf, iLstReports)
         lTitle = nil
         lMessage = nil
         if (iLstReports.size > 1)
           lTitle = "#{iLstReports.size} reports"
+          lMessage = ''
           iLstReports.each_with_index do |iReport, iIdx|
             lMessage << "===============================================\n"
             lMessage << "========== Report #{iIdx+1} (#{iReport.CreationTime.utc.strftime('%Y-%m-%d %H:%M:%S')} UTC from #{iReport.ReportFileName}): #{iReport.Title}\n"
             lMessage << iReport.getSimpleText
-            lMessage << "===============================================\n\n"
+            lMessage << "\n===============================================\n\n"
           end
         else
           lReport = iLstReports.first

data/lib/sheepdog/Report.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2011 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
@@ -30,7 +30,7 @@ module SheepDog
 
     # Add an entry to the report
     #
-    # Parameters:
+    # Parameters::
     # * *iEntry* (_String_): Entry to be added
     def addEntry(iEntry)
       @Entries << iEntry
@@ -38,7 +38,7 @@ module SheepDog
 
     # Set the report's title
     #
-    # Parameters:
+    # Parameters::
     # * *iTitle* (_String_): Report's title
     def setTitle(iTitle)
       @Title = iTitle
@@ -46,7 +46,7 @@ module SheepDog
 
     # Set the report's file name
     #
-    # Parameters:
+    # Parameters::
     # * *iFileName* (_String_): Report's file name
     def setReportFileName(iFileName)
       @ReportFileName = iFileName
@@ -54,7 +54,7 @@ module SheepDog
 
     # Get the report as simple text
     #
-    # Return:
+    # Return::
     # * _String_: The report as simple text
     def getSimpleText
       return @Entries.join("\n")
@@ -62,7 +62,7 @@ module SheepDog
 
     # Is this report empty ?
     #
-    # Return:
+    # Return::
     # * _Boolean_: Is this report empty ?
     def empty?
       return @Entries.empty?

data/sheepdog.conf.rb.example

@@ -56,6 +56,9 @@
           :GroupWithOtherMonitors => true
         }
       },
+      :Conditions => {
+        :TimeRanges => [ [ '02:00:00 UTC', '03:00:00 UTC' ], [ '07:00:00 UTC', '15:00:00 UTC' ] ]
+      },
 
       :Processes => [
         {
@@ -66,7 +69,8 @@
       :Limits => {
         :CPUPercent => 5,
         :MemPercent => 5,
-        :VirtualMemSize => 16777216
+        :VirtualMemSize => 16777216,
+        :ResidentMemSize => 8192
       },
       :ActionAboveLimits => :Kill
     },
@@ -92,6 +96,25 @@
         :CmdLine => '/usr/bin/ruby /usr/bin/mongrel_rails start -p 12004 -d -e production -P log/mongrel.pid',
         :Pwd => '/my/home/rails'
       }
+    },
+
+    # Monitor global top values
+    'TopValues' => {
+      :Type => 'Top',
+      :Notifiers => {
+        'Mail' => {
+          :Type => 'Mail',
+          :Title => 'top values',
+          :GroupWithOtherMonitors => true
+        }
+      },
+      :Limits => {
+        :Loads => [ 2.00, 1.50, nil ],
+        :Memory => {
+          :MaxUsed => 4000000000,
+          :MinFree => 400000000
+        }
+      }
     }
 
   }

metadata

@@ -4,10 +4,10 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  - 20110705
-  version: 0.1.0.20110705
+  - 20120314
+  version: 0.2.0.20120314
 platform: ruby
 authors: 
 - Muriel Salvan
@@ -15,12 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-05 00:00:00 +02:00
+date: 2012-03-14 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rUtilAnts
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
 description: Simple command line tool that monitors files and processes and sends notifications or take corrective actions when problems arise. Monitor log files for errors, processes CPU and memory consumption (can kill if exceeding), respawn dead processes.
-email: murielsalvan@users.sourceforge.net
+email: muriel@x-aeon.com
 executables: 
 - sheepdog.rb
 extensions: []
@@ -32,9 +45,11 @@ files:
 - bin/sheepdog.rb
 - ChangeLog
 - Credits
+- lib/sheepdog/Common.rb
 - lib/sheepdog/Executor.rb
 - lib/sheepdog/Monitors/LogFile.rb
 - lib/sheepdog/Monitors/Process.rb
+- lib/sheepdog/Monitors/Top.rb
 - lib/sheepdog/Notifiers/SendMail.rb
 - lib/sheepdog/Notifiers/StdOut.rb
 - lib/sheepdog/Report.rb