rec 1.2.3 → 1.3.0

data/CHANGELOG

@@ -1,4 +1,9 @@
-=== version 1.2.2
+=== Version 1.3.0
+- Allow for pre-setting the file descriptors: $stdin, $stdout, $stderr, $miss
+- Prevent events being logged as missed when they matched but not fully
+- Added Notify_duration and Log_duration as State shortcuts
+
+=== Version 1.2.3
 - Recognise more date patterns
 - Improved performance
 

data/README

@@ -231,3 +231,5 @@ refer to any parameter succinctly instead of a cumbersome hash notation, so:
   state.threshold === state.params['threshold']
 
 For more examples, see the link:file.EXAMPLES.html page.
+For an example of how to execute a ruleset, see link:file.RUNNING page.
+

data/RUNNING

@@ -0,0 +1,26 @@
+== Running REC
+Here is an example script for executing REC as a daemon with a given name:
+
+  #!/usr/local/bin/ruby
+  # change process name. shows as "ruby: mymonitord"
+  $0 = "mymonitord"
+  
+  require 'rubygems'
+  require 'rec'
+  include REC
+  
+  $stdin = File.open("/var/mymon/logs/mymon.log", "r")
+  $stdout = File.open("/var/mymon/logs/rec.log" ,"a")
+  $miss = File.open("/var/mymon/logs/miss.log" ,"a")
+  $sterr = File.open("/var/mymon/logs/summary.log" ,"a")
+  
+  load '/var/mymon/rulesets/credentials.rec'
+  load '/var/mymon/rulesets/mymon.rec'
+  
+  Correlator::start(:debug=>true)
+  
+The credentials for sending emails and IMs are held in credentials, and the rules in mymon.rec
+
+I find it easier to set up file descriptor redirection in this way than using command line notation.
+
+ 

data/lib/rec/correlator.rb

@@ -44,11 +44,7 @@ class Correlator
 			run()
 		}
 		$stderr.puts("rec is starting...")
-		begin
-			$miss = IO.open(3, "a")		# for missed events
-		rescue
-			$miss = nil
-		end
+		$miss ||= IO.open(3, "a")		# write out to &3 for missed events, unless $miss is pre-defined
 		@running = true
 		run()
 	end
@@ -71,8 +67,8 @@ class Correlator
 			State.expire_states()	# remove expired states before we check the rules
 			eventMatched = false
 			Rule.each { |rule|
-				title = rule.check(message)
-				eventMatched = true unless title.nil?	# empty match is still a match
+				matchok, title = rule.check(message)
+				eventMatched ||= matchok
 				next if title.nil?
 				break if title.empty?	# match without a message means 'swallow this event'
 				state = State[title] || rule.create_state(title)

data/lib/rec/rule.rb

@@ -108,19 +108,20 @@ class Rule
 	end
 
 	# Checks the original +logMessage+ against the rule, looking for a match.
+	# Returns a boolean (true if entry matched the pattern), and a string
 	def check(logMessage)
 		@@checked[@rid] += 1
-		matchData = @pattern.match(logMessage) || return
+		return [false, nil] unless matchData = @pattern.match(logMessage)
 		@matches = Hash[@details.zip(matchData.to_a()[1..-1])]	# map matched values to detail keys
 		# if any notstates are specified, make sure none are present
-		@notstates.each { |str| return if State[str.sprinth(@matches)]	}
+		@notstates.each { |str| return([true, nil]) if State[str.sprinth(@matches)]	}
 		# if any allstates are specified, they all need to be present
-		@allstates.each { |str| return unless State[str.sprinth(@matches)]	}
+		@allstates.each { |str| return([true, nil]) unless State[str.sprinth(@matches)]	}
 		# if anystates are specified, we must find one that matches
-		return unless @anystates.empty? or @anystates.detect {|str| State[str.sprinth(@matches)] }
+		return([true, nil]) unless @anystates.empty? or @anystates.detect {|str| State[str.sprinth(@matches)] }
 		title = @message.sprinth(@matches)
 		@@matched[@rid] += 1
-		return(title)
+		return([true, title])
 	end
 
 	# Creates a state with the given title at the specified time

data/lib/rec/state.rb

@@ -22,9 +22,8 @@ class State
 		state.generate()
 	}
 
-	# shortcut action to ignore an event
+	# shortcut action to ignore an event, but leave the state to expire
 	Ignore = Proc.new { |state|
-		state.release()
 	}
 
 	# shortcut action to generate a message and release the state immediately
@@ -58,6 +57,28 @@ class State
 		state.release()
   }
 
+	Notify_duration = Proc.new { |state|
+    # We must have only one allstate, which is the original state (eg. "server down")
+    orig = state.params[:allstates][0]				      # get the original state's key
+    duration = state.find(original).age
+    # we expect to have :alert containing "%duration$d minutes"
+    state.details["duration"] = duration.to_i()/60	# store the outage duration
+    Notify.normal(state.generate())					        # send the notice
+    state.release(original)							            # forget both
+    state.release()
+  }
+
+	Log_duration = Proc.new { |state|
+    # We must have only one allstate, which is the original state (eg. "process started")
+    orig = state.params[:allstates][0]				      # get the original state's key
+    duration = state.find(original).age
+    # we expect to have :alert containing "%duration$d minutes"
+    state.details["duration"] = duration.to_i()/60	# store the duration
+    state.generate()      					                # record the event
+    state.release(original)							            # forget both
+    state.release()
+  }
+
 	# A array of Timeouts. A Timeout struct has two elements:
 	# - timestamp at which to expire
 	# - key of the state to be expired
@@ -248,6 +269,11 @@ class State
 		generate(sym) if @count == 1
 	end
 
+	# Convenience method to find another state, based on parameters in this state
+	def find(template)
+    self.find(template, self)
+	end
+
 	# Allow access to any parameter by a convenience method
 	# 	state.capture
 	# is more succinct than

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rec
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 27
   prerelease: 
   segments: 
   - 1
-  - 2
   - 3
-  version: 1.2.3
+  - 0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Richard Kernahan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-02 00:00:00 Z
+date: 2012-10-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: xmpp4r
@@ -63,6 +63,7 @@ files:
 - EXAMPLES
 - MULTIPLEX
 - LICENSE
+- RUNNING
 - CHANGELOG
 homepage: http://rubygems.org/gems/rec
 licenses: []