]> git.etc.gen.nz Git - spong.git/commitdiff
Documentation updates. spong-2_6-beta8
authorStephen L Johnson <sjohnson@monsters.org>
Thu, 16 Dec 1999 07:34:37 +0000 (07:34 +0000)
committerStephen L Johnson <sjohnson@monsters.org>
Thu, 16 Dec 1999 07:34:37 +0000 (07:34 +0000)
www/docs/spong-2_0.html
www/docs/todo.html

index fb386b9a254825be0f6c91bdca7892e5feb8d978..672dd73be4d554a2a608405add8978fad0526d1c 100755 (executable)
-<HEAD>\r\r
-<TITLE>Simple System/Network Monitoring - spong v2.0</TITLE>\r\r
-</HEAD>\r\r
-<BODY>\r\r
-\r\r
-<H1>Simple System/Network Monitoring - spong v2.0</H1>\r\r
-<hr>\r\r
-\r\r
-<H2>Description</H2>\r\r
-This is a <b>simple</b> system monitoring package called spong.  It has the\r\r
-following features:\r\r
-<p>\r\r
-\r\r
-<ul>\r\r
-<li>client based monitoring (CPU, disk, processes, logs, etc...)\r\r
-<li>monitoring of network services (smtp, http, ping, pop, dns, etc...)\r\r
-<li>grouping of hosts (routers, servers, workstations, PCs)\r\r
-<li>rules based messaging when problems occur\r\r
-<li>configurable on a host by host basis\r\r
-<li>results displayed via text or web based interface\r\r
-<li>history of problems\r\r
-<li>verbose information to help diagnosis problems\r\r
-</ul>\r\r
-\r\r
-This is hopefully a *simple* tool.  It does not compete with Tivoli, OpenView,\r\r
-UniCenter, or any other commercial packages, and I have no intention of trying\r\r
-to turn it into one.  It is not SNMP based, it communicates via simple TCP\r\r
-based messages.  It is written in Perl, so hopefully it can be run on multiple\r\r
-systems (including NT - although it has not been ported yet - but is on the\r\r
-todo list).<p>\r\r
-\r\r
-I'm a strong believer in KISS (keep it simple stupid), and hopefully this\r\r
-package is as simple as possible (but no simpler).  Spong is broken up into\r\r
-components that each do a specific thing.  Listed are some of the (key)\r\r
-components:<p>\r\r
-\r\r
-<ul>\r\r
-<table width=90% border=0 cellpadding=0 cellspacing=0>\r\r
-<tr><td><b>spong</b> &nbsp</td>\r\r
-<td>Text based query program, reports information about hosts that are\r\r
-monitored.</td></tr>\r\r
-\r\r
-<tr><td><b>spong-client</b> &nbsp</td>\r\r
-<td>Reports host based information (disk, cpu, logs, etc.)</td></tr>\r\r
-\r\r
-<tr><td><b>spong-network</b> &nbsp</td>\r\r
-<td>Reports on network based services (smtp, ping, http, etc.)</td></tr>\r\r
-\r\r
-<tr><td><b>spong-server</b> &nbsp</td>\r\r
-<td>Collects information reported and responds to queries about that\r\r
-information.</td></tr></table>\r\r
-\r\r
-</ul>\r\r
-\r\r
-Spong is currently at version 2.0.  If you are using an older version and want\r\r
-to see <a href="#whats_new">what's new</a> in version 2.0, please look at the\r\r
-bottom on this page.<p>\r\r
-\r\r
-<H2>Availability</H2>\r\r
-\r\r
-Perl is require to run spong.  If you don't have Perl installed you can\r\r
-retrieve it from the CPAN (<a\r\r
-href="http://www.perl.com/CPAN/">http://www.perl.com/CPAN/</a>) archive, along\r\r
-with other optional modules such at the Net::DNS module.  I would suggest\r\r
-having at least version 5.004 installed (otherwise you will need to download\r\r
-the CGI.pm module as well).  You can get the latest version of Perl at:<p>\r\r
-\r\r
-<ul>\r\r
-<a href="http://www.perl.com/CPAN/src/latest.tar.gz">http://www.perl.com/CPAN/src/latest.tar.gz</a>\r\r
-</ul>\r\r
-\r\r
-You can retrieve the latest version of spong from my machine at:<p>\r\r
-\r\r
-<ul>\r\r
-<a href="http://strobe.weeg.uiowa.edu/~edhill/public/spong/spong.tar.gz">http://strobe.weeg.uiowa.edu/~edhill/public/spong/spong.tar.gz</a>\r\r
-</ul>\r\r
-\r\r
-You can see some screen shots of spong in action (note these are just examples\r\r
-of HTML that is produced - not the actual programming running - most people\r\r
-don't want this level of system information public to the world (if they can\r\r
-help it).<p>\r\r
-\r\r
-<ul>\r\r
-<li><a href="./example/main.html">Main Spong Page</a>\r\r
-<li><a href="./example/unix.html">Spong showing only Unix machines by group</a>\r\r
-<li><a href="./example/history.html">History of problems</a>\r\r
-<li><a href="./example/host.html">Host summary page</a>\r\r
-<li><a href="./example/service.html">Service specific summary page</a>\r\r
-</ul>\r\r
-<p>This distribution contain the spong source, documentation, and gif images.\r\r
-<p>\r\r
-\r\r
-<h2>Notification</h2>\r\r
-\r\r
-I have sent up a mailing list that I will post to when I have released a new\r\r
-version of spong.  Anyone can join this list, but the traffic will be only one\r\r
-way (me posting information about new-releases).  If enough people are\r\r
-interested in creating a list for discussion spong in general, I will set one\r\r
-up at that time.  I try to answer any questions that are sent to me.<p>\r\r
-\r\r
-To join the spong-announce mailing list, send a message to <a\r\r
-href="mailto:majordomo@strobe.weeg.uiowa.edu">\r\r
-majordomo@strobe.weeg.uiowa.edu</a> with the sentence:<p>\r\r
-\r\r
-<ul><code>subscribe spong-announce</code></ul>\r\r
-\r\r
-in the <i>body</i> of the message.  To have yourself removed from the\r\r
-spong-announce mailing list, send a message to <a\r\r
-href="mailto:majordomo@strobe.weeg.uiowa.edu">\r\r
-majordomo@strobe.weeg.uiowa.edu</a> with the sentence <code>unsubscribe\r\r
-spong-announce</code> in the <i>body</i> of the message.<p>\r\r
-\r\r
-The traffic on the list will be very light - about 1 message per month at\r\r
-most.<p>\r\r
-\r\r
-\r\r
-<h2>Dependencies</h2>\r\r
-\r\r
-Perl v5.004 or greater is all that is required to set up spong.  A web server\r\r
-where you can install a CGI program, and a web browser that can display tables\r\r
-and frames are required for use of the web interface to spong.\r\r
-\r\r
-If you want to monitor DNS servers remotely, then you will need to install the\r\r
-Net::DNS Perl module (available at CPAN).  Spong will run fine without this\r\r
-module, you just will not be able to monitor the DNS service.<p>\r\r
-\r\r
-These scripts should run on any Unix system (and to ``some'' degree any\r\r
-environment where Perl is available).  I will try to make sure the scripts run\r\r
-under NT when I have better access to an NT machine.<p>\r\r
-\r\r
-\r\r
-<h2>Installation</h2>\r\r
-\r\r
-To build and install the spong server do the following on the machine running\r\r
-your web server.  <p>\r\r
-\r\r
-<ol>\r\r
-<li>Edit the "build" script, and set the variables at the top of that script\r\r
-according to where you want spong installed, and where certain programs that\r\r
-spong relies on are located.<p>\r\r
-\r\r
-<li>Check to make sure there is a config/spong.conf.&ltos&gt file corresponding\r\r
-to your operating system, if not - create one.  This file contains paths and\r\r
-command line arguments to helper programs that are used to determine things\r\r
-like disk usage, etc...  If you have to create your own spong.conf.&ltos&gt\r\r
-file, then please email it to me so that I can add it to the distribution.\r\r
-<p>\r\r
-\r\r
-<li>Make sure you are in the directory that you unpacked spong in and type:\r\r
-<code>./build &ltos&gt</code> where &ltos&gt is the name corresponding to your\r\r
-operating system.  You can type <code>./build help</code> to generate a list of\r\r
-valid operating system strings.<p>\r\r
-\r\r
-When the build completes, you will be left with some new directories in the\r\r
-folder that you unpacked spong in.  The build process takes the spong source\r\r
-(and documentation), and replaces some "tokens" with values that you have\r\r
-supplied at the top of the build script.  The build process also creates a\r\r
-spong.conf file, and generates various types of documentation based on the POD\r\r
-files that come with spong.<p>\r\r
-\r\r
-<li>Now, type <code>./build install</code>.  Note that the install process\r\r
-makes no assumptions about what user you want to run spong as (you <b>don't</b>\r\r
-have to run it as root).  This means that you have to be a little more careful\r\r
-when you install spong (making sure it has the correct permissions, and that\r\r
-you have permission to copy the www pages into your web server's document\r\r
-tree).<p>\r\r
-\r\r
-<li>Now edit the spong.conf, and spong.hosts files that you just installed and\r\r
-season to taste.  You should now be able to read the manual pages for each.<p>\r\r
-</ol>\r\r
-\r\r
-Now you will have the executables and configuration files in place on the\r\r
-server.  You need to start the spong-server and spong-network programs.  The\r\r
-spong-server program will listen for reports from various agents, and the\r\r
-spong-network program will start testing the hosts you have defined for any\r\r
-problems.  After starting those programs, you should start seeing files show up\r\r
-in the SPONGSTATUS directory that you defined in the spong.conf file.  <p>\r\r
-\r\r
-For each client machine you will need to install the just the spong-client and\r\r
-a spong.conf file and make sure they start up when your system is rebooted.\r\r
-<p>\r\r
-\r\r
-<h2>Documentation</h2>\r\r
-\r\r
-Don't let the amount of documentation scare you, I still think spong is simple\r\r
-to setup and use.<p>\r\r
-\r\r
-The documentation is provided in HTML format (the old Perl pod format just\r\r
-didn't do all that I wanted).  It is located in the docs directory and is self\r\r
-contained (the links will still work if you move it), so you should be able to\r\r
-copy it to whatever location that you want.<p>\r\r
-\r\r
-There are four main documents that describe spong from different\r\r
-perspectives.<p>\r\r
-\r\r
-<dl>\r\r
-<dd><b><a href="overview.html">Overview</a></b>\r\r
-<dd>Just that, gives a quick 5 minute overview of what spong is and what it can\r\r
-do.<p>\r\r
-\r\r
-<dd><b><a href="users-guide.html">User's Guide</a></b>\r\r
-<dd>Geared towards the person who will be using the spong text or web based\r\r
-clients.  This is the documentation that will be seen when the user clicks\r\r
-on the Help button provided in www-spong.<p>\r\r
-\r\r
-<dd><b><a href="admin-guide.html">Administrator's Guide</a></b>\r\r
-<dd>Written for the person who will be installing spong, and setting up the\r\r
-various configuration files.  This provides a step by step installation process\r\r
-and gives some suggestions on things spong can do that you might not have\r\r
-thought of.<p>\r\r
-\r\r
-<dd><b><a href="developer-guide.html">Developer's Guide</a></b>\r\r
-<dd>Written for the person who wants to have spong look differently, or what to\r\r
-add some new feature in their version of spong, or whats to incorporate spong\r\r
-output in other programs.  This details the spong internals, and describes the\r\r
-various protocols that are used.<p>\r\r
-</dl>\r\r
-\r\r
-There are also specific "man" pages for each program and configuration file\r\r
-which provide detailed explanations of each option, command line argument,\r\r
-etc...  Finally, if you are in a pinch, the code is readable enough (and well\r\r
-commented) to provide some help as well.<p>\r\r
-\r\r
-I hopefully have provided enough documentation that the only email I get are\r\r
-suggestions for new features and bug reports - but if you are stuck, feel free\r\r
-to send me email and I will respond if I can.<p>\r\r
-\r\r
-<h2>Files</h2>\r\r
-\r\r
-Here is a description of the directories and files that come in this package\r\r
-prior to installation.  More specific descriptions of each file are available\r\r
-in the various documentation that comes with spong.<p>\r\r
-\r\r
-<pre>\r\r
-    config:\r\r
-      <a href="spong.conf.html">spong.conf</a>              distributed config file\r\r
-      spong.conf.&ltos&gt         os specific config changes\r\r
-      <a href="spong.hosts.html">spong.hosts</a>             host/service config file\r\r
-      <a href="spong.groups.html">spong.groups</a>            group config file\r\r
\r\r
-    src:\r\r
-      <a href="spong.html">spong.pl</a>                text based spong display client\r\r
-      <a href="spong-client.html">spong-client.pl</a>         collects/reports cpu,disk,etc info\r\r
-      <a href="spong-network.html">spong-network.pl</a>        collects/reports network service info\r\r
-      <a href="spong-server.html">spong-server.pl</a>         listens for/saves spong status updates\r\r
-      <a href="spong-message.html">spong-message.pl</a>        alerts humans there's a problem\r\r
-      <a href="spong-ack.html">spong-ack.pl</a>            text based acknowledgement program\r\r
-      <a href="www-spong.html">www-spong.pl</a>            web based spong display client\r\r
-      <a href="www-spong-ack.html">www-spong-ack.pl</a>        web based acknowledgement program\r\r
-\r\r
-    docs:\r\r
-      &lt*&gt.html                documentation for the above files\r\r
\r\r
-    www:\r\r
-      gifs:                   various icons used by spong-display\r\r
-\r\r
-</pre>\r\r
-\r\r
-<h2>Licensing</h2>\r\r
-\r\r
-Copyright 1997, Ed Hill - The University of Iowa<p>\r\r
-\r\r
-Like Perl, spong may be copied only under the terms of either the Artistic\r\r
-License or the GNU General Public License, which may be found in the Perl 5.0\r\r
-source kit.  If either file is not available to you, send email to <a\r\r
-href="mailto:ed-hill@uiowa.edu">ed-hill@uiowa.edu</a>, and I will mail you a\r\r
-copy.<p>\r\r
-\r\r
-<a name="whats_new"></a>\r\r
-<h2>Changes between v2.0 and v1.1</h2>\r\r
-\r\r
-The most significant change in version 2.0 is a rewrite and redesign of spong\r\r
-internals to move towards a more modular and OO framework.  The first version\r\r
-of spong was just a port of the BB program to perl with some of my own\r\r
-modifications, this version contains a significant rewrite of the spong-server\r\r
-program to make it more object oriented and extensible.  I believe this puts\r\r
-spong in a better position to maintain (by me) and extend (by you).\r\r
-\r\r
-The spong-client and spong-network programs are still pretty much the same\r\r
-\r\r
-Other then the redesign issue, this release has a few new features and\r\r
-programs, and some bug fixes (as well as some new introductions I'm sure).  The\r\r
-most significant changes are:<p>\r\r
-\r\r
-<ul>\r\r
-<li>CHANGE: Made spong server a single threaded process, improves performance\r\r
-on some machines significantly.\r\r
-<li>CHANGE: Changed the way that information is stored on the spong server, so\r\r
-that more features can be easily incorporated over time.\r\r
-<li>CHANGE: Upgraded the build script so that it is more useful.\r\r
-<li>CHANGE: Redesigned spong internals so things are more object oriented.\r\r
-<li>CHANGE: Made various changes to the way that information is displayed via\r\r
-the web interface.\r\r
-\r\r
-<p><li>ADDED: Added new command line spong display program.\r\r
-<li>ADDED: Replaced the spong-display program with www-spong which can act as\r\r
-both a CGI program and a command line program that generates web pages.\r\r
-<li>ADDED: Query mechanism to the spong server so that the www-spong and spong\r\r
-programs don't have be on the same machine as the spong-server.\r\r
-<li>ADDED: Added a way to acknowledge problems (spong-ack, www-spong-ack)\r\r
-<li>ADDED: Added checks for NFS and other UDP based services.\r\r
-<li>ADDED: Made group support usable.\r\r
-<li>ADDED: Added --nosleep options to the spong-client and spong-server\r\r
-programs so that you can run them from cron.\r\r
-\r\r
-<p><li>BUG FIX: DNS check was not working correctly, is now fixed.\r\r
-</ul>\r\r
-\r\r
-You can see a list of features that I hope to add to spong at:<p>\r\r
-\r\r
-<ul>\r\r
-<a href="http://strobe.weeg.uiowa.edu/~edhill/public/spong/todo.html">http://strobe.weeg.uiowa.edu/~edhill/public/spong/todo.html</a>\r\r
-</ul>\r\r
-\r\r
-\r\r
-<h2>History</h2>\r\r
-\r\r
-<table width=100% border=0>\r\r
-<tr>\r\r
-<td align=left valign=top>Version 2.0   </td>\r\r
-<td align=left valign=top>\r\r
-A OO redesign of the spong-server and display programs, added acknowledgments\r\r
-and group support, added a text based interface, made www interface more\r\r
-extensible.\r\r
-</td>\r\r
-</tr>\r\r
-<tr>\r\r
-<td align=left valign=top>Version 1.1   </td>\r\r
-<td align=left valign=top>\r\r
-Primarily a bug fix release with a few minor features (dns,http config,multiple\r\r
-interfaces) added.\r\r
-</td>\r\r
-</tr>\r\r
-<tr>\r\r
-<td align=left valign=top>Version 1.0   </td>\r\r
-<td align=left valign=top>\r\r
-Initial public release, mostly based on Big Brother package from Sean MacGuire.\r\r
-</td>\r\r
-</tr>\r\r
-</table>\r\r
-<p>\r\r
-\r\r
-<h2>Acknowledgments</h2>\r\r
-\r\r
-Many ideas (and some code) came from two similar packages.  We have used a\r\r
-program call "Pong" here at The University of Iowa for about a year.  Pong was\r\r
-written by Helen Harrison at SAS Institute and a paper on it was presented at\r\r
-the Usenix LISA conference.  Pong would allow us to do simple monitoring of\r\r
-systems (via ping) and would report machine status via a web page.  The name of\r\r
-this package (Son of PONG, but pronounced as its spelled "spong") is an obvious\r\r
-rip off...  <p>\r\r
-\r\r
-Originally, the main concepts and design came from Big Brother written by Sean\r\r
-MacGuire.  That package was written in C and sh scripts which I ``ported'' to\r\r
-Perl, making many changes along the way (like adding more information to the\r\r
-messages going from the client to the server, adding history, changing the way\r\r
-that information is displayed, added some configuration options, etc.).  <p>\r\r
-\r\r
-There didn't seem to be any interest in my perl code from the author of BB, so\r\r
-I've changed the name so there would be any confusion between this package and\r\r
-its inspiration.  <p>\r\r
-\r\r
-I'd also like to thank the many people who have contributed patches and\r\r
-comments, and where willing to try out spong and help me work out a few of the\r\r
-early problems.<p>\r\r
-\r\r
-<h2>Known Problems in v2.0</h2>\r\r
-\r\r
-Here are a list of problems, and possible fixes that have been reported for\r\r
-version 2.0.  I will update this section as bugs come in (if there are any 8-).\r\r
-These fixes will all be included in the next release of spong, but if you can't\r\r
-wait - here are some suggestions.<p>\r\r
-\r\r
-<ul>\r\r
-<li><b>Attempt to free unreferenced scalar</b> - I have not figured this one\r\r
-out yet.  It is a Perl internals message, and some say the problem is related\r\r
-to the malloc library that comes with Perl.  If you see the spong-client crash\r\r
-with this message reported, I would encourage you to run the spong-client\r\r
-program via a cron entry with the --nosleep flag as a work around.\r\r
-</ul>\r\r
-\r\r
-<h2>Author</h2>\r\r
-\r\r
-Ported and currently maintained by:\r\r
-<p>\r\r
-\r\r
-<a href="http://strobe.weeg.uiowa.edu/~edhill/">Ed Hill</a> (<a href="mailto:ed-hill@uiowa.edu">ed-hill@uiowa.edu</a>)<br>\r\r
-Internet Software Developer  at\r\r
-<a href="http://www.uiowa.edu/">The University of Iowa</a><p>\r\r
-\r\r
-<p>Please feel free to send me bug reports, patches, suggestions, or comments.\r\r
-<p>\r\r
-<hr>\r\r
-Most recently updated on Aug 1, 1997 by\r\r
-<a href="http://strobe.weeg.uiowa.edu/~edhill/">Ed Hill</a>\r\r
-(<a href="mailto:ed-hill@uiowa.edu">ed-hill@uiowa.edu</a>)\r\r
-\r\r
-</BODY>\r\r
-</HTML>\r\r
+<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
+<html>
+<head>
+   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+   <meta name="GENERATOR" content="Mozilla/4.61 [en] (X11; U; Linux 2.2.12-20 i686) [Netscape]">
+   <title>Simple System/Network Monitoring - spong v2.0</title>
+</head>
+<body>
+
+<h1>
+Simple System/Network Monitoring - spong v2.0</h1>
+
+<hr>
+<h2>
+Description</h2>
+This is a <b>simple</b> system monitoring package called spong. It has
+the following features:
+<ul>
+<li>
+client based monitoring (CPU, disk, processes, logs, etc...)</li>
+
+<li>
+monitoring of network services (smtp, http, ping, pop, dns, etc...)</li>
+
+<li>
+grouping of hosts (routers, servers, workstations, PCs)</li>
+
+<li>
+rules based messaging when problems occur</li>
+
+<li>
+configurable on a host by host basis</li>
+
+<li>
+results displayed via text or web based interface</li>
+
+<li>
+history of problems</li>
+
+<li>
+verbose information to help diagnosis problems</li>
+</ul>
+This is hopefully a *simple* tool. It does not compete with Tivoli, OpenView,
+UniCenter, or any other commercial packages, and I have no intention of
+trying to turn it into one. It is not SNMP based, it communicates via simple
+TCP based messages. It is written in Perl, so hopefully it can be run on
+multiple systems (including NT - although it has not been ported yet -
+but is on the todo list).
+<p>&nbsp;I'm a strong believer in KISS (keep it simple stupid), and hopefully
+this package is as simple as possible (but no simpler). Spong is broken
+up into components that each do a specific thing. Listed are some of the
+(key) components:
+<br>&nbsp;
+<br>&nbsp;
+<ul>&nbsp;
+<table BORDER=0 CELLSPACING=0 CELLPADDING=0 WIDTH="90%" >
+<tr>
+<td><b>spong</b></td>
+
+<td>Text based query program, reports information about hosts that are
+monitored.</td>
+</tr>
+
+<tr>
+<td><b>spong-client</b></td>
+
+<td>Reports host based information (disk, cpu, logs, etc.)</td>
+</tr>
+
+<tr>
+<td><b>spong-network</b></td>
+
+<td>Reports on network based services (smtp, ping, http, etc.)</td>
+</tr>
+
+<tr>
+<td><b>spong-server</b></td>
+
+<td>Collects information reported and responds to queries about that information.</td>
+</tr>
+</table>
+</ul>
+Spong is currently at version 2.6. If you are using an older version and
+want to see <a href="#whats_new">what's new</a> in version 2.6, please
+look at the bottom on this page.
+<br>&nbsp;
+<br>&nbsp;
+<h2>
+Availability</h2>
+Perl is require to run spong. If you don't have Perl installed you can
+retrieve it from the CPAN (<a href="http://www.perl.com/CPAN/">http://www.perl.com/CPAN/</a>)
+archive, along with other optional modules such at the Net::DNS module.
+I would suggest having at least version 5.004 installed (otherwise you
+will need to download the CGI.pm module as well). You can get the latest
+version of Perl at:
+<br>&nbsp;
+<br>&nbsp;
+<ul><a href="http://www.perl.com/CPAN/src/latest.tar.gz">http://www.perl.com/CPAN/src/latest.tar.gz</a></ul>
+You can retrieve the latest version of spong from my machine at:
+<br>&nbsp;
+<br>&nbsp;
+<ul><a href="http://monsters.org/pub/spong/spong.tar.gz">http://monsters.org/pub/spong/spong.tar.gz</a></ul>
+This distribution contain the spong source, documentation, and gif images.
+<h2>
+Notification</h2>
+I have sent up a mailing list that is for spong discussion, help and annoucements.
+The mailing list open to anyone. I am on the list and I endevour to answer
+all questions submitted to the list.
+<p>&nbsp;To join the spong mailing list, send a message to <a href="mailto:spong-request@monsters.org">spong-request@monsters.org</a>
+with the sentence:
+<br>&nbsp;
+<ul><tt>subscribe</tt></ul>
+in the <i>body</i> of the message. To have yourself removed from the spong-announce
+mailing list, send a message to <a href="mailto:spong-request@monsters.org">spong-request@monsters.org</a>
+with the sentence <tt>unsubscribe i</tt>n the <i>body</i> of the message.
+<p>&nbsp;You can also visit the <a href="http://monsters.org/mailman/listinfo/spong">Spong
+mailing list web page</a> to subscribe or view the mailing list archives.
+<br>&nbsp;
+<h2>
+Dependencies</h2>
+Perl v5.004 or greater is all that is required to set up spong. A web server
+where you can install a CGI program, and a web browser that can display
+tables and frames are required for use of the web interface to spong. If
+you want to monitor DNS servers remotely, then you will need to install
+the Net::DNS Perl module (available at CPAN). Spong will run fine without
+this module, you just will not be able to monitor the DNS service.
+<p>&nbsp;These scripts should run on any Unix system (and to ``some'' degree
+any environment where Perl is available).
+<h2>
+Documentation</h2>
+Don't let the amount of documentation scare you, I still think spong is
+simple to setup and use.
+<p>&nbsp;The documentation is provided in HTML format (the old Perl pod
+format just didn't do all that I wanted). It is located in the docs directory
+and is self contained (the links will still work if you move it), so you
+should be able to copy it to whatever location that you want.
+<p>&nbsp;There are four main documents that describe spong from different
+perspectives.
+<dl>
+<dd>
+<b><a href="FAQ.html">FAQ</a></b></dd>
+
+<dd>
+Frequently Asked Questions by users and their answers.</dd>
+
+<br>&nbsp;
+<p>&nbsp;
+<br>&nbsp;
+<br>&nbsp;
+<dd>
+<b><a href="user-guide.html">User's Guide</a></b></dd>
+
+<dd>
+Geared towards the person who will be using the spong text or web based
+clients. This is the documentation that will be seen when the user clicks
+on the Help button provided in www-spong.</dd>
+
+<br>&nbsp;
+<p>&nbsp;
+<br>&nbsp;
+<br>&nbsp;
+<br>&nbsp;
+<br>&nbsp;
+<dd>
+<b><a href="admin-guide.html">Administrator's Guide</a></b></dd>
+
+<dd>
+Written for the person who will be installing spong, and setting up the
+various configuration files. This provides a step by step installation
+process and gives some suggestions on things spong can do that you might
+not have thought of.</dd>
+
+<br>&nbsp;
+<p>&nbsp;
+<br>&nbsp;
+<br>&nbsp;
+<br>&nbsp;
+<br>&nbsp;
+<dd>
+<b><a href="developer-guide.html">Developer's Guide</a></b></dd>
+
+<dd>
+Written for the person who wants to have spong look differently, or what
+to add some new feature in their version of spong, or whats to incorporate
+spong output in other programs. This details the spong internals, and describes
+the various protocols that are used.</dd>
+
+<br>&nbsp;
+<p>&nbsp;
+<br>&nbsp;
+<br>&nbsp;
+<br>&nbsp;
+<br>&nbsp;</dl>
+There are also specific "man" pages for each program and configuration
+file which provide detailed explanations of each option, command line argument,
+etc... Finally, if you are in a pinch, the code is readable enough (and
+well commented) to provide some help as well.
+<p>&nbsp;I hopefully have provided enough documentation that the only email
+I get are suggestions for new features and bug reports - but if you are
+stuck, feel free to send me email and I will respond if I can.
+<br>&nbsp;
+<br>&nbsp;
+<h2>
+Files</h2>
+Here is a description of the directories and files that come in this package
+prior to installation. More specific descriptions of each file are available
+in the various documentation that comes with spong.
+<br>&nbsp;
+<br>&nbsp;
+<pre>&nbsp;&nbsp;&nbsp; config:
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="spong_conf.html">spong.conf</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; distributed config file
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; spong.conf.&amp;ltos>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; os specific config changes
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="spong_hosts.html">spong.hosts</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; host/service config file
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="spong_groups.html">spong.groups</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; group config file
+
+&nbsp;
+
+&nbsp;&nbsp;&nbsp; src:
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="spong.html">spong.pl</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; text based spong display client
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="spong-client.html">spong-client.pl</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; collects/reports cpu,disk,etc info
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="spong-network.html">spong-network.pl</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; collects/reports network service info
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="spong-server.html">spong-server.pl</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; listens for/saves spong status updates
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="spong-message.html">spong-message.pl</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; alerts humans there's a problem
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="spong-ack.html">spong-ack.pl</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; text based acknowledgement program
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="www-spong.html">www-spong.pl</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; web based spong display client
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="www-spong-ack.html">www-spong-ack.pl</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; web based acknowledgement program</pre>
+
+<pre>
+
+&nbsp;&nbsp;&nbsp; www:</pre>
+
+<pre>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; docs:
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;*>.html&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; documentation for the above files&nbsp;
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; gifs:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; various icons used by spong-display
+
+
+
+</pre>
+
+<h2>
+Licensing</h2>
+Copyright 1999, Stephen Johnson
+<p>&nbsp;Like Perl, spong may be copied only under the terms of either
+the Artistic License or the GNU General Public License, which may be found
+in the Perl 5.0 source kit. If either file is not available to you, send
+email to <a href="mailto:sjohnson@monsters.org">sjohnson@monsters.org</a>,
+and I will mail you a copy.
+<p><a NAME="whats_new"></a>
+<h2>
+Changes</h2>
+The list of changes can be found at:
+<blockquote><a href="http://monsters.org/pub/spong/CHANGES">http://monsters.org/pub/spong/CHANGES</a></blockquote>
+You can see a list of features that I hope to add to spong at:
+<ul><a href="http://monsters.org/pub/spong/TODO.html">http://monsters.org/pub/spong/TODO.html</a></ul>
+
+<h2>
+History</h2>
+
+<table BORDER=0 WIDTH="100%" NOSAVE >
+<tr NOSAVE>
+<td ALIGN=LEFT VALIGN=TOP NOSAVE>Version 2.6</td>
+
+<td>Notification rules enhanced with matching and excluding by host groups.
+Added delayed and repeat notifications. Module Plugin mechanisms added
+to spong-client, spong-network, spong-server, and spong-message programs.
+Programs now automatic background themselves. Event duration added to spong-server
+database. NTP and SSH checks added to spong-network.</td>
+</tr>
+
+<tr NOSAVE>
+<td ALIGN=LEFT VALIGN=TOP NOSAVE>Version 2.5&nbsp;</td>
+
+<td>First releae by Stephen L johnson. Rules based notifications added,
+a limited Big Brother Server emulation was to allow Big Bother Clients
+to be used. A new log monitoring routnie which tracks last position read.
+Enhanced network checks to eliminate momentary network problems.</td>
+</tr>
+
+<tr NOSAVE>
+<td ALIGN=LEFT VALIGN=TOP NOSAVE>Version 2.0&nbsp;</td>
+
+<td>A OO redesign of the spong-server and display programs, added acknowledgments
+and group support, added a text based interface, made www interface more
+extensible.&nbsp;</td>
+</tr>
+
+<tr>
+<td ALIGN=LEFT VALIGN=TOP>Version 1.1&nbsp;</td>
+
+<td ALIGN=LEFT VALIGN=TOP>Primarily a bug fix release with a few minor
+features (dns,http config,multiple interfaces) added.&nbsp;</td>
+</tr>
+
+<tr>
+<td ALIGN=LEFT VALIGN=TOP>Version 1.0&nbsp;</td>
+
+<td ALIGN=LEFT VALIGN=TOP>Initial public release, mostly based on Big Brother
+package from Sean MacGuire.&nbsp;</td>
+</tr>
+</table>
+
+<h2>
+Acknowledgments</h2>
+Many ideas (and some code) came from two similar packages. We have used
+a program call "Pong" here at The University of Iowa for about a year.
+Pong was written by Helen Harrison at SAS Institute and a paper on it was
+presented at the Usenix LISA conference. Pong would allow us to do simple
+monitoring of systems (via ping) and would report machine status via a
+web page. The name of this package (Son of PONG, but pronounced as its
+spelled "spong") is an obvious rip off...
+<p>Originally, the main concepts and design came from Big Brother written
+by Sean MacGuire. That package was written in C and sh scripts which I
+``ported'' to Perl, making many changes along the way (like adding more
+information to the messages going from the client to the server, adding
+history, changing the way that information is displayed, added some configuration
+options, etc.).
+<p>There didn't seem to be any interest in my perl code from the author
+of BB, so I've changed the name so there would be any confusion between
+this package and its inspiration.
+<p>I'd also like to thank the many people who have contributed patches
+and comments, and where willing to try out spong and help me work out a
+few of the early problems.
+<p>The about acknowledgements are from Ed Hill. I would like to thank Ed
+hill&nbsp; for creating Spong and allowing me to take up the development
+touch. The current Spong user and development community is small but growing.&nbsp;
+i would like to thank them for their patient in allowing me to whip the
+Spong distribution into shape and helping me work out the numerous installation
+problems.
+<br>&nbsp;
+<br>&nbsp;
+<h2>
+Known Problems in v2.6</h2>
+Here are a list of problems, and possible fixes that have been reported
+for version 2.8. I will update this section as bugs come in (if there are
+any 8-). These fixes will all be included in the next release of spong,
+but if you can't wait - here are some suggestions.
+<br>&nbsp;
+<br>&nbsp;
+<ul>
+<li>
+<b>Memory leak in spong-network on RedHat 6.0</b> - spong-network has a
+memory leak when running on a RedHat 6.0 Linux system. The program memory
+core size grows after each check cycle. The fix is to upgrade the glibc
+from version 2.1.2 to version 2.1.2.</li>
+</ul>
+
+<h2>
+Author</h2>
+Ported&nbsp; by:
+<p><a href="http://strobe.weeg.uiowa.edu/~edhill/">Ed Hill</a> (<a href="mailto:ed-hill@uiowa.edu">ed-hill@uiowa.edu</a>)
+<br>Internet Software Developer at <a href="http://www.uiowa.edu/">The
+University of Iowa</a>
+<p>Currently maintained by:
+<br><a href="mailto:sjohnson@monsters.org">Stephen L Johnson</a> (<a href="mailto:sjohnson@monsters.org">sjohnson@monsters.org</a>)
+<p>Please feel free to send me bug reports, patches, suggestions, or comments.
+<p>
+<hr>Most recently updated on Dec 15, 1997 by <a href="mailto:sjohnson@monsters.org">Stephen
+L Johnson</a> (<a href="mailto:sjohnson@monsters.org">sjohnson@monsters.org</a>)
+</body>
+</html>
index 594602d19ee39c5623c9d1267020188c514f8de2..58430edf5caae645de4de29d539c812afcf06729 100755 (executable)
@@ -28,6 +28,9 @@ of the checks.
 <li>Make spong-network check more often on hosts that do not respond on the\r
 first try\r
 \r
+<li>Add some limited event correlation to spong-network to not report service\r
+problems is a parent router/swith is unreachable.\r
+\r
 <li>Optimize the communication between client and server - by pipelining\r
 reports through a single channel and perhaps compressing the data before\r
 sending it.\r
@@ -35,7 +38,7 @@ sending it.
 <li>Make it so that you can click on a host and find out status, history, \r
 configuration (inventory), and statistics. (starting to branch out).\r
 \r
-<li>Integrate my gstats (statistics collection) program. "spong-stats" (Ed Hill)\r
+<li>Integrate gstats (statistics collection) program. "spong-stats" (Ed Hill)\r
 <li>Add an inventory/configuration module. "spong-config"\r
 \r
 <li>Continue modularizing to move towards Object Oriented as much as possible.\r
@@ -43,9 +46,12 @@ configuration (inventory), and statistics. (starting to branch out).
 <li>Add control ports to spong-client,spong-network, and spong-server to\r
 ultimately allow the programs to be control and configured remotely\r
 \r
+<li>Add stats package to record and display status update inforation in\r
+RRD Tool databases. "spong-rrd"\r
+\r
 </ul>\r
 <hr>\r
-Most recently updated on Dec. 6, 1999 by\r
+Most recently updated on Dec. 15, 1999 by\r
 Stephen L Johnson\r
 (<a href="mailto:sjohnson@monsters.org">sjohnson@monsters.org</a>)\r
 </BODY>\r