bacuwatch 1.5

data/bacuwatch/README.bacuwatch

@@ -0,0 +1,37 @@
+The Bacuwatch program can be used to keep a watch on a group of Bacula
+jobs.  Typically, it is run periodically from a cron job, and is
+generally configured to send an email message with a single line
+status report on each backup job to the Bacula administrator and
+optionally to send a more detailed report on each job to the user of
+the machine which that job backs up.
+
+A typical summary report would consist of a series of single-line
+reports, such as:
+
+    Okay for delta-force; (Full: 24 days; Last: 5 hours)
+
+A typical job report contains the same information, but additionally
+(and at no extra charge) shows the storage volume and number of files
+backed up, for example:
+
+    Hello Most Honorable Sensai Norris,
+
+    This is the Bacula Watcher program, reporting on the state of
+    the backup job, delta-force, for your computer.
+
+      - The last full backup ran 24 days ago,
+	on Saturday, October 21, 2006.
+	It contained 5 gigabytes of data in 172,198 files.
+
+      - The last incremental backup ran 5 hours ago,
+	on Tuesday, November 14, 2006.
+	It contained 28 megabytes of data in 81 files.
+
+    All seems well with the 'delta-force' backup job.
+
+When run with no options, the bacuwatch program prints out a job
+summary.  To have it periodically email summary and status reports,
+for example at 10:00 every Tuesday morning, the crontab entry would
+be:
+
+    0 10 * * 2 cd $HOME/bacuview/bacuwatch && ./bacuwatch -summary -notify

data/bacuwatch/bacuwatch

@@ -0,0 +1,214 @@
+#! /usr/bin/ruby -sw
+
+#require "rubygems"
+#require "pp"
+require "mysql"
+require "postgres"
+require "time"
+
+#
+# Define the configuration language, and read in the configuration.
+#
+
+@db_args = {
+  "dbms" => "postgres", "host" => "localhost",
+  "database" => "bacula", "user" => "bacuview", "password" => "bacuview"
+}
+def db(*args)
+  @db_args.merge!(args[0])
+end
+  
+@mail_suffix = nil
+def mailhost(hostname)
+  @mail_suffix = hostname
+end
+
+def mail_fixup(addr)
+  return nil unless addr
+  addr.gsub(/@$/, "@#{@mail_suffix}")
+end
+
+@summaries_to = []
+def summary(*addrs)
+  @summaries_to += addrs.map{ |addr| mail_fixup(addr) }
+end
+
+@watched = []
+def watch(job, addr=nil, name=nil)
+  @watched << [ job, mail_fixup(addr), name ]
+end
+
+config_path =
+  [
+   defined?($config) && $config,
+   File.join(File.dirname(__FILE__), 'bacuwatch.conf'),
+   File.join(ENV["HOME"], '.bacuwatch.conf'),
+   '/etc/bacuwatch.conf'
+  ].compact
+config = config_path.find{|fn| File.exist? fn}
+if not config
+  puts [ "No config file found among:", config_path ].join("\n    ")
+  exit
+end
+load config
+
+class Numeric
+  def days
+    self * 86400
+  end
+
+  def ago
+    d = self
+    return "never" if d <= 0
+    return (d).to_s + " seconds" if d < 2*60
+    return (d/60).to_s + " minutes" if d < 2*60*60
+    return (d/(60*60)).to_s + " hours" if d < 2*60*60*24
+    return (d/(60*60*24)).to_s + " days" if d < 2*60*60*24*30
+    return (d/(60*60*24*30)).to_s + " months" if d < 2*60*60*24*365
+    return (d/(60*60*24*365)).to_s + " years"
+  end
+end
+
+class String
+  def commatize
+    return self if size < 5
+    self.reverse.gsub(/(\d{3}\B)/, '\1,').reverse
+  end
+
+  def suffixize
+    n = self.to_i
+    return self + " " if n < 1000*2
+    return (n/1000).to_s + " kilo" if n < 1000*1000*2
+    return (n/(1000*1000)).to_s + " mega" if n < 1000*1000*1000*2
+    return (n/(1000*1000*1000)).to_s + " giga" if n < 1000*1000*1000*1000*2
+    return (n/(1000*1000*1000*1000)).to_s + " tera"
+  end
+end
+
+class Watcher
+  attr :stat
+  attr :report
+
+  @@summary_msg = []
+  def self.summary
+    @@summary_msg.map{ |s| s.gsub!(/^(\S)/, '    \1') }
+    @@summary_msg.sort!
+    @@summary_msg
+  end
+
+  def initialize(db, dbms, job, name)
+    @db = db
+    @dbms = dbms
+    @report = []
+
+    report << "Hello" + (name ? " #{name}" : "") + ","
+    report << ""
+    report << "This is the Bacula Watcher program, reporting on the state of"
+    report << "the backup job, #{job}, for your computer."
+    report << ""
+    full = summarize(job, "F")
+    incr = summarize(job, "I")
+    status(job, full, incr)
+    report.join("\n")
+  end
+
+  def query_job(job, level=nil)
+    query = "select starttime, jobfiles, jobbytes, level " +
+      "from Job where type='B' and jobstatus='T' and " +
+      "name='#{job}' and level='#{level}' order by starttime desc limit 1;"
+    if @dbms == "mysql"
+      @db.query(query).fetch_row
+    else
+      @db.exec(query).result[0]
+    end
+  end
+
+  def summarize(job, level)
+    l = { "I" => "incremental", "F" => "full" }[level] || level
+    r = query_job(job, level)
+    if r == nil
+      report << "  - There has never been a #{l} backup performed."
+      d = nil
+    else
+      t = Time.parse(r[0])
+      d = (Time.now - t).to_i
+      report <<
+        "  - The last #{l} backup ran #{d.ago} ago,\n" +
+        "    on #{t.strftime('%A, %B %d, %Y')}.\n" +
+        "    It contained #{r[2].suffixize}bytes of data " +
+        "in #{r[1].commatize} files."
+    end
+    report << ""
+    return d
+  end
+
+  def status(job, full, incr)
+    last = incr ? (full && full < incr ? full : incr) : full
+    err = []
+    if !full
+      err << "  - The #{job} backup job has never run successfully."
+    else
+      err << "  - The last full backup is too old."   if full > 45.days
+      err << "  - The most recent backup is too old." if last > 15.days
+    end
+
+    if err.empty?
+      @stat = "Okay"
+      report << "All seems well with the '#{job}' backup job."
+    else
+      @stat = "ERROR"
+      report << "There seems to be a PROBLEM with the '#{job}' backup job."
+      [ "", err, "" ].flatten.each do |e| report << e end
+    end
+    @@summary_msg << "#{stat} for #{job}; " + 
+      "(Full: #{full.to_i.ago}; Last: #{last.to_i.ago})"
+  end
+end
+
+def mail_to(addr, subject, msg)
+  mail = open("|mail -s '#{subject}' #{addr}", "w")
+  mail.puts msg
+  mail.close
+end
+
+if defined?($help) and $help
+  print <<-EOF
+bacuwatch [-help] [-quiet] [-summary] [-notify] [-config <config-file>]
+
+    -help:     Prints this help information.
+    -quiet:    Disables printing the summary report to standard output.
+    -config:   Specifies a configuration file.
+    -summary:  Emails a summary report to each of the addresses 
+               listed in a "summary" statement.
+    -notify:   Emails a job report to the email address 
+               listed in the "watch" statement for that job.
+EOF
+  exit
+end
+
+if @db_args["dbms"] == "mysql"
+  db = Mysql.new(@db_args["host"],
+                 @db_args["user"], @db_args["password"], @db_args["database"])
+else
+  db = PGconn.new(@db_args["host"], 5432, "", "", @db_args["database"],
+                  @db_args["user"], @db_args["password"])
+end
+@watched.each { |watch_info|
+  job, addr, name = watch_info
+  w = Watcher.new(db, @db_args["dbms"], job, name)
+  subject = "Bacula Watcher: #{w.stat} for #{job}."
+  if addr and defined?($notify) and $notify
+    mail_to(addr, subject, w.report)
+  end
+}
+db.close
+
+if defined?($summary) and $summary
+  @summaries_to.each { |addr|
+    mail_to(addr, "Bacula Watch Summary Report", Watcher::summary)
+  }
+end
+
+if !defined?($quiet) or !$quiet
+  puts Watcher::summary
+end

data/bacuwatch/bacuwatch.conf.template

@@ -0,0 +1,53 @@
+#
+# bacuwatch.conf -- the configuration file for the bacuwatch program.
+#
+#----
+#
+# A 'db' statement is required to define the connection to the bacula
+# database.  Only those parameters that differ from the default values
+# below need to be supplied, so a statement along the lines of:
+#
+#   db "host" => "db-server", "password" => "abracadabara"
+#
+# will likely suffice.  The possible arguments and their defaults are:
+#
+#   "dbms" => "postgres", "host" => "localhost",
+#   "database" => "bacula", "user" => "bacuview", "password" => "bacuview"
+#
+#
+#----
+#
+# A 'mailhost' statement can be used to abbreviate email addresses in a
+# common domain.  Email addresses ending in an at-sign (@) will be sent
+# to the domain listed in the mailhost statement, so a mailhost
+# statement of:
+#
+#   mailhost "example.org"
+#
+# will cause "carol@" in a 'watch' or 'summary' statement to be
+# expanded to "carol@example.org", while email addresses not ending in
+# an at-sign are used as is.  This statement goes into effect when
+# seen, so must preceed its first use, but can be changed in mid-file.
+#
+#----
+#
+# A 'watch' statement is used to place a watch on a particular job.
+# The watch statement takes three parameters: a mandatory job name,
+# an optional email address, and an optional name or title.  So, watch
+# statements of:
+#
+#   watch "delta-force"
+#   watch "delta-force", "chuck@norris.org"
+#   watch "delta-force", "chuck@norris.org", "Most Honorable Sensai Norris"
+#
+# would watch the 'delta-force' backup job; watch the 'delta-force'
+# backup job and send a report to chuck@norris.org; and watch the
+# 'delta-force' backup job, sending a report to chuck@norris.org using
+# the properly honorific title.
+#
+#----
+#
+# A 'summary' statement is used to email a single-line summary of the
+# status of each job to each of the addresses supplied, for example:
+#
+#   summary "alice@example.org", "bob@example.net"

data/bin/bacuwatch

@@ -0,0 +1,214 @@
+#! /usr/bin/ruby -sw
+
+#require "rubygems"
+#require "pp"
+require "mysql"
+require "postgres"
+require "time"
+
+#
+# Define the configuration language, and read in the configuration.
+#
+
+@db_args = {
+  "dbms" => "postgres", "host" => "localhost",
+  "database" => "bacula", "user" => "bacuview", "password" => "bacuview"
+}
+def db(*args)
+  @db_args.merge!(args[0])
+end
+  
+@mail_suffix = nil
+def mailhost(hostname)
+  @mail_suffix = hostname
+end
+
+def mail_fixup(addr)
+  return nil unless addr
+  addr.gsub(/@$/, "@#{@mail_suffix}")
+end
+
+@summaries_to = []
+def summary(*addrs)
+  @summaries_to += addrs.map{ |addr| mail_fixup(addr) }
+end
+
+@watched = []
+def watch(job, addr=nil, name=nil)
+  @watched << [ job, mail_fixup(addr), name ]
+end
+
+config_path =
+  [
+   defined?($config) && $config,
+   File.join(File.dirname(__FILE__), 'bacuwatch.conf'),
+   File.join(ENV["HOME"], '.bacuwatch.conf'),
+   '/etc/bacuwatch.conf'
+  ].compact
+config = config_path.find{|fn| File.exist? fn}
+if not config
+  puts [ "No config file found among:", config_path ].join("\n    ")
+  exit
+end
+load config
+
+class Numeric
+  def days
+    self * 86400
+  end
+
+  def ago
+    d = self
+    return "never" if d <= 0
+    return (d).to_s + " seconds" if d < 2*60
+    return (d/60).to_s + " minutes" if d < 2*60*60
+    return (d/(60*60)).to_s + " hours" if d < 2*60*60*24
+    return (d/(60*60*24)).to_s + " days" if d < 2*60*60*24*30
+    return (d/(60*60*24*30)).to_s + " months" if d < 2*60*60*24*365
+    return (d/(60*60*24*365)).to_s + " years"
+  end
+end
+
+class String
+  def commatize
+    return self if size < 5
+    self.reverse.gsub(/(\d{3}\B)/, '\1,').reverse
+  end
+
+  def suffixize
+    n = self.to_i
+    return self + " " if n < 1000*2
+    return (n/1000).to_s + " kilo" if n < 1000*1000*2
+    return (n/(1000*1000)).to_s + " mega" if n < 1000*1000*1000*2
+    return (n/(1000*1000*1000)).to_s + " giga" if n < 1000*1000*1000*1000*2
+    return (n/(1000*1000*1000*1000)).to_s + " tera"
+  end
+end
+
+class Watcher
+  attr :stat
+  attr :report
+
+  @@summary_msg = []
+  def self.summary
+    @@summary_msg.map{ |s| s.gsub!(/^(\S)/, '    \1') }
+    @@summary_msg.sort!
+    @@summary_msg
+  end
+
+  def initialize(db, dbms, job, name)
+    @db = db
+    @dbms = dbms
+    @report = []
+
+    report << "Hello" + (name ? " #{name}" : "") + ","
+    report << ""
+    report << "This is the Bacula Watcher program, reporting on the state of"
+    report << "the backup job, #{job}, for your computer."
+    report << ""
+    full = summarize(job, "F")
+    incr = summarize(job, "I")
+    status(job, full, incr)
+    report.join("\n")
+  end
+
+  def query_job(job, level=nil)
+    query = "select starttime, jobfiles, jobbytes, level " +
+      "from Job where type='B' and jobstatus='T' and " +
+      "name='#{job}' and level='#{level}' order by starttime desc limit 1;"
+    if @dbms == "mysql"
+      @db.query(query).fetch_row
+    else
+      @db.exec(query).result[0]
+    end
+  end
+
+  def summarize(job, level)
+    l = { "I" => "incremental", "F" => "full" }[level] || level
+    r = query_job(job, level)
+    if r == nil
+      report << "  - There has never been a #{l} backup performed."
+      d = nil
+    else
+      t = Time.parse(r[0])
+      d = (Time.now - t).to_i
+      report <<
+        "  - The last #{l} backup ran #{d.ago} ago,\n" +
+        "    on #{t.strftime('%A, %B %d, %Y')}.\n" +
+        "    It contained #{r[2].suffixize}bytes of data " +
+        "in #{r[1].commatize} files."
+    end
+    report << ""
+    return d
+  end
+
+  def status(job, full, incr)
+    last = incr ? (full && full < incr ? full : incr) : full
+    err = []
+    if !full
+      err << "  - The #{job} backup job has never run successfully."
+    else
+      err << "  - The last full backup is too old."   if full > 45.days
+      err << "  - The most recent backup is too old." if last > 15.days
+    end
+
+    if err.empty?
+      @stat = "Okay"
+      report << "All seems well with the '#{job}' backup job."
+    else
+      @stat = "ERROR"
+      report << "There seems to be a PROBLEM with the '#{job}' backup job."
+      [ "", err, "" ].flatten.each do |e| report << e end
+    end
+    @@summary_msg << "#{stat} for #{job}; " + 
+      "(Full: #{full.to_i.ago}; Last: #{last.to_i.ago})"
+  end
+end
+
+def mail_to(addr, subject, msg)
+  mail = open("|mail -s '#{subject}' #{addr}", "w")
+  mail.puts msg
+  mail.close
+end
+
+if defined?($help) and $help
+  print <<-EOF
+bacuwatch [-help] [-quiet] [-summary] [-notify] [-config <config-file>]
+
+    -help:     Prints this help information.
+    -quiet:    Disables printing the summary report to standard output.
+    -config:   Specifies a configuration file.
+    -summary:  Emails a summary report to each of the addresses 
+               listed in a "summary" statement.
+    -notify:   Emails a job report to the email address 
+               listed in the "watch" statement for that job.
+EOF
+  exit
+end
+
+if @db_args["dbms"] == "mysql"
+  db = Mysql.new(@db_args["host"],
+                 @db_args["user"], @db_args["password"], @db_args["database"])
+else
+  db = PGconn.new(@db_args["host"], 5432, "", "", @db_args["database"],
+                  @db_args["user"], @db_args["password"])
+end
+@watched.each { |watch_info|
+  job, addr, name = watch_info
+  w = Watcher.new(db, @db_args["dbms"], job, name)
+  subject = "Bacula Watcher: #{w.stat} for #{job}."
+  if addr and defined?($notify) and $notify
+    mail_to(addr, subject, w.report)
+  end
+}
+db.close
+
+if defined?($summary) and $summary
+  @summaries_to.each { |addr|
+    mail_to(addr, "Bacula Watch Summary Report", Watcher::summary)
+  }
+end
+
+if !defined?($quiet) or !$quiet
+  puts Watcher::summary
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: bacuwatch
+version: !ruby/object:Gem::Version 
+  version: "1.5"
+date: 2006-12-03 00:00:00 -05:00
+summary: An app to periodically report on a Bacula backup system.
+require_paths: 
+- lib
+email: john@kodis.org
+homepage: 
+rubyforge_project: 
+description: Bacuwatch is an application normally run from a cron job to email out reports on the status of a series of bacula jobs.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- John Kodis
+files: 
+- bacuwatch/bacuwatch
+- bacuwatch/bacuwatch.conf.template
+- bacuwatch/README.bacuwatch
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- bacuwatch
+extensions: []
+
+requirements: []
+
+dependencies: []
+