SheepDog 0.1.0.20110705

data/AUTHORS

@@ -0,0 +1,2 @@
+= Muriel Salvan (murielsalvan@users.sourceforge.net)
+* 0.1.0.20110705

data/ChangeLog

@@ -0,0 +1,5 @@
+= StatsCollect Release History
+
+== 0.1.0.20110705 (Alpha)
+
+* Initial version

data/Credits

@@ -0,0 +1,13 @@
+= Projects used by Sheep Dog
+
+== Ruby
+* Yukihiro « matz » Matsumoto (http://www.rubyist.net/~matz/)
+* http://www.ruby-lang.org/
+* Thanks a lot Matz for this truly wonderful language !
+
+== rUtilAnts
+* Muriel Salvan (http://murielsalvan.users.sourceforge.net)
+* http://rutilants.sourceforge.net
+* Used for plugins and logging handling.
+
+= People that helped a lot in developing SheepDog

data/LICENSE

@@ -0,0 +1,31 @@
+
+The license stated herein is a copy of the BSD License (modified on July 1999).
+The AUTHOR mentionned below refers to the list of people involved in the
+creation and modification of any file included in the delivered package.
+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)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+   2. Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+   3. The name of the author may not be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+OF SUCH DAMAGE.

data/README

@@ -0,0 +1,18 @@
+-- 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.
+
+== Where is the documentation ?
+
+Check the website at http://sheepdogsys.sourceforge.net
+
+== Who wrote it ?
+
+Check the AUTHORS[link:files/AUTHORS.html] file.
+
+== What is the license ?
+
+You can find out in the LICENSE[link:files/LICENSE.html] file.

data/ReleaseInfo

@@ -0,0 +1,8 @@
+
+# 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'
+}

data/bin/sheepdog.rb

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

data/lib/sheepdog/Executor.rb

@@ -0,0 +1,288 @@
+#--
+# Copyright (c) 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'time'
+require 'fileutils'
+require 'sheepdog/Report'
+
+module SheepDog
+
+  class Executor
+
+    # Constructor
+    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')
+    end
+
+    # Execute a given configuration
+    #
+    # Parameters:
+    # * *iConf* (<em>map<Symbol,Object></em>): The sheep dog configuration
+    def execute(iConf)
+      # Get the local database, storing dates of last reports sent...
+      lDatabaseFileName = "#{iConf[:WorkingDir]}/Database"
+      lDatabase = nil
+      if (File.exists?(lDatabaseFileName))
+        lDatabase = Marshal.load(File.read(lDatabaseFileName))
+      else
+        lDatabase = {
+          # The time of last sent reports, per notifer and monitor name
+          # map< MonitorName, map< NotifierName, Time > >
+          :LastReportsSent => {}
+        }
+      end
+
+      # The list of monitor reports to be sent at the end of the process, per notifier, along with their respective configuration
+      # map< NotifierName, map< MonitorName, list < [ NotificationConf, list< ReportFileName > ] > > >
+      lGroupedMonitorReports = {}
+      # The map of monitor reports that are sent by our run
+      # map< ReportFileName >
+      lSentReports = {}
+      # The map of monitor reports that will be sent by later runs
+      # map< ReportFileName >
+      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}"
+            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))
+            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
+            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
+              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
+          end
+        end
+      end
+      if (!lGroupedMonitorReports.empty?)
+        # Send all notifications that were grouped
+        notify(iConf, lGroupedMonitorReports, lDelayedReports)
+      end
+      # Now we can delete reports that were sent and are also not marked for delayed sending
+      lSentReports.each do |iReportFileName, iNil|
+        if (!lDelayedReports.has_key?(iReportFileName))
+          File.unlink(iReportFileName)
+        end
+      end
+      # Log reports to be sent delayed
+      lDelayedReports.keys.each do |iReportFileName|
+        logInfo "Report to be sent later: #{iReportFileName}"
+      end
+
+      # Write back database
+      File.open(lDatabaseFileName, 'w') do |oFile|
+        oFile.write(Marshal.dump(lDatabase))
+      end
+    end
+
+    private
+
+    # Process notifications to be sent.
+    #
+    # 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
+    # * *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."
+        else
+          accessPlugin('Notifiers', iConf[:Notifiers][iNotifierName][:Type]) do |iNotifierPlugin|
+            # List of reports to send through this notifier
+            # list< Report >
+            lLstReports = []
+            # Set of report files that will be sent through this call
+            # map< ReportFileName, nil >
+            lReportFilesSet = {}
+            iNotifierNotificationsInfo.each do |iMonitorName, iLstMonitorNotificationsInfo|
+              iLstMonitorNotificationsInfo.each do |iMonitorNotificationsInfo|
+                iNotifierConf, iLstReportFileNames = iMonitorNotificationsInfo
+                iLstReportFileNames.each do |iReportFileName|
+                  lReport = nil
+                  begin
+                    lReport = Marshal.load(File.read(iReportFileName))
+                  rescue Exception
+                    logErr "Invalid report stored in file #{iReportFileName}: #{$!}.\n#{$!.backtrace.join("\n")}"
+                    ioErrorReports[iReportFileName] = nil
+                    lReport = nil
+                  end
+                  if (lReport != nil)
+                    lReport.setReportFileName(iReportFileName)
+                    if (iNotifierConf[:Title] != nil)
+                      lReport.setTitle(iNotifierConf[:Title])
+                    end
+                    lLstReports << lReport
+                    lReportFilesSet[iReportFileName] = nil
+                  end
+                end
+              end
+            end
+            begin
+              logInfo "===== Send notification to #{iNotifierName} of #{lLstReports.size} reports..."
+              iNotifierPlugin.sendNotification(iConf[:Notifiers][iNotifierName], lLstReports)
+            rescue Exception
+              logErr "Exception while sending notification from #{iNotifierName} for reports #{lReportFilesSet.keys.join(', ')}: #{$!}.\n#{$!.backtrace.join("\n")}"
+              ioErrorReports.merge!(lReportFilesSet)
+            end
+          end
+        end
+      end
+    end
+
+    # Get the number of seconds defined in a configuration
+    #
+    # Parameters:
+    # * *iConf* (<em>map<Symbol,Object></em>): The configuration
+    # 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}"
+        return 0
+      end
+    end
+
+  end
+
+end

data/lib/sheepdog/Monitors/LogFile.rb

@@ -0,0 +1,74 @@
+#--
+# Copyright (c) 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module SheepDog
+
+  module Monitors
+
+    class LogFile
+
+      # Execute the monitoring process for a given configuration
+      #
+      # 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))
+        else
+          lReadValues = {
+            :LastPos => 0,
+            :LastUpdate => Time.parse('1970-01-01 00:00:00 UTC')
+          }
+        end
+        if (File.exists?(iConf[:FileName]))
+          lUpdateTime = File.stat(iConf[:FileName]).mtime
+          if (lUpdateTime != lReadValues[:LastUpdate])
+            # The file was modified
+            # If the size is smaller, read from the beginning
+            lStartPos = nil
+            if (File.size(iConf[:FileName]) <= lReadValues[:LastPos])
+              lStartPos = 0
+            else
+              lStartPos = lReadValues[:LastPos]
+            end
+            # Read file
+            File.open(iConf[:FileName], 'r') do |iFile|
+              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
+                  report iLine
+                end
+              end
+              lReadValues[:LastPos] = iFile.pos
+            end
+            lReadValues[:LastUpdate] = lUpdateTime
+          end
+        else
+          report "!!! Missing file #{iConf[:FileName]}"
+          lReadValues[:LastPos] = -1
+        end
+        # Write back read values
+        File.open(lReadValuesFileName, 'w') do |oFile|
+          oFile.write(Marshal.dump(lReadValues))
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/sheepdog/Monitors/Process.rb

@@ -0,0 +1,131 @@
+#--
+# Copyright (c) 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'rUtilAnts/Misc'
+RUtilAnts::Misc::initializeMisc
+
+module SheepDog
+
+  module Monitors
+
+    class Process
+
+      # Execute the monitoring process for a given configuration
+      #
+      # Parameters:
+      # * *iConf* (<em>map<Symbol,Object></em>): The monitor configuration
+      def execute(iConf)
+        # Get the list of processes
+        # list< Integer >
+        lLstPIDs = []
+        `ps -Af`.split("\n")[1..-1].map { |iLine| iLine.strip }.each do |iLine|
+          lMatch = iLine.match(/^(\S+)\s+(\d+)\s+\d+\s+\d+\s+\S+\s+\S+\s+\S+\s+(.+)$/)
+          if (lMatch == nil)
+            report "Unable to decode ps output: \"#{iLine}\". Ignoring this line."
+          else
+            lUser, lPID, lCmd = lMatch[1..3]
+            iConf[:Processes].each do |iProcessFilterInfo|
+              if (iProcessFilterInfo.empty?)
+                report 'Process filter info is empty. ignoring it. Please check configuration.'
+              else
+                lOut = false
+                if (iProcessFilterInfo.has_key?(:UserFilter))
+                  lOut = (lUser.match(iProcessFilterInfo[:UserFilter]) == nil)
+                end
+                if ((!lOut) and
+                    (iProcessFilterInfo.has_key?(:NameFilter)))
+                  lOut = (lCmd.match(iProcessFilterInfo[:NameFilter]) == nil)
+                end
+                if (!lOut)
+                  # This PID is selected
+                  lLstPIDs << lPID.to_i
+                end
+              end
+            end
+          end
+        end
+        if (lLstPIDs.empty?)
+          # 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
+              report `#{iConf[:ExecuteIfMissing][:CmdLine]}`
+            end
+          end
+        elsif (iConf.has_key?(:Limits))
+          # Monitor the processes
+          # Set of PIDs exceeding limits
+          # map< Integer, nil >
+          lAboveLimitsPIDs = {}
+          lLstPIDs.each do |iPID|
+            lCPUPercent, lMemPercent, lVirtualSize = getPIDMetrics(iPID)
+            # Challenge metrics against limits
+            if ((iConf[:Limits].has_key?(:CPUPercent)) and
+                (lCPUPercent > iConf[:Limits][:CPUPercent]))
+              report "PID #{iPID} exceeds CPU percent limit: #{lCPUPercent} > #{iConf[:Limits][:CPUPercent]}"
+              lAboveLimitsPIDs[iPID] = nil
+            end
+            if ((iConf[:Limits].has_key?(:MemPercent)) and
+                (lMemPercent > iConf[:Limits][:MemPercent]))
+              report "PID #{iPID} exceeds Mem percent limit: #{lMemPercent} > #{iConf[:Limits][:MemPercent]}"
+              lAboveLimitsPIDs[iPID] = nil
+            end
+            if ((iConf[:Limits].has_key?(:VirtualMemSize)) and
+                (lVirtualSize > iConf[:Limits][:VirtualMemSize]))
+              report "PID #{iPID} exceeds virtual mem size limit: #{lVirtualSize} > #{iConf[:Limits][:VirtualMemSize]}"
+              lAboveLimitsPIDs[iPID] = nil
+            end
+          end
+          if (!lAboveLimitsPIDs.empty?)
+            # What to do with PIDs exceeding limits ?
+            if (iConf[:ActionAboveLimits] == :Kill)
+              # Kill them
+              report "Killing PIDs #{lAboveLimitsPIDs.keys.join(' ')} ..."
+              report `kill -9 #{lAboveLimitsPIDs.keys.join(' ')}`
+            end
+          end
+        end
+      end
+
+      private
+
+      # Get metrics of a PID
+      #
+      # Parameters:
+      # * *iPID* (_Integer_): The PID to get metrics from
+      # Return:
+      # * _Float_: The CPU percentage
+      # * _Float_: The mem percentage
+      # * _Integer_: The total virtual memory size
+      def getPIDMetrics(iPID)
+        rCPUPercent = nil
+        rMemPercent = nil
+        rVS = nil
+
+        # 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+.+$/)
+        if (lMatch == nil)
+          report "Unable to decode top output for PID #{iPID}: \"#{lTopOutput}\""
+        else
+          rCPUPercent, rMemPercent = lMatch[1..2].map { |iStrValue| iStrValue.to_f }
+        end
+        # From proc/<PID>/stat
+        lStatOutput = `cat /proc/#{iPID}/stat`.strip
+        lMatch = lStatOutput.match(/^\d+\s+\(.+\)\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+(\S+)\s+/)
+        if (lMatch == nil)
+          report "Unable to decode stat output for PID #{iPID}: \"#{lStatOutput}\""
+        else
+          rVS = lMatch[1].to_i
+        end
+
+        return rCPUPercent, rMemPercent, rVS
+      end
+
+    end
+
+  end
+
+end

data/lib/sheepdog/Notifiers/SendMail.rb

@@ -0,0 +1,49 @@
+#--
+# Copyright (c) 2010 - 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module SheepDog
+
+  module Notifiers
+
+    class SendMail
+
+      # Send notifications for a given list of reports.
+      #
+      # Parameters:
+      # * *iConf* (<em>map<Symbol,Object></em>): The notifier config
+      # * *iLstReports* (<em>list<Report></em>): List of reports to notify
+      def sendNotification(iConf, iLstReports)
+        lTitle = nil
+        lMessage = nil
+        if (iLstReports.size > 1)
+          lTitle = "#{iLstReports.size} reports"
+          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"
+          end
+        else
+          lReport = iLstReports.first
+          lTitle = "#{lReport.Title} (#{lReport.CreationTime.utc.strftime('%Y-%m-%d %H:%M:%S')} UTC from #{lReport.ReportFileName})"
+          lMessage = lReport.getSimpleText
+        end
+        require 'mail'
+        Mail.defaults do
+         delivery_method(:smtp, iConf[:SMTP])
+        end
+        Mail.deliver do
+          from iConf[:From]
+          to iConf[:To]
+          subject "SheepDog notification - #{Time.now.utc.strftime('%Y-%m-%d %H:%M:%S')} UTC - #{lTitle}"
+          body lMessage
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/sheepdog/Notifiers/StdOut.rb

@@ -0,0 +1,42 @@
+#--
+# Copyright (c) 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module SheepDog
+
+  module Notifiers
+
+    class StdOut
+
+      # Send notifications for a given list of reports.
+      #
+      # Parameters:
+      # * *iConf* (<em>map<Symbol,Object></em>): The notifier config
+      # * *iLstReports* (<em>list<Report></em>): List of reports to notify
+      def sendNotification(iConf, iLstReports)
+        lTitle = nil
+        lMessage = nil
+        if (iLstReports.size > 1)
+          lTitle = "#{iLstReports.size} reports"
+          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"
+          end
+        else
+          lReport = iLstReports.first
+          lTitle = "#{lReport.Title} (#{lReport.CreationTime.utc.strftime('%Y-%m-%d %H:%M:%S')} UTC from #{lReport.ReportFileName})"
+          lMessage = lReport.getSimpleText
+        end
+        puts lTitle
+        puts
+        puts lMessage
+      end
+
+    end
+
+  end
+
+end

data/lib/sheepdog/Report.rb

@@ -0,0 +1,73 @@
+#--
+# Copyright (c) 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module SheepDog
+
+  # A report is a collection of entries, associated to a monitor run
+  class Report
+
+    # Title of the report
+    #   String
+    attr_reader :Title
+
+    # File name of the report
+    #   String
+    attr_reader :ReportFileName
+
+    # Time of this report's creation (UTC)
+    #   Time
+    attr_reader :CreationTime
+
+    # Constructor
+    def initialize
+      @Entries = []
+      @CreationTime = Time.now
+      @ReportFileName = nil
+      @Title = nil
+    end
+
+    # Add an entry to the report
+    #
+    # Parameters:
+    # * *iEntry* (_String_): Entry to be added
+    def addEntry(iEntry)
+      @Entries << iEntry
+    end
+
+    # Set the report's title
+    #
+    # Parameters:
+    # * *iTitle* (_String_): Report's title
+    def setTitle(iTitle)
+      @Title = iTitle
+    end
+
+    # Set the report's file name
+    #
+    # Parameters:
+    # * *iFileName* (_String_): Report's file name
+    def setReportFileName(iFileName)
+      @ReportFileName = iFileName
+    end
+
+    # Get the report as simple text
+    #
+    # Return:
+    # * _String_: The report as simple text
+    def getSimpleText
+      return @Entries.join("\n")
+    end
+
+    # Is this report empty ?
+    #
+    # Return:
+    # * _Boolean_: Is this report empty ?
+    def empty?
+      return @Entries.empty?
+    end
+
+  end
+
+end

data/sheepdog.conf.rb.example

@@ -0,0 +1,98 @@
+{
+
+  # The working directory, where SheepDog keeps reports waiting to be sent for notification and its private database
+  :WorkingDir => '/my/home/sheepdog_work',
+
+  # Define notifiers
+  :Notifiers => {
+
+    'Mail' => {
+      :Type => 'SendMail',
+      :SMTP => {
+        :address => 'localhost',
+        :port => 25,
+        :domain => 'mail.domain.com',
+        :user_name => 'smtpuser',
+        :password => 'password',
+        :authentication => nil,
+        :enable_starttls_auto => false
+      },
+      :From => 'SheepDog@domain.com',
+      :To => 'Admin@domain.com'
+    }
+
+  },
+
+  # Monitor
+  :Monitors => {
+
+    # Monitor production log file of Rails
+    'RailsLog' => {
+      :Type => 'LogFile',
+      :Notifiers => {
+        'Mail' => {
+          :Type => 'Mail',
+          :GroupReports => {
+            :Interval_Secs => 60*60*24
+          },
+          :Title => 'Rails production log file',
+          :GroupWithOtherMonitors => true
+        }
+      },
+
+      :FileName => '/my/home/rails/log/production.log',
+      :Filters => [
+        /Error/
+      ]
+    },
+
+    # Monitor StatsCollect process
+    'StatsCollect' => {
+      :Type => 'Process',
+      :Notifiers => {
+        'Mail' => {
+          :Type => 'Mail',
+          :Title => 'StatsCollect process',
+          :GroupWithOtherMonitors => true
+        }
+      },
+
+      :Processes => [
+        {
+          :UserFilter => /username/,
+          :NameFilter => /StatsCollect\.rb/
+        }
+      ],
+      :Limits => {
+        :CPUPercent => 5,
+        :MemPercent => 5,
+        :VirtualMemSize => 16777216
+      },
+      :ActionAboveLimits => :Kill
+    },
+
+    # Monitor the mongrel server
+    'Mongrel' => {
+      :Type => 'Process',
+      :Notifiers => {
+        'Mail' => {
+          :Type => 'Mail',
+          :Title => 'Mongrel server',
+          :GroupWithOtherMonitors => true
+        }
+      },
+
+      :Processes => [
+        {
+          :UserFilter => /mongreluser/,
+          :NameFilter => /mongrel_rails start/
+        }
+      ],
+      :ExecuteIfMissing => {
+        :CmdLine => '/usr/bin/ruby /usr/bin/mongrel_rails start -p 12004 -d -e production -P log/mongrel.pid',
+        :Pwd => '/my/home/rails'
+      }
+    }
+
+  }
+}

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: SheepDog
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  - 20110705
+  version: 0.1.0.20110705
+platform: ruby
+authors: 
+- Muriel Salvan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-05 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+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
+executables: 
+- sheepdog.rb
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- AUTHORS
+- bin/sheepdog.rb
+- ChangeLog
+- Credits
+- lib/sheepdog/Executor.rb
+- lib/sheepdog/Monitors/LogFile.rb
+- lib/sheepdog/Monitors/Process.rb
+- lib/sheepdog/Notifiers/SendMail.rb
+- lib/sheepdog/Notifiers/StdOut.rb
+- lib/sheepdog/Report.rb
+- LICENSE
+- README
+- ReleaseInfo
+- sheepdog.conf.rb.example
+has_rdoc: true
+homepage: http://sheepdogsys.sourceforge.net/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: sheepdogsys
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: System administration helper to monitor files and processes.
+test_files: []
+