servicemonitor 0.1.4 → 0.2.0

data/lib/monitor_type/process.rb

@@ -0,0 +1,60 @@
+require 'monitor_type/threshold'
+require 'helper_functions'
+
+InvalidProcessNameError = Class.new(StandardError)
+
+# A class for checking if a Process is running in Unix based systems
+class MonitorTypeProcess < MonitorTypeThreshold
+  # Extract parameters
+  #
+  # @param [String] :process_name THe name of the process to monitor
+  def extract_params
+    if @params[:process_name].nil?
+      string = "*** Process Name parameter missing, process_name\n" \
+               '*** :process_name => <name of the process to ' \
+               'be monitored>'
+      fail MonitorTypeParameterMissingError, string
+    end
+    @process_name = @params[:process_name]
+
+    log "#{@process_name}", "result: #{(@process_name =~ /^(.*\[{1}.+\]{1}.*)$|^(\w+)$/) == 0}"
+
+    unless (@process_name =~ /^(.*\[{1}.+\]{1}.*)$|^(\w+)$/) == 0
+      string = '*** Process Name parameter doest not match the required ' \
+               "pattern, #{@process_name}\n" \
+               "*** :process_name => <plain string, or a string " \
+               'with one or more characters enclosed in square brackets, ' \
+               "i.e. 'foo', '[f]oo' or '[foo]'>"
+      fail InvalidProcessNameError, string
+    end
+
+    log '*** Min value will be ignored, setting to 1' unless (params[:min].nil? || params[:min] == 0)
+    @min = 1
+
+    log '*** Max value will be ignored, setting to nil' unless params[:max].nil?
+    @max = nil
+
+    @context_sentence = "Checking that process is running, #{@process_name}"
+  end
+
+  def setup
+    sanitise
+  rescue MonitorTypeExceptionHandled => e
+    puts e.message
+    abort
+  end
+
+  def sanitise
+    # Ensure that the process name contains a single character surrounded
+    #  by square brackets
+    @process_name = @process_name.insert(0,'[').insert(2,']') unless @process_name =~ /^.*\[.+\].*/
+  end
+
+  def derived_value
+    `ps aux | grep #{@process_name}`.length
+  end
+end
+
+def process(params)
+  $a.add(MonitorTypeProcess.new(params))
+end

data/lib/monitor_type/threshold.rb

@@ -0,0 +1,44 @@
+require 'monitor_type'
+
+# A base class for checking a number against a min and/or max value
+class MonitorTypeThreshold < MonitorType
+  # See super method for generic description
+  def initialize(params)
+    @min = params[:min] ||= 0
+    @max = params[:max]
+    super(params)
+  end
+
+  # Get the context dependent value which is to be checked
+  def derived_value
+    fail 'Method needs to be overridden'
+  end
+
+  def process
+    if @block.nil?
+      value = derived_value
+    else
+      value = @block.call(@params)
+      string = "value: #{value}\n"
+      puts string
+    end
+
+    check(value)
+  end
+
+  # Provides the means to check a value against thresholds
+  def check(value)
+    context_sentence = @context_sentence.nil? ? '' : "#{@context_sentence}\n"
+    url = @url.nil? ? '' : "\n\n#{@url}\n"
+
+    value = value.to_i
+
+    alert("#{context_sentence}Minimum threshold exceeded. " \
+          "Minimum: #{@min}, " \
+          "Actual: #{value}#{url}") if !@min.nil? && value < @min
+
+    alert("#{context_sentence}Maximum threshold exceeded. " \
+          "Maximum: #{@max}, " \
+          "Actual: #{value}#{url}") if !@max.nil? && value > @max
+  end
+end

data/lib/monitor_type.rb

@@ -0,0 +1,114 @@
+require 'parse-cron'
+# This is provided for reporting purposes.
+# It essentially indicates if an error case was expected
+#
+# The idea is to provide clear direction to the user to fix the error, but
+# not stop all monitors in case of a production issue.
+class MonitorTypeExceptionHandled < StandardError
+end
+
+class MonitorTypeParameterMissingError < MonitorTypeExceptionHandled
+end
+
+class MonitorTypeMustHaveNameError < MonitorTypeParameterMissingError
+end
+
+class MonitorTypeMustHaveSenderEmailAddressForEmailAlertError < MonitorTypeParameterMissingError
+end
+
+# Base class for Monitors
+#
+# Given that this is a DSL, it extracts named parameters from a hash in order
+# to provide more precise reporting of errors, without spewing syntax errors
+# at a user
+class MonitorType
+  # Check that all required parameters have been passed in
+  # Make sure that any errors encountered are reported in a way that
+  # fixing the error is made easier
+  def initialize(params)
+    if params[:name].nil?
+      string = '*** Monitor parameter missing, name' \
+               '*** :name => <name of monitor>'
+      fail MonitorTypeMustHaveNameError, string
+    end
+    @params = params
+    @block = params[:block] unless params[:block].nil?
+    @name = params[:name]
+    @email = params[:email]
+    @url = params[:url] unless params[:url].nil?
+
+    if !@email.nil?
+      # Sender email address from ENV allows for a single sender across all alerts
+      # Checking params before ENV allows a particular entry to be different
+      if params[:email_sender].nil?
+        if ENV['EMAIL_SENDER'].nil?
+          string = '*** Alert parameter missing, email_sender' \
+                    '*** An email recipient has been specified for monitor, ' \
+                    "#{@name}, but no email sender has been specified" \
+                    '*** :email_sender => <email of sender>' \
+                    '*** or, a catch all environment variable' \
+                    '*** EMAIL_SENDER=<email of sender>'
+
+          fail MonitorTypeMustHaveSenderEmailAddressForEmailAlertError, string
+        else
+          @sender_email = ENV['EMAIL_SENDER']
+        end
+      else
+        @sender_email = params[:admin_email]
+      end
+    end
+
+    cron_string = params[:cron] || '0 1 * * *'
+    @cron = CronParser.new(cron_string)
+    @next = Time.now - 1
+
+    log "Loaded Monitor, #{@name}."
+  end
+
+  # Overload this method if any parameters should be checked in context
+  def extract_params
+  end
+
+  # Overload this method if any parameters should be checked in context
+  def setup
+  end
+
+  # Overload this method if any parameters should be checked in context
+  def teardown
+  end
+
+  # Check if the monitor has tripped
+  def process
+    fail 'Method needs to be overridden'
+  end
+
+  # An extention of the main run loop.
+  # Each monitor is responsible for knowing when it should run, so this function
+  # is called pretty much continuosuly.
+  def run
+    return unless Time.now > @next
+
+    @next = @cron.next(Time.now)
+    log "Monitor, #{@name}, next run time, #{@next}"
+    extract_params
+    setup
+    process
+    teardown
+  rescue MonitorTypeExceptionHandled => e
+    alert(e.message)
+  end
+
+  # Called when a monitor has been tripped
+  #
+  # @param [String] string A description of the trip that occurred
+  def alert(string)
+    body = "#{@name} tripped.\n#{string}"
+    puts '*** '
+    if !@email.nil?
+      AlertEmail.new(@sender_email, @email, body).Send
+      puts "Emailed, #{@email}"
+    else
+      puts body
+    end
+  end
+end

metadata

@@ -1,60 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: servicemonitor
 version: !ruby/object:Gem::Version
-  version: 0.1.4
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Guy Irvine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-04 00:00:00.000000000 Z
+date: 2016-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parse-cron
-  requirement: &70142485328220 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70142485328220
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: beanstalk-client
-  requirement: &70142485327780 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70142485327780
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fluiddb
-  requirement: &70142485327360 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70142485327360
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70142485326940 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70142485326940
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The fastest way to reliably monitor your system.
 email: guy@guyirvine.com
 executables:
@@ -62,44 +73,43 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/Alert/Email.rb
-- lib/Alert.rb
+- lib/alert/email.rb
+- lib/alert.rb
 - lib/helper_functions.rb
-- lib/MonitorManager.rb
-- lib/MonitorType/Beanstalk.rb
-- lib/MonitorType/Dir.rb
-- lib/MonitorType/Drive.rb
-- lib/MonitorType/FluidDb.rb
-- lib/MonitorType/HttpGetJsonList.rb
-- lib/MonitorType/Process.rb
-- lib/MonitorType/Threshold.rb
-- lib/MonitorType.rb
+- lib/monitor_manager.rb
+- lib/monitor_type/beanstalk.rb
+- lib/monitor_type/dir.rb
+- lib/monitor_type/drive.rb
+- lib/monitor_type/fluiddb.rb
+- lib/monitor_type/http_get_json_list.rb
+- lib/monitor_type/process.rb
+- lib/monitor_type/threshold.rb
+- lib/monitor_type.rb
 - bin/servicemonitor
 - LICENSE
 - README.md
 homepage: http://rubygems.org/gems/servicemonitor
-licenses: []
+licenses:
+- LGPL-3.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.14.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ServiceMonitor
 test_files: []
-has_rdoc: 

data/lib/Alert/Email.rb

@@ -1,43 +0,0 @@
-require "net/smtp"
-require "Alert"
-
-#Email alert class
-#Uses localhost for sending email - Probably need to change this in the future.
-class Alert_Email
-	def initialize( sender, destination, body )
-		@sender = sender
-		@body = body
-
-		@smtp_address = ENV['smtp_address'].nil? ? 'localhost' : ENV['smtp_address']
-        	@smtp_port = ENV['smtp_port'].nil? ? 25 : ENV['smtp_port']
-
-				@destination = destination
-        if destination.is_a? Array then
-            @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 => e
-    string = "*** Conection refused while attempting to connect to SMTP server\n"
-    string = "#{string}*** Recipient, #{@destination}. Body,\n"
-    string = "#{string}*** #{@body}\n"
-    puts string
-	end
-end

data/lib/Alert.rb

@@ -1,7 +0,0 @@
-#Base class / Interface for implementing alert types
-class Alert
-    
-	def Send( destination, body )
-        raise "Method needs to be overridden"
-	end
-end

data/lib/MonitorManager.rb

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