= watcher
* http://watcher.rubyforge.org
== DESCRIPTION:
Watcher provides advanced integrated exception handling and logging
functionality to your Ruby programs.
This is useful both in the development stage of a program, and while
in production use, for instance on a server, as Watcher can be
directed to email generated log files to a specified user in the event
of errors or warnings.
By combining exception handling and detailed logging facilities,
Watcher greatly reduces code-bloat and potential program flow logic
flaws, as Watcher eliminates the necessity to write a tremendous
amount of boiler-plate code in the form of "begin, rescue, ensure,
end" blocks.
Watcher also provides a very flexible exception handling capability,
allowing a programmer to easily direct Watcher what actions to take in
the event of an exception. These failure actions may include any
combination of logging the failure, invoking a Proc object, retrying
the code, and allowing the exception to propagate up the call-stack by
re-raising the exception. Exceptions that are re-raised in a child
call-stack are caught by the parent call-stack, and are then dealt
with by the programmer determined rules of the parent call-stack. All
this happens while Watcher ensures the logs are properly maintained
for the various actions taken.
== FEATURES/PROBLEMS:
* Exception handling without the boiler-plate code.
* Multiple tiers of verbosity.
* Flexible logging capabilities, including to files, STDERR, email.
* Nested, and hierarchical log output for descriptive stack-frame level
understanding where an exception was thrown.
* Ability to change the time format of your logs by supplying an arbitrary
Proc to return the time in the format of your choice.
* Ability to customize the layout of the logs, by turning off hierarchical
view, or changing Strings used to indicate events.
* Email log files automatically, based on number of errors or warnings.
* Ability to invoke arbitrary sequence of events if exception is thrown,
including invocation of Proc objects.
== SYNOPSIS:
# create Watcher instance with slightly modified defaults
$watcher=Watcher.create(:output=>log_file, :verbosity=>:warn)
$watcher.info("starting #File.basename($0)") do
# Look for CONFIG_PATH. If not found, log warning then re-write it
fail_actions=[:log, lambda write_config(config_path)]
$watcher.info("searching for [#config_path].", fail_actions) do
if not File.exists?(config_path)
raise RuntimeError.new("WARNING: Missing [#config_path]. Creating a default config file. (You should probably verify it...)")
end
end
# invoke utility, which uses $watcher as well
fsc=FileSystemChecker.new(:config_path=>config_path)
fsc.check_file_systems(:all=>all_flag, :remount=>remount_flag)
if email_flag and $watcher.errors > 0
$watcher.send_email(email,'FAIL: Required filesystems are not mounted')
end
end
== REQUIREMENTS:
* Passion for coding.
== INSTALL:
$ sudo gem install
== LICENSE:
(The Simplified BSD License)
Copyright (c) 2008 Karrick McDermott
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
* http://watcher.rubyforge.org
== DESCRIPTION:
Watcher provides advanced integrated exception handling and logging
functionality to your Ruby programs.
This is useful both in the development stage of a program, and while
in production use, for instance on a server, as Watcher can be
directed to email generated log files to a specified user in the event
of errors or warnings.
By combining exception handling and detailed logging facilities,
Watcher greatly reduces code-bloat and potential program flow logic
flaws, as Watcher eliminates the necessity to write a tremendous
amount of boiler-plate code in the form of "begin, rescue, ensure,
end" blocks.
Watcher also provides a very flexible exception handling capability,
allowing a programmer to easily direct Watcher what actions to take in
the event of an exception. These failure actions may include any
combination of logging the failure, invoking a Proc object, retrying
the code, and allowing the exception to propagate up the call-stack by
re-raising the exception. Exceptions that are re-raised in a child
call-stack are caught by the parent call-stack, and are then dealt
with by the programmer determined rules of the parent call-stack. All
this happens while Watcher ensures the logs are properly maintained
for the various actions taken.
== FEATURES/PROBLEMS:
* Exception handling without the boiler-plate code.
* Multiple tiers of verbosity.
* Flexible logging capabilities, including to files, STDERR, email.
* Nested, and hierarchical log output for descriptive stack-frame level
understanding where an exception was thrown.
* Ability to change the time format of your logs by supplying an arbitrary
Proc to return the time in the format of your choice.
* Ability to customize the layout of the logs, by turning off hierarchical
view, or changing Strings used to indicate events.
* Email log files automatically, based on number of errors or warnings.
* Ability to invoke arbitrary sequence of events if exception is thrown,
including invocation of Proc objects.
== SYNOPSIS:
# create Watcher instance with slightly modified defaults
$watcher=Watcher.create(:output=>log_file, :verbosity=>:warn)
$watcher.info("starting #File.basename($0)") do
# Look for CONFIG_PATH. If not found, log warning then re-write it
fail_actions=[:log, lambda write_config(config_path)]
$watcher.info("searching for [#config_path].", fail_actions) do
if not File.exists?(config_path)
raise RuntimeError.new("WARNING: Missing [#config_path]. Creating a default config file. (You should probably verify it...)")
end
end
# invoke utility, which uses $watcher as well
fsc=FileSystemChecker.new(:config_path=>config_path)
fsc.check_file_systems(:all=>all_flag, :remount=>remount_flag)
if email_flag and $watcher.errors > 0
$watcher.send_email(email,'FAIL: Required filesystems are not mounted')
end
end
== REQUIREMENTS:
* Passion for coding.
== INSTALL:
$ sudo gem install
== LICENSE:
(The Simplified BSD License)
Copyright (c) 2008 Karrick McDermott
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.