servicemonitor 0.1.4 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c21b93e6591e1fdb7d9ab33bfbb185c2fc1a770d
+  data.tar.gz: 70a604920114a521584fc6776aa495d0e1893aca
+SHA512:
+  metadata.gz: 30e355380f2cad7c5f25592b3d5eb95c2bcf2efcf402001f42e496b6abbafdb27cda3af48faa548d1e40b6350cec7c97cea3aaf136539e8fa5f06f8a5f6e3a59
+  data.tar.gz: c177caef1a73ae735546cdef63113a7807710c9c287114395e331a21e227fcad977ee5c5f4907bef01aefc855667274b1e68ca709b7aea06e7d1b985d6d281a3

data/bin/servicemonitor

@@ -1,46 +1,45 @@
 #!/usr/bin/env ruby
 
-#Add the currently running directory to the start of the load path
+# Add the currently running directory to the start of the load path
 $:.unshift './'
 
 require 'net/smtp'
-require "Alert"
-require "Alert/Email"
-require "MonitorType"
-require "MonitorType/Threshold"
-require "MonitorType/Beanstalk"
-require "MonitorType/Dir"
-require "MonitorType/FluidDb"
-require "MonitorType/Process"
-require "MonitorType/HttpGetJsonList"
-require "MonitorManager"
-require "helper_functions"
-
-
-#Don't buffer stdout
+require 'Alert'
+require 'Alert/Email'
+require 'MonitorType'
+require 'MonitorType/Threshold'
+require 'MonitorType/Beanstalk'
+require 'MonitorType/Dir'
+require 'MonitorType/FluidDb'
+require 'MonitorType/Process'
+require 'MonitorType/HttpGetJsonList'
+require 'MonitorManager'
+require 'helper_functions'
+
+# Don't buffer stdout
 $stdout.sync = true
 
-abort( "Usage: servicemonitor <path to dsl>" ) if ARGV.length != 1
+abort('Usage: servicemonitor <path to dsl>') if ARGV.length != 1
 
-dslName = ARGV[0]
+dsl_name = ARGV[0]
 
-#Need to remove file name extension
-ENV["APP_NAME"] = File.basename( dslName ) if ENV["APP_NAME"].nil?
+# Need to remove file name extension
+ENV['APP_NAME'] = File.basename(dsl_name) if ENV['APP_NAME'].nil?
 
 $a = MonitorManager.new
 
-log "Loading dsl, #{dslName}"
+log "Loading dsl, #{dsl_name}"
 begin
-    load dslName
-    $a.run
-    rescue ArgumentError=>e
-        puts "*** Your dsl is not formatted correctly"
-        puts "*** Ensure each line has the format,"
-        puts "***   <command>, [:arg=>value]"
-    rescue SystemExit=>e
+  load dsl_name
+  $a.run
+rescue ArgumentError
+  puts "*** Your dsl is not formatted correctly\n" \
+       "*** Ensure each line has the format,\n" \
+       "***   <command>, [:arg=>value]\n"
+rescue SystemExit
 #    rescue SIGTERM=>e
-    rescue Exception=>e
-puts "What the ..."
-        puts e.class.name
-        puts e.message
+rescue StandardError
+  puts 'What the ...'
+  puts e.class.name
+  puts e.message
 end

data/lib/alert/email.rb

@@ -0,0 +1,41 @@
+require 'net/smtp'
+require 'Alert'
+
+# Email alert class
+# Uses localhost for sending email - Probably need to change this in the future.
+class AlertEmail
+  def initialize(sender, destination, body)
+    @sender = sender
+    @body = body
+
+    @smtp_address = ENV['smtp_address'].nil? ? 'localhost' : ENV['smtp_address']
+    @smtp_port = ENV['smtp_port'].nil? ? 25 : ENV['smtp_port']
+
+    @destination = destination
+    if destination.is_a? Array
+      @destination_fmt = "<#{destination.join('>,<')}>"
+    else
+      @destination_fmt = destination
+    end
+  end
+
+  def send
+    message = <<MESSAGE_END
+From: #{ENV['APP_NAME']} #{@sender}
+To: #{@destination_fmt}
+Subject: #{ENV['APP_NAME']} Alert
+
+#{@body}
+.
+MESSAGE_END
+
+  Net::SMTP.start(@smtp_address,@smtp_port) do |smtp|
+    smtp.send_message message, @sender, @destination
+  end
+
+  rescue Errno::ECONNREFUSED
+    puts "*** Conection refused while attempting to connect to SMTP server\n" \
+         "*** Recipient, #{@destination}. Body,\n" \
+         "*** #{@body}\n"
+  end
+end

data/lib/alert.rb

@@ -0,0 +1,6 @@
+# Base class / Interface for implementing alert types
+class Alert
+  def send(_destination, _body)
+    fail 'Method needs to be overridden'
+  end
+end

data/lib/helper_functions.rb

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

data/lib/monitor_manager.rb

@@ -0,0 +1,35 @@
+# Monitor Manager
+class MonitorManager
+  def initialize
+    @list = []
+  end
+
+  def add(monitor)
+    @list.push monitor
+  end
+
+  # The main run loop
+  def run
+    Kernel.loop do
+      @list.each do |m|
+        begin
+          m.run
+        rescue MonitorTypeExceptionHandled => e
+          m.alert(e.message)
+        end
+      end
+      sleep 0.2
+    end
+
+  rescue Interrupt
+    string = "Exiting on request ...\n"
+    puts string
+
+  rescue StandardError
+    string = "#{e.class.name}\n" \
+             "*** This is really unexpected.\n" \
+             "Message: #{e.message}\n" \
+             "#{e.backtrace}\n"
+    puts string
+  end
+end

data/lib/monitor_type/beanstalk.rb

@@ -0,0 +1,35 @@
+require 'beanstalk-client'
+require 'monitor_type/threshold'
+
+# A Beanstalk class for checking how many msgs are in a Queue
+class MonitorTypeBeanstalk < MonitorTypeThreshold
+  # Extract parameters
+  #
+  # @param [String] beanstalk Optional connection string. Default to local
+  # @param [String] queue Name of queue to monitor
+  def extract_params
+    @connection_string = @params[:beanstalk] || 'localhost:11300'
+
+    if @params[:queue].nil?
+      string = "*** Beanstalk parameter missing, queue\n" \
+               '*** :queue => <queue name>'
+      fail MonitorTypeParameterMissingError, string
+    end
+    @queue = @params[:queue]
+
+    @context_sentence = "Checking number of jobs in queue, #{@queue}"
+  end
+
+  def setup
+    @beanstalk = Beanstalk::Pool.new([@connection_string])
+  end
+
+  def derived_value
+    tube_stats = @beanstalk.stats_tube(@queue)
+    tube_stats['current-jobs-ready']
+  end
+end
+
+def beanstalk(params)
+  $a.add(MonitorTypeBeanstalk.new(params))
+end

data/lib/monitor_type/dir.rb

@@ -0,0 +1,45 @@
+require 'monitor_type/threshold'
+
+# A directory class for checking how many files are in a directory
+class MonitorTypeDir < MonitorTypeThreshold
+  # Extract parameters
+  #
+  # @param [String] path Path to directory to check
+  def extract_params
+    if @params[:path].nil?
+      string = "*** Dir parameter missing, path\n" \
+               '*** :path => <path to directory to be monitored>'
+      fail MonitorTypeParameterMissingError, string
+    end
+    @path = @params[:path]
+
+    @context_sentence = "Checking number of files in, #{@path}"
+  end
+
+  def setup
+    input_dir = Dir.new(@path)
+    @path = input_dir.path
+    @params[:dir] = input_dir
+
+  rescue Errno::ENOENT
+    str = "***** Directory does not exist, #{@path}.\n" \
+          "***** Create the directory, #{@path}, and try again.\n" \
+          "***** eg, mkdir #{@path}"
+    raise MonitorTypeExceptionHandled, str
+  rescue Errno::ENOTDIR
+    str = '***** The specified path does not point to a ' \
+          "directory, #{@path}.\n" \
+          '***** Either repoint path to a directory, ' \
+          "or remove, #{@path}, and create it as a directory.\n" \
+          "***** eg, rm #{@path} && mkdir #{@path}"
+    raise MonitorTypeExceptionHandled, str
+  end
+
+  def derived_value
+    Dir.glob("#{@path}/*").length
+  end
+end
+
+def dir(params)
+  $a.add(MonitorTypeDir.new(params))
+end

data/lib/monitor_type/drive.rb

@@ -0,0 +1,49 @@
+require 'monitor_type/threshold'
+require 'sys/filesystem'
+include Sys
+
+# MonitorType Drive
+class MonitorTypeDrive < MonitorTypeThreshold
+  def extract_params
+    if @params[:path].nil?
+      string = "*** Drive parameter missing, drive\n" \
+               '*** :drive => <name of the drive to be monitored>'
+      fail MonitorTypeParameterMissingError, string
+    end
+    @path = @params[:path]
+
+    log "#{@process_name}", "result: #{(@process_name =~ /^(.*\[{1}.+\]{1}.*)$|^(\w+)$/) == 0}"
+
+    if @params[:min].nil?
+      string = "*** Min parameter missing, min\n" \
+               '*** :min => <the minimum amount of free space on ' \
+               'the drive to be monitored>'
+      fail MonitorTypeParameterMissingError, string
+    end
+
+    log '*** Max value will be ignored, setting to nil' unless @params[:max].nil?
+    @max = nil
+
+    @context_sentence = 'Checking that available drive space is greater ' \
+                        "than min, #{@process_name}"
+  end
+
+  def setup
+    # Check that the path exists
+    Filesystem.stat(@path)
+
+  rescue
+    string = "*** Unable to mount the specifed path\n" \
+             "*** path: #{@path}\n" \
+             "*** Please fix the error and run again\n"
+    raise MonitorTypeExceptionHandled, string
+  end
+
+  def derived_value
+    ((Filesystem.stat(@path).blocks_available.to_f / Filesystem.stat(@path).blocks.to_f) * 100).round(2)
+  end
+end
+
+def process(params)
+  $a.add(MonitorTypeDrive.new(params))
+end

data/lib/monitor_type/fluiddb.rb

@@ -0,0 +1,71 @@
+require 'FluidDb'
+require 'monitor_type/threshold'
+
+# A database class for checking a single number against a threshold.
+# For example,
+#  get the max timestamp from a table as a date.
+#  subtract this from now
+#  => check that the number is not greater than 2
+class MonitorTypeFluidDb < MonitorTypeThreshold
+  # Extract parameters
+  #
+  # @param [String] uri Connection string to db
+  # @param [String] sql SQL statement to gather a single value
+  def extract_params
+    if @params[:uri].nil?
+      string = "*** FluidDb parameter missing, uri\n" \
+               "*** :uri => <uri pointing to db to be monitored>"
+      fail MonitorTypeParameterMissingError, string
+    end
+    begin
+      @uri = URI.parse(@params[:uri])
+    rescue URI::InvalidURIError
+      string = '*** FluidDb encountered an error while parsing the uri' \
+               "*** uri: #{@params[:uri]}" \
+               "*** Please fix the uri and run again"
+      raise MonitorTypeParameterMissingError, string
+    end
+
+    if @params[:sql].nil?
+      string = '*** FluidDb parameter missing, sql' \
+               "*** :sql => <sql statement, producing a single " \
+               'column, single row which yeidls a number>'
+      fail MonitorTypeParameterMissingError, string
+    end
+    @sql = @params[:sql]
+    @context_sentence = "Checking result of sql query, #{@sql}"
+  end
+
+  # Create the connection to the db, and get the value
+  # This ensures that all params are correct.
+  def setup
+    begin
+      @fluid_db = FluidDb.Db(@uri)
+    rescue StandardError => e
+      string = "*** FluidDb encountered an error while connecting to the db\n" \
+               "*** Error: #{e.message}\n" \
+               "*** uri: #{@uri}\n" \
+               "*** Please fix the error and run again\n"
+      raise MonitorTypeExceptionHandled, string
+    end
+
+    @params[:fluidDb] = @fluid_db
+  end
+
+  def derived_value
+    @fluid_db.queryForValue(@sql, [])
+  rescue StandardError
+    string = "*** FluidDb encountered an error while running the sql\n" \
+             "*** sql: #{@sql}\n" \
+             "*** Please fix the query and run again\n"
+    raise MonitorTypeExceptionHandled, string
+  end
+
+  def teardown
+    @fluid_db.close
+  end
+end
+
+def fluiddb(params)
+  $a.add(MonitorTypeFluidDb.new(params))
+end

data/lib/monitor_type/http_get_json_list.rb

@@ -0,0 +1,53 @@
+require 'restclient'
+require 'monitor_type/threshold'
+
+# An http class for checking the length of a json list.
+# For example,
+#  Get the list of outstandinig errors
+#  => check that the number is not greater than 2
+class MonitorTypeHttpGetJsonList < MonitorTypeThreshold
+  # Extract parameters
+  #
+  # @param [String] uri Connection string to db
+  # @param [String] sql SQL statement to gather a single value
+  def extract_params
+    if @params[:uri].nil?
+      string = "*** HttpGetJsonList parameter missing, uri\n" \
+               '*** :uri => <uri pointing to url to be monitored>'
+      fail MonitorTypeParameterMissingError, string
+    end
+
+    begin
+      @uri = URI.parse(@params[:uri])
+    rescue URI::InvalidURIError
+      str = '*** HttpGetJsonList encountered an error while parsing the uri' \
+            "*** uri: #{@params[:uri]}" \
+            '*** Please fix the uri and run again'
+      raise MonitorTypeParameterMissingError, str
+    end
+
+    url = "#{@uri.scheme}://#{@uri.host}#{@uri.path}"
+    @context_sentence = "Checking size of json list returned from, #{url}"
+  end
+
+  def derived_value
+    content = RestClient.get(@uri.to_s)
+    list = JSON.parse(content)
+    str = "Expected type, Array - Actual type, #{list.class.name}"
+    fail MonitorTypeExceptionHandled, str unless list.class.name == 'Array'
+    list.length
+  rescue MonitorTypeExceptionHandled
+    raise e
+
+  rescue StandardError
+    string = '*** HttpGetJsonList encountered an error while running the ' \
+             'HTTP Get\n' \
+             "*** uri: #{@uri}\n" \
+              "*** Please fix the query and run again\n"
+    raise MonitorTypeExceptionHandled, string
+  end
+end
+
+def httpgetjsonlist(params)
+  $a.add(MonitorTypeHttpGetJsonList.new(params))
+end