opticon 0.0.3 → 0.0.4

data/CHANGELOG.txt

@@ -1,22 +1 @@
-=== 0.0.3 :: 2008-03-02
-
-* When a service doesn't respond, a ConnectionFailure is now correctly
-  recorded. You can change how long Opticon will wait for a connection by
-  setting the Opticon.default_timeout value. The timeout is 3 seconds by
-  default.
-* Changed require paths to fix strange loading problems experienced
-  by some people.
-
-=== 0.0.2 :: 2007-11-15
-
-* A series of tests on a service can now be specified as a block to the 
-  Service#test method.
-* All failures generated inside a test block are all batched together
-  into one notification.  
-* Opticon test scripts can now be run with the "-v" switch to verbosely
-  display what the script is doing.  
-* Failure messages are now a bit more readable for non-techies.
-
-=== 0.0.1 :: 2007-02-21
-
-* First public release.
+See History.txt

data/History.txt

@@ -0,0 +1,30 @@
+=== 0.0.4 :: 2008-10-09
+
+* Added the SNMPTrap notifier to make it possible to send failure notifications 
+  as SNMP traps.
+* Added the IOStream notifier to print failures to an output stream. By default
+  the $stderr stream is used, but this can be configured to point to a file
+  or any other output stream.
+
+=== 0.0.3 :: 2008-04-02
+
+* When a service doesn't respond, a ConnectionFailure is now correctly
+  recorded. You can change how long Opticon will wait for a connection by
+  setting the Opticon.default_timeout value. The timeout is 3 seconds by
+  default.
+* Changed require paths to fix strange loading problems experienced
+  by some people.
+
+=== 0.0.2 :: 2007-11-15
+
+* A series of tests on a service can now be specified as a block to the 
+  Service#test method.
+* All failures generated inside a test block are all batched together
+  into one notification.  
+* Opticon test scripts can now be run with the "-v" switch to verbosely
+  display what the script is doing.  
+* Failure messages are now a bit more readable for non-techies.
+
+=== 0.0.1 :: 2007-02-21
+
+* First public release.

data/Manifest.txt

@@ -1,5 +1,3 @@
-.loadpath
-.project
 CHANGELOG.txt
 History.txt
 Manifest.txt

data/README.txt

@@ -1,3 +1,10 @@
+= Opticon
+
+*Copyright*:: 2008 Urbacon Ltd.
+*Authors*::   Matt Zukowski <matt at roughest dot net>
+*Homepage*::  http://opticon.googlecode.com
+
+
 Opticon is a no-nonsense utility for monitoring HTTP-based services (i.e. websites).
 
 When triggered, opticon connects to a list of URIs and checks to make sure that
@@ -13,3 +20,23 @@ page at:
   http://code.google.com/p/opticon/
 
 (Have a look at the Wiki in particular)
+
+
+== License
+
+Opticon is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published 
+by the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+Opticon is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with RubyCAS-Server; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+

data/examples/sample.rb

@@ -33,7 +33,7 @@ FROM = "opticon@nowhere.foo"
 # default notification behaviour for Opticon, which is to email failures to the
 # addresses you configured above.
 
-Opticon.default_notifiers = Opticon::Notifier::Email.new(SEND_TO, :from => FROM)
+Opticon.default_notifiers << Opticon::Notifier::Email.new(SEND_TO, :from => FROM)
 
 # You may need to configure the Mailer with your mail server info. Here's how to
 # use an SMTP mail server (unless you do this, local sendmail will be used used

data/lib/opticon.rb

@@ -3,7 +3,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 module Opticon
 
-  @@default_notifiers = nil
+  @@default_notifiers = []
   def default_notifiers
     @@default_notifiers
   end

data/lib/opticon/notifier.rb

@@ -3,7 +3,7 @@ require 'pstore'
 
 module Opticon
   module Notifier
-    # Send failure notifications via email to the given list of recipients.
+    # Sends failure notifications via email to the given list of recipients.
     # 
     # To set options, configure Opticon::Mailer the same way you
     # would any other ActionMailer. For example, to send via SMTP:
@@ -25,9 +25,9 @@ module Opticon
       # this is set to true.
       @@resend = false
       
-      def initialize(recipients, options = {:from => "opticon@#{ENV['HOSTNAME']}"})
+      def initialize(recipients, options = {})
         @recipients = recipients
-        @from = options[:from]
+        @from = options[:from] || "opticon@#{ENV['HOSTNAME']}"
       end
       
       def notify(failures)
@@ -54,8 +54,82 @@ module Opticon
       end
     end
     
+    # Prints failures to an output stream. By default failures are sent to 
+    # $stderr, but this can be changed using the :output_stream configuration 
+    # option.
+    class IOStream
+      attr_accessor :output_stream
+      
+      def initialize(output_stream = $stderr, options = {})
+        @output_stream = output_stream
+      end
+      
+      def notify(failures)
+        if ARGV.include?("-v")
+          puts "Printing #{failures.size} failures to #{output_stream}:"
+          failures.each{|f| puts "  #{f.failure_message}"}
+        end
+        
+        failures.each do |f|
+          # TODO: make output format configurable
+          output_stream.puts "#{Time.now} :: #{f.uri} :: #{f.failure_message}"
+        end
+      end
+    end
+    
+    # Sends failure notifications as SNMP traps.
+    #
+    # The notification is sent using the `snmptrap` command-line utility, part
+    # of the Net-SNMP perl package. You will have to install Net-SNMP prior
+    # to using this notifier. On Linux machines this is generally as easy as
+    # `apt-get install net-snmp` or `smart install net-snmp`. On Windows
+    # machines, you're on your own.
+    #
+    # In the future the net-snmp requirement may be swapped in favor of using
+    # the native Ruby SNMP library, but for now you need net-snmp.
+    class SNMPTrap
+      attr_accessor :to_host, :snmp_community, :enterprise_oid, 
+        :snmp_persistent_dir
+      
+      def initialize(to_host, snmp_community, options = {})
+        @to_host = to_host
+        @snmp_community = snmp_community
+        @enterprise_oid = options[:enterprise_oid] || '1.3.6.1.4.1.3.1.1'
+        @snmp_persistent_dir = options[:snmp_persistent_dir] || '/tmp'
+      end
+      
+      def notify(failures)
+        failures = [failures] unless failures.kind_of? Array
+        
+        if ARGV.include?("-v")
+          puts "Sending SNMP trap(s) to #{to_host} regarding #{failures.size} failures:"
+          failures.each{|f| puts "  #{f.failure_message}"}
+        end
+        
+        failures.each do |f|
+          oid = '1.3.1.2.1.1.0'
+          typ = 's'
+          
+          # TODO: make msg format configurable
+          msg = ("Opticon Test Failure on URL #{f.uri} :: #{f.failure_message}").gsub(/"/, '\"')
+          
+          debug = "-d" if ARGV.include?("-v")
+          cmd = %{snmptrap -v 1 #{debug} -c #{snmp_community} #{to_host}  #{enterprise_oid} #{ENV['HOSTNAME']} 6 0 '' #{oid} #{typ} "#{msg}"}
+          
+          puts ">> #{cmd}" if ARGV.include?("-v")
+          
+          # Band-aid fix for bug in Net-SNMP.
+          # See http://sourceforge.net/tracker/index.php?func=detail&aid=1588455&group_id=12694&atid=112694
+          ENV['SNMP_PERSISTENT_DIR'] ||= snmp_persistent_dir
+          
+          `#{cmd}`
+        end
+      end
+    end
+    
     # Dummy notifier used in testing. It doesn't do anything other than store
-    # the error_messages given to notify in the object's notifications attribute.
+    # the error_messages fed in to the notify method. These can later be
+    # be retrieved by looking at the object's notifications instance attribute.
     class Dummy
       attr_accessor :notifications
     

data/lib/opticon/version.rb

@@ -2,7 +2,7 @@ module Opticon #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 3
+    TINY  = 4
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: opticon
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Matt Zukowski
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-02 00:00:00 -04:00
+date: 2008-10-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionmailer
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -21,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
 description: Peace of mind through automated monitoring of your HTTP services.
 email: matt [at] roughest.net
 executables: []
@@ -33,8 +44,6 @@ extra_rdoc_files:
 - Manifest.txt
 - README.txt
 files: 
-- .loadpath
-- .project
 - CHANGELOG.txt
 - History.txt
 - Manifest.txt
@@ -82,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: opticon
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Peace of mind through automated monitoring of your HTTP services.

data/.loadpath

@@ -1,5 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<loadpath>
-	<pathentry path="" type="src"/>
-	<pathentry path="org.rubypeople.rdt.launching.RUBY_CONTAINER" type="con"/>
-</loadpath>

data/.project

@@ -1,17 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<projectDescription>
-	<name>opticon</name>
-	<comment></comment>
-	<projects>
-	</projects>
-	<buildSpec>
-		<buildCommand>
-			<name>org.rubypeople.rdt.core.rubybuilder</name>
-			<arguments>
-			</arguments>
-		</buildCommand>
-	</buildSpec>
-	<natures>
-		<nature>org.rubypeople.rdt.core.rubynature</nature>
-	</natures>
-</projectDescription>