From: Stephen L Johnson Date: Thu, 4 Nov 1999 22:57:54 +0000 (+0000) Subject: Initial import X-Git-Tag: start~29 X-Git-Url: http://git.etc.gen.nz/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=619310ec144fd4f4cee5258da6c22018fb848084;p=spong.git Initial import --- diff --git a/www/docs/changes.html b/www/docs/changes.html new file mode 100755 index 0000000..5cebdc2 --- /dev/null +++ b/www/docs/changes.html @@ -0,0 +1,181 @@ + + +Spong v1.1 - ChangeLog + + + +

Spong v1.1 - ChangeLog

+
+ +This file documents the changes that have been made to spong from release to +release, currently I have only updated spong once, but I will be adding new +features and change things around from time to time, and this document will log +those changes. Here is a quick overview of significant changes, scroll below +for a more detailed summary:

+ +

+ +Thanks to those (even my co-workers) who have contributed either code or just +suggestions. I have tried to put names next to changes where people +contributed patches. I'm not promising that I used the contributed code as is, +but I tried to stay true in most cases to what was asked for. If I left off +someone's name I apologize.

+

+ +

Changes between spong 1.0 and spong 1.1

+ +Released 04/15/1997

+ +This is primarily a bug fix release with a few minor features added. +Everything done in this release is based on feedback that I got from my +co-workers and people who decided to take a look at spong after my message to +the BB list. The most significant changes are:

+ +

+ +Here is a more detailed summary of changes, organized by file(s).

+ +

+
all: +
  • changed the way that the hostname was determined so that it got set to +the FQDN regardless of how you define the hostname on the host. (Russell +Street) +
  • Converted the hostname to lowercase to ward off problems with names not +matching up correctly. (Carlos Canau). +

    + +

    spong-server: + +
  • stoped ignoring child processes, this fixes a problem with defunct +processes under Solaris + +
  • changed the accept() loop to make it identical to the one in the latest +camel book - was having odd problems with the way that I had it. + +
  • dumps it's pid to a file in the spong directory, and if you kill -HUP +the process it will now re-exec itself, effectively re-reading the +spong.conf/spong.hosts files. Also added two new command line options: +--restart will cause the running spong-server to reread it's config files (it +really just restarts itself), and --kill will kill the current running +spong-server program. (Russell Street) + +
  • added a configuration option ($SEND_MESSAGE) so that you can decided if +you want to send a message every time there is a red report, or only if there +is a change in state of some service (send a message when it goes red, and send +it again when it goes green). + +
  • stopped filtering out blank lines in messages sent from the clients. +

    + +

    spong-network: + +
  • added a DNS check. If a system is running a DNS server, the dns server +will be asked to resolve it's own name, and if it can then all is assumed to be +ok, otherwise an error is generated. This check will only take place if you +have the Net::DNS perl module installed (available from CPAN - +http://www.perl.com/CPAN/) (Russell Street - although probably less then he +wanted 8-) + +
  • sleep the standard amount plus some random 10% time period just so +things don't get in some goofy pattern... + +
  • made the http check more configurable, it now allows you to specify what +port to check, and what file(s) to check for - you can now use the http check +to check on proxy servers. + +
  • dumps it's pid to a file in the spong directory, and if you kill -HUP +the process it will now re-exec itself, effectively re-reading the +spong.conf/spong.hosts files. Also added two new command line options: +--restart will cause the running spong-network to reread it's config files (it +really just restarts itself), and --kill will kill the current running +spong-network program. (Russell Street) + +
  • added a new host attribute (ip_addr) in the spong.hosts file that allow +you to specify if a machine has multiple network interfaces (you need to list +each interface's IP address) the app, and then spong-network will attempt to +ping each interface + +
  • stopped doing traceroutes to machines that are down. It took too long, +and can overload your network. I now just show the ping output as the message +when the host is down. +

    + +

    spong-client: + +
  • sleep the standard amount plus some random 10% time period just so +things don't get in some goofy pattern... + +
  • spong-client: Added single quotes around process check so that you can +check for strings with spaces and other odd characters. + +
  • adjusted the regular expression so that it doesn't leave off the first +part of the mount point (Russell Street) + +
  • Checked against both the filesystem and mounted on directory for +strings to ignore. + +
  • spong-client: dumps it's pid to a file in the spong directory, and if +you kill -HUP the process it will now re-exec itself, effectively re-reading +the spong.conf/spong.hosts files. Also added two new command line options: +--restart will cause the running spong-client to reread it's config files (it +really just restarts itself), and --kill will kill the current running +spong-client program. (Russell Street)

    + +

    spong-display: + +
  • changed the "stale" time to 3 times the sleep time, with the new +randomness of the sleep, and given that it can take a while for spong-network +to do its thing, a value of 3 seems better then 2 for now. +

    + +

    spong-message: + +
  • added "color" as another argument, this was needed when I added the +ability to send a message just based on a change of state. + +
  • added a couple of configuration variables so that you can alter how +often you want messages sent. +

    + +

    other files: + +
  • README: updated to include licensing information, also moved away from +the readme.pod file to just creating it based on the readme.html file (since +pod2html doesn't make the readme page look good enough in HTML). + +
  • Got rid of Makefile, decided that since you have to have Perl to use +this program, I just wrote a simple build script in Perl - this gets around +problems I had with the Makefile, and different versions of make (thanks though +to those who gave me patches for the Makefile). The new "build" script also +fixes the following couple of problems: + +
      +
    • No chown/chgrp to root - let people install it how they like... +
    • if you make more then once, the OS specific stuff gets added each time +
    • adds more instructions to the installation process +
    + +
  • new spong.conf.linux: from (Baba Z Buehler) +
  • added spong.conf.solaris: from (Baba Z Buehler) + +
    • +
    +Most recently updated on Apr 3, 1997 by +Ed Hill +(ed-hill@uiowa.edu) + + + + diff --git a/www/docs/check_cpu.html b/www/docs/check_cpu.html new file mode 100755 index 0000000..a710f91 --- /dev/null +++ b/www/docs/check_cpu.html @@ -0,0 +1,68 @@ + + + + + + check_cpu + + + +
    +

    +NAME

    +check_cpu - check cpu load levels and uptimes +

    +

    +

    +DESCRIPTION

    +This is a client check that is run by spong-client that checks the +client host's cpu load levels and uptime. check_cpu used the output +of the uptime command by checking the the second load average number +(a.k.a 5 minute load average). The load average is checked against the +$CPUWARN +and $CPUCRIT levels. If the load level exceeds $CPUWARN, +it triggers a warning - yellow, and if the load level exceeds $CPUCRIT, +it triggers an alert - red. +

    The uptime is client host is also checked. If the uptime of the system +is less then one hour,  a warning is triggered to show that the system +has been restarted recently. +
      +

    +OUTPUT RETURNED

    +In the status summary field, the system uptime, 5 minute load average, +current number of users logged in and the total number job running on the +system are returned. +

    If the system ps command is capable of it, the top 10 processes, sorted +by cpu percentage, are returned in the status detailed message field. +

    +CONFIGURATION

    +Here is a list of all of the configuration variables used by check_cpu. +
    $CPUWARN, $CPUCRIT +
    A number inidicating the CPU load that triggers a problem ($CPUWARN +triggers warning - yellow, and $CPUCRIT triffers alerts - red). +

    $UPTIME +
    An OS specific variable that contains the full path to the uptime +command and any other commands needed to get the uptime output needed for +parsing. +

    $PS +
    An OS specific variable that contains the full path to the ps +command with the paramters needed to the ps command output to display in +the status detailed messages field.

    +FILES +
    +
    +/usr/local/etc/spong/spong.conf
    + +
    +Configuration file. This contains variables that detail spong and OS specific +definitions used by spong-client. This file also contain variables describing +threshold levels. See spong.conf for additional documentation.
    +
    +AUTHOR +

    Stephen L Johnson (stephen.johnson@mail.state.ar.us) +or (sjohnson@monsters.org), +Unix System Administator, DIS - State of Arkansas +
      +
      + + diff --git a/www/docs/check_disk.html b/www/docs/check_disk.html new file mode 100755 index 0000000..b34fab4 --- /dev/null +++ b/www/docs/check_disk.html @@ -0,0 +1,79 @@ + + + + + + + + +

    +

    +NAME

    +check_disk - disk space client check modules +

    +

    +

    +DESCRIPTION

    +This is a client check that is run by spong-client that checks disk +space and swap space on the client host. check_disk  uses the +output of the df command by checking the percentage of space used +by each mounted file system. The percentage of space used is checked against +%DFWARN +and %DFCRIT levels to generate an appropirate  yellow or red +status. +

    Swap space is also checked by using the &get_swap() function +which returns a message and a percentage of total space space used. This +percentage is checked against the $DFWARN{'page'} and $DFCRIT{'page'} +entry levels to generate an appropriate yellow or red status. +
      +

    +OUTPUT RETURNED

    +SUMMARY MESSAGE FIELD +
    If all statuses are green, check_disk returns the largest file system +in use. Otherwise If any file systems are in red status, a list all of +the mount points with the percent of space used is returned. +

    DETALED MESSAGE FIELD +
    The output of the df command and the message returned by the +&get_swap +function are returned. +
      +

    +CONFIGURATION

    +Here is a list of all of the configuration variables used by check_disk. +
    @DFIGNORE +
    A list of regular expression strings that are matched against the raw +file system names. If matched, then that file system is ignored. For example, +having ``:'' in this list will cause NFS file system mounts to be ignored. +

    %DFWARN, %DFCRIT +
    A hash of file systems (or the word ``ALL''), and the percentage that +should trigger a problem (%DFWARN triggers warnings - yellow, and +%DFCRIT +triggers alerts - red). If a file system is not explicitly listed in this +hash then it will fall back to the value of the ``ALL'' entry. +

    $DF +
    An OS specific variable that contains the path to the df command  +and paramters to be run to get file systems used information. +

    &get_swap() +
    An OS specific function that get the total space space usage information. +It returns two paramaters: message - a strings containing the swap +usage information to be returned in the detail message field of the status +message, and total_swap - a percentage of the total amount of space +space in use. +
     

    +FILES +
    +
    +/usr/local/etc/spong/spong.conf
    + +
    +Configuration file. This contains variables that detail spong and OS specific +definitions used by spong-client. This file also contain variables describing +threshold levels. See spong.conf for additional documentation.
    +
    +AUTHOR +

    Stephen L Johnson (stephen.johnson@mail.state.ar.us) +or (sjohnson@monsters.org), +Unix System Administator, DIS - State of Arkansas +
      + + diff --git a/www/docs/check_processes.html b/www/docs/check_processes.html new file mode 100755 index 0000000..3d62007 --- /dev/null +++ b/www/docs/check_processes.html @@ -0,0 +1,63 @@ + + + + + + + check_processes + + + +

    +

    +NAME

    +check_processes - running processes client check module +
    +
    +

    +DESCRIPTION

    +This is a client check that is run from the spong-client that checks to +ensure that critical processes are running on the client host system. check_processes +uses the output of the $PS command to check against @PROCSWARN +and @PROCSCRIT.  Any jobs not found in the @PROCSWARN +list of processes generates a warning - yellow. Any jobs not found in the +@PROCSCRIT +list of processes generates an alert - red. +
      +

    +OUTPUT RETURNED

    +SUMMARY MESSAGE FIELD +
    If no warning or alerts, check_processes returns "processes OK". Otherwise, +if are any warning or alerts, a list of the processes that are not running +is returned. +

    DETAILED MESSAGE FIELD +
    A $PS output line of every instance is returned for every running +process. +

    +CONFIGURATION

    +This is a list of configuration variable that are used by check_processes. +
    @PROCSWARN, @PROCSCRIT +
    A list of processes that should be running, if they are not running, +then trigger a problem (processes in @PROCSWARN trigger a warning +- yellow, and processes in @PROCSCRIT trigger an alert - red). +

    $PS +
    An OS specific contains the full path to the ps along with any parameters +need to get the desired formated output.

    +FILES +
    +
    +/usr/local/etc/spong/spong.conf
    + +
    +Configuration file. This contains variables that detail spong and OS specific +definitions used by spong-client. This file also contain variables describing +threshold levels. See spong.conf for additional documentation.
    +
    +AUTHOR +

    Stephen L Johnson (stephen.johnson@mail.state.ar.us) +or (sjohnson@monsters.org), +Unix System Administator, DIS - State of Arkansas +
      +
      + + diff --git a/www/docs/spong-2_0.html b/www/docs/spong-2_0.html new file mode 100755 index 0000000..fb386b9 --- /dev/null +++ b/www/docs/spong-2_0.html @@ -0,0 +1,399 @@ + +Simple System/Network Monitoring - spong v2.0 + + + +

    Simple System/Network Monitoring - spong v2.0

    +
    + +

    Description

    +This is a simple system monitoring package called spong. It has the +following features: +

    + +

    + +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).

    + +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:

    + +

    + +Spong is currently at version 2.0. If you are using an older version and want +to see what's new in version 2.0, please look at the +bottom on this page.

    + +

    Availability

    + +Perl is require to run spong. If you don't have Perl installed you can +retrieve it from the CPAN (http://www.perl.com/CPAN/) 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:

    + +

    + +You can retrieve the latest version of spong from my machine at:

    + +

    + +You can see some screen shots of spong in action (note these are just examples +of HTML that is produced - not the actual programming running - most people +don't want this level of system information public to the world (if they can +help it).

    + +

    +

    This distribution contain the spong source, documentation, and gif images. +

    + +

    Notification

    + +I have sent up a mailing list that I will post to when I have released a new +version of spong. Anyone can join this list, but the traffic will be only one +way (me posting information about new-releases). If enough people are +interested in creating a list for discussion spong in general, I will set one +up at that time. I try to answer any questions that are sent to me.

    + +To join the spong-announce mailing list, send a message to +majordomo@strobe.weeg.uiowa.edu with the sentence:

    + +

    + +in the body of the message. To have yourself removed from the +spong-announce mailing list, send a message to +majordomo@strobe.weeg.uiowa.edu with the sentence unsubscribe +spong-announce in the body of the message.

    + +The traffic on the list will be very light - about 1 message per month at +most.

    + + +

    Dependencies

    + +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.

    + +These scripts should run on any Unix system (and to ``some'' degree any +environment where Perl is available). I will try to make sure the scripts run +under NT when I have better access to an NT machine.

    + + +

    Installation

    + +To build and install the spong server do the following on the machine running +your web server.

    + +

      +
    1. Edit the "build" script, and set the variables at the top of that script +according to where you want spong installed, and where certain programs that +spong relies on are located.

      + +

    2. Check to make sure there is a config/spong.conf.<os> file corresponding +to your operating system, if not - create one. This file contains paths and +command line arguments to helper programs that are used to determine things +like disk usage, etc... If you have to create your own spong.conf.<os> +file, then please email it to me so that I can add it to the distribution. +

      + +

    3. Make sure you are in the directory that you unpacked spong in and type: +./build <os> where <os> is the name corresponding to your +operating system. You can type ./build help to generate a list of +valid operating system strings.

      + +When the build completes, you will be left with some new directories in the +folder that you unpacked spong in. The build process takes the spong source +(and documentation), and replaces some "tokens" with values that you have +supplied at the top of the build script. The build process also creates a +spong.conf file, and generates various types of documentation based on the POD +files that come with spong.

      + +

    4. Now, type ./build install. Note that the install process +makes no assumptions about what user you want to run spong as (you don't +have to run it as root). This means that you have to be a little more careful +when you install spong (making sure it has the correct permissions, and that +you have permission to copy the www pages into your web server's document +tree).

      + +

    5. Now edit the spong.conf, and spong.hosts files that you just installed and +season to taste. You should now be able to read the manual pages for each.

      +

    + +Now you will have the executables and configuration files in place on the +server. You need to start the spong-server and spong-network programs. The +spong-server program will listen for reports from various agents, and the +spong-network program will start testing the hosts you have defined for any +problems. After starting those programs, you should start seeing files show up +in the SPONGSTATUS directory that you defined in the spong.conf file.

    + +For each client machine you will need to install the just the spong-client and +a spong.conf file and make sure they start up when your system is rebooted. +

    + +

    Documentation

    + +Don't let the amount of documentation scare you, I still think spong is simple +to setup and use.

    + +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.

    + +There are four main documents that describe spong from different +perspectives.

    + +

    +
    Overview +
    Just that, gives a quick 5 minute overview of what spong is and what it can +do.

    + +

    User's Guide +
    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.

    + +

    Administrator's Guide +
    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.

    + +

    Developer's Guide +
    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.

    +

    + +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.

    + +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.

    + +

    Files

    + +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.

    + +

    
+    config:

+      spong.conf              distributed config file

+      spong.conf.<os>         os specific config changes

+      spong.hosts             host/service config file

+      spong.groups            group config file

+ 

+    src:

+      spong.pl                text based spong display client

+      spong-client.pl         collects/reports cpu,disk,etc info

+      spong-network.pl        collects/reports network service info

+      spong-server.pl         listens for/saves spong status updates

+      spong-message.pl        alerts humans there's a problem

+      spong-ack.pl            text based acknowledgement program

+      www-spong.pl            web based spong display client

+      www-spong-ack.pl        web based acknowledgement program

+

+    docs:

+      <*>.html                documentation for the above files

+ 

+    www:

+      gifs:                   various icons used by spong-display

+

+
    + +

    Licensing

    + +Copyright 1997, Ed Hill - The University of Iowa

    + +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 ed-hill@uiowa.edu, and I will mail you a +copy.

    + + +

    Changes between v2.0 and v1.1

    + +The most significant change in version 2.0 is a rewrite and redesign of spong +internals to move towards a more modular and OO framework. The first version +of spong was just a port of the BB program to perl with some of my own +modifications, this version contains a significant rewrite of the spong-server +program to make it more object oriented and extensible. I believe this puts +spong in a better position to maintain (by me) and extend (by you). + +The spong-client and spong-network programs are still pretty much the same + +Other then the redesign issue, this release has a few new features and +programs, and some bug fixes (as well as some new introductions I'm sure). The +most significant changes are:

    + +

    + +You can see a list of features that I hope to add to spong at:

    + +

    + + +

    History

    + + + + + + + + + + + + + + +
    Version 2.0 +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. +
    Version 1.1 +Primarily a bug fix release with a few minor features (dns,http config,multiple +interfaces) added. +
    Version 1.0 +Initial public release, mostly based on Big Brother package from Sean MacGuire. +
    +

    + +

    Acknowledgments

    + +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...

    + +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.).

    + +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.

    + +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.

    + +

    Known Problems in v2.0

    + +Here are a list of problems, and possible fixes that have been reported for +version 2.0. 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.

    + +

    + +

    Author

    + +Ported and currently maintained by: +

    + +Ed Hill (ed-hill@uiowa.edu)
    +Internet Software Developer at +The University of Iowa

    + +

    Please feel free to send me bug reports, patches, suggestions, or comments. +

    +

    +Most recently updated on Aug 1, 1997 by +Ed Hill +(ed-hill@uiowa.edu) + + + diff --git a/www/docs/spong-server.html b/www/docs/spong-server.html new file mode 100755 index 0000000..9f984f9 --- /dev/null +++ b/www/docs/spong-server.html @@ -0,0 +1,215 @@ +
    spong-server +
    +

    + +

    + +NAME +

    +spong-server - save status information reported by spong programs +

    + +

    + +SYNOPSIS +

    +spong-server [--debug] [--kill|--restart] [config_file] +

    + +

    + +DESCRIPTION +

    +The spong-server program starts up and listens to status reports from various +spong clients (specifically the spong-network and various spong-client programs +running). It takes the information reported by the various spong clients and +does the following: +

    +

    + * Check for valid messages, and discards any invalid ones. + * If the message is something worth notifying someone about, it calls + the spong-message program and lets it determine how/if to contact + someone about the problem. + * Check to see if the color of this message is different then it + used to be, and if so generate a history item indicating the change. + * Save the information in the $SPONGSTATUS directory. + + +

    Each time a message comes in, a child process is forked off to handle the above +tasks, while the main spong-server program goes back to waiting for more +status reports. +

    You should start this program in your system startup file, and it should be +running constantly. If you provide the --debug flag, then debugging +information will be printed to stdout, otherwise output will only be +produced if there is a problem. +

    If you provide the --restart flag, a signal will be sent to the spong-server +process that is currently running that will cause it to reload it's +configuration files. If you provide the --kill flag, a signal will be sent to +the running spong-server process causing it to exit. +

    + +

    + +CONFIGURATION +

    +The configuration of the spong-server program is two fold, the first part is +the +/usr/local/etc/spong/spong.hosts + file. This file lists the host that are being +monitored by the spong-network and spong-client programs. Only status +information on hosts in the spong.hosts file are considered valid and saved. +

    The second part of the configuration is the +/usr/local/etc/spong/spong.conf + file which +define some specific variables that you probably don't need to override. By +default the spong.conf file is read on startup. You can specify an alternate +config file via a command line option and it will read that file instead. If +you change values in the configuration file you will need to restart this +program for those changes to be re-read. +

    After reading the configuration file that you specify (or the default), it then +reads the /usr/local/etc/spong/spong.conf.[host] file where [host] is the hostname of +the machine that you are running on. Since these configuration files are just +standard perl code that gets imported, the variables that you define in the +host specific config file will take precedence over the standard configuration +settings. +

    Here are a list of variables in the spong.conf file that are applicable to the +spong-server program: +

    +

    +
    + + + + +$SEND_MESSAGE + +
    +
    + +$SEND_MESSAGE + defines when spong-message is called by spong-server. This +variable can contain one of three valid values. If it is ``RED'', then +spong-message is called for every time a system or service reports a problem. +If its value is ``CHANGE'', then spong-message is only called when there is a +change of state (going from green to red, and then again going from red to +green). If its value is ``NONE'', then spong-message is never called. +

    +

    +$SPONGPORT, $SPONGSTATUS, $SPONGHISTORY, $SPONGNOTES
    +The port number that the server should be listening at, and some directory +locations where status information, history information, and host specific +documentation are kept. +

    +

    +

    + +

    + +FILES +

    +

    +

    +
    + + + + +/usr/local/etc/spong/spong.conf + +
    +
    +Configuration file. This contains variables that detail spong and OS specific +definitions used by spong-server. See spong.conf for additional +documentation. +

    +

    + + + + +/usr/local/etc/spong/spong.hosts + +
    +
    +Host and human configuration file. This defines what hosts you are monitoring, +and what human you should contact if there is a problem. See spong.hosts +for additional documentation. +

    +

    + + + + +/local/www/docs/spong/status/ + +
    +
    +The directory where status information is saved. The files in this directory +should be readable by your web server as spong-display using this information +to generate the web pages that it displays. +

    +

    + + + + +/local/www/docs/spong/history/ + +
    +
    +The directory where history information is stored. The files in this directory +should also be readable by your web server. +

    +

    + + + + +/local/www/docs/spong/notes/ + +
    +
    +The directory where host specific information is stored. For each host that +you monitor, if there is a file in this directory with the same name as that +host then that file will be displayed by spong-display when the user clicks on +a specific host. +

    +

    +

    + +

    + +DEPENDENCIES +

    +Perl v5.003 or greater is required. +

    + +

    + +BUGS +

    +It is not sufficiently paranoid. It should probably perform more strict +authentication to protect against bogus data. +

    + +

    + +SEE ALSO +

    +the spong-network manpage +, the spong-client manpage +, the spong-display manpage +, the spong-message manpage +, +spong.hosts, spong.conf +

    + +

    + +AUTHOR +

    +Ed Hill (ed-hill@uiowa.edu), Unix System Administrator, The University of Iowa +

    Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong). +

    + + diff --git a/www/docs/todo.html b/www/docs/todo.html new file mode 100755 index 0000000..a6dbce7 --- /dev/null +++ b/www/docs/todo.html @@ -0,0 +1,84 @@ + + +Spong v1.1 - Todo List + + + +

    Spong v1.1 - Todo List

    +
    + +Here are the features/changes that I want to make to spong. They are in no +particular order, but I will probably be working on the things at the top of +this list before I get to the ones on the bottom. If you have any suggestions +or comments, send email to ed-hill@uiowa.edu. I have no specific time +schedule in mind for implementing this list. Spong is now a night-time +project, so I get to this things when I can.

    + +I have put *'s next to the items that I am currently working on - or have +completed in cased you are curious about my progress.

    + +

    +
    +Most recently updated on May 8, 1997 by +Ed Hill +(ed-hill@uiowa.edu) + +