From: Stephen L Johnson Date: Wed, 27 Sep 2000 03:57:38 +0000 (+0000) Subject: removed the rest of the POD documentation X-Git-Tag: spong-2_7_0-beta1~20 X-Git-Url: http://git.etc.gen.nz/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=916a3c328736683140fcb5885a11dd0f1730d76d;p=spong.git removed the rest of the POD documentation --- diff --git a/src/spong-ack.pl b/src/spong-ack.pl index a9b8b46..b49e89d 100755 --- a/src/spong-ack.pl +++ b/src/spong-ack.pl @@ -291,135 +291,3 @@ _EOF_ exit(0); } -__END__ - -=head1 OPTIONS - -=over - -=item B<--debug> - -Print debugging statements. This option can be specified while creating or deleting acks. - -=item B<--batch> - -Print the ack-id instead of the normal output. The primary use of this parameter -is for scripts. An ack can be created when a job that runs causes a service to -temporarily exceed it's normally limits, or if a service is taken down for an -unknown or irregular length of time. - -=item B<--delete> - -Delete a previously created ack. - -=back - -Here is a descirption of the arguments for creating acks: - -=over - -=item host - -The host having the problem(s) you are acknowledging. - -=item service - -The service or services (seperated by ".") or I services that your are -acknowledging. - -=item time - -The that the acknowledgement will late. This can be an offet "+1h, +3a,d +1w" or -an absolute date and/or time indicator "12/25/1997 14:00:00. The date needs to be -a 4 digit year, and the time needs to be in 24 hour format. - -=item message - -An optional message that will appear to those viewing the state of the host with a -spong display program. If the value is "-", then the message will read from STDIN. - -=back - -Here is a description of the arguments for deleting acks: - -=over - -=item ack-id - -The acknowledgment id to delete. The id can be obtained by using the B<--batch> -parameter when creating the acknowledgment, or by using the L command -with the B<--brief> and B<--ack> parameters. - -=over - -=head1 CONFIGURATION - -=head2 Configuration Files - -B reads the standard spong.conf and spong.conf.EhostE -configuration files. - -=head2 Configuration Variables - -=over - -=item $SPONGSERVER - -The host that at least the L and L -programs are running on. Typically the L program runs on that -host as well. - -=item $SPONG_UPDATE_PORT - -This variable defines the port that the L update process listens -on. If this variable is not defined on the I<$SPONGSERVER> host, the -L update process will not be started. The default value is 1998. - -=back - -=head1 FILES - -F, FhostE> - -=head1 EXAMPLES - - spong-ack mailhub.my-inc.com all '05/27/2000 06:00:00' 'Server is being upgraded' - - spong-ack www5.my-inc.com http +1h 'Web server is randomly dying. Investigating.' - -In a shell script: - - ... - HOST=`hostname` - ACKID=`spong-ack --batch $HOST cpu +8h 'Database exports are running'` - ... - # Database exports are done here - ... - spong-ack --delete $ACKID - ... - -=head1 DEPENDENCIES - -Perl v5.005_03 or greater is required. - -=head1 BUGS - -No know bugs. - -=head1 SEE ALSO - -L, L, L - -=head1 AUTHOR - -Stephen L Johnson > - -=head1 HISTORY - -Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong). Ed Hill -original converted Big Brother (http://www.bb4.com) into Perl which diverged -from Big Brother to become Spong. Ed Hill continued Spong development until -version 2.1. Stephen L Johnson took over development in October, 1999 with his -changes which became Spong 2.5. - - diff --git a/src/spong-cleanup.pl b/src/spong-cleanup.pl index 4e0a112..4376428 100755 --- a/src/spong-cleanup.pl +++ b/src/spong-cleanup.pl @@ -164,74 +164,3 @@ sub load_config_files { } } -__END__ - -The B program should be run every night as a cronjob. This will -ensure that database queries are speedy especially the History Log displays. - -=head1 CONFIGURATION - -=head2 Configuration Files - -B reads the standard spong.conf and spong.conf.Ehost -configuration files. - -=head2 Configuration Variables - -=over - -=item $SPONGDB - -This defines the directory where the Spong database will be stored. Each host -will have a subdirectory in this directory which is named for the host. - -=item $SPONG_ARCHIVE - -The directory where to put old history file entries for each host. Each host -has it's own file in this directory. - -=item $OLD_HISTORY - -This is the number of days of history to keep for each host in the -spong-server database. Any old history is append to the file for the host under -the I<$SPONG_ARCHIVE> directory. - -=item $OLD_SERVICE - -This is the number of days to retain stale service status (i.e. purple -status) entries in the spong-server database. Any service service status -entries older than <$OLD_SERVICE> days old are deleted from the -database. - -=back - -=head1 FILES - -F, F - -=head1 DEPENDENCIES - -Perl v5.005_03 or greater is required. - -=head1 BUGS - -None know bugs. - -=head1 SEE ALSO - -L, F - -=head1 AUTHOR - -Ed Hill >, Unix System Administrator, The University of -Iowa - -Stephen L Johnson > - -=head1 HISTORY - -Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong). Ed Hill -original converted Big Brother (http://www.bb4.com) into Perl which diverged -from Big Brother to become Spong. Ed Hill continued Spong development until -version 2.1. Stephen L Johnson took over development in October, 1999 with his -changes which became Spong 2.5. diff --git a/src/spong-client.pl b/src/spong-client.pl index 9f3c6ac..c8379f0 100755 --- a/src/spong-client.pl +++ b/src/spong-client.pl @@ -272,246 +272,3 @@ sub load_checks { } } -__END__ - -The checks are modular in nature. You can configure the number of checks -to run and the order in which to run to them. The list of checks that are -included are disk space, cpu load, running processes and log files. - -=head2 Format of update messages - -It sends a message for each check to the spong server and reports the -following: - -=over - -=item * hostname (where is this report coming from) - -=item * service name ("disk", "cpu", "procs", "logs", "local") - -=item * color ("red", "yellow", "green") - -=item * a one line summary - -=item * a more detailed message providing additional detail. - -=back - - -The color is determined by comparing the current status of that service -against thresholds defined in the configuration file. If they are greater -then the level you have defined for a warning, then the color is yellow. -If they are greater then the critical level you have defined then the color -is red. - -The one line summary provides information that might be useful at a -glance when looking at the overall system status (such as a brief report -on the load, number of users, and uptime). - -The more detailed message contains information such as the complete -df output, or a listing of the top 10 processes sorted by CPU. - -=head2 Running the program - -You should start this program in your system startup file, and it should be -running constantly. If no parameters are specified, B forks -and detaches itself to run as a daemon. - -If you provide the B<--debug> I flag, then debugging information will be -printed to stdout, otherwise output will only be produced if there is a -problem. Where I is a number from 1 - 9. A higher number means more -verbosity in the debugging output. - -If you provide the B<--restart> flag, a signal will be sent to the spong-client -process that is currently running that will cause it to reload it's -configuration files. If you provide the B<--kill> flag, a signal will be sent -to the running spong-client process causing it to exit. - -The B<--nosleep> or B<--refresh> flag causes the program to cycle through all -of the checks once then exit. These flags can be used to run spong-client as a -cron job (B), this reduced the effectiveness of the L -module. - -=head2 Client Checks - -The checks are actually a set of modules that are called in series by -B. The list of modules to run are defined in the I<$CHECKS> -configuration variable. Upon initialization, B will load the -modules defined in I<$CHECKS> from the F -directory. As each modules is initialized, it registers itself with the the -plugins registery (see the L). Spong comes -with a standard set of client checks, see L for more -information. - -=head2 Extending Functionality - -B, please refer to the L section of the Developer Guide. - -If you want to check some service which is not being checked by spong-client, -then you can define a C<&check_local()> function in your -config file (either in your standard L config file or your host specific L -file - but not both!). That function can do anything you want, but at the -end needs to call the C<&status()> function to report -what you have found to the spong server. - -=head1 CONFIGURATION - -=head2 Configuration Files - -By default this reads the L file 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 F file where [hostname] 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. - -=head2 Configuration Variables - -Here is a listing of the configuration variables applicable to the -B program. - -=over - -=item $SPONGSLEEP, $SPONGSERVER, $SPONG_UPDATE_PORT - -Some basic spong configuration options that define how long to sleep (in -seconds) before checking the status of a service again, the hostname of the -spong server, and the port number that the spong server listens - -=item $SPONGSLEEP{'DEFAULT'}, $SPONGSLEEP{'spong-client'} - -This the new method for specifying the $SPONGSLEEP interval for Spong programs. -If there is not $SPONGSLEEP{} entry for the program, it will use the -I<$SPONGSLEEP{'DEFAULT'}> value. If no value is then found, B -fall back to using $SPONGSLEEP. - -=item $SPONGTMP - -The directory that Spong programs use for temporary store and work files. It -should be different directory than F for operation and securiy reasons. - -=item $SPONG_LOG_FILE - -If set to I<1>, B will log errors to a log file in I<$SPONGTMP> -named F. - -=item $SPONG_LOG_SYSLOG - -If set to I<1>, B will log errors to the syslog using the -I facility and the B priority. - -=item $CHECKS - -A string that has the list of client check modules to run. If I<$CHECKS> is -missed or blank, spong-client defaults to "disk cpu processes logs". If the -C function is present then 'local' is appended. - -=item $CPUWARN, $CPUCRIT - -A number indicating the CPU load that triggers a problem (I<$CPUWARN> -triggers warnings - yellow, and I<$CPUCRIT> triggers alerts - red). - -=item @PROCSWARN, @PROCSCRIT - -A list of processes that should be running, if they are not running, then -trigger a problem (processes in I<@PROCSWARN> trigger a warning - yellow, and -processes in I<@PROCSCRIT> trigger an alert - red). - -=item $LOGCHECKS - -A list of hashes which defined checks to apply to log files. Each hash -contains the fields: - -=over - -=item logfile - -which is the full path to the log file to check - -=item checks - -a list of check to apply to the log file. - -=back - -Each check is a hash that contains the fields: - -=over - -=item pattern - -a Perl regular expression to be scanned for - -=item status - -the status color to reported lines matching pattern - -=item duration - -the duration (in seconds) that each event is to be reported to the server - -=item text - -a string which is the the text to be reported -back in the detailed message field of the status report (which can include -match position variables from I) - -=item id - -an optional key field to associated with each event generated. The default -key is the evaluated I field. An id key may be specified for the -for a check pattern. All hits of the pattern will be consolidated into one -event. The data of the last hit will be reported in the event. - -=back - -=item $DF, $UPTIME, $PS, $GREP - -These variables are OS specific variables, which are hopefully set -correctly for your machine, if they are not - please send me email letting -me know what OS you are running on, and what the correct value should be. - -=back - - -=head1 FILES - -F, F - -=head1 EXAMPLES - - spong-client --debug 5 --nosleep - spong-client --debug 5 - spong-client --restart - -=head1 DEPENDENCIES - -Perl v5.005_03 or greater is required. - -=head1 BUGS - -None know bugs. - -=head1 SEE ALSO - -L, F, F, L - -=head1 AUTHOR - -Ed Hill >, Unix System Administrator, The University of -Iowa - -Stephen L Johnson > - -=head1 HISTORY - -Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong). Ed Hill -original converted Big Brother (http://www.bb4.com) into Perl which diverged -from Big Brother to become Spong. Ed Hill continued Spong development until -version 2.1. Stephen L Johnson took over development in October, 1999 with his -changes which became Spong 2.5. diff --git a/src/spong-message.pl b/src/spong-message.pl index 2108520..f2c8042 100755 --- a/src/spong-message.pl +++ b/src/spong-message.pl @@ -835,344 +835,3 @@ sub save_data { umask $umask; } - -__END__ - -=head2 Options - -=over - -=item B<--debug> - -Enables the printing of detailed debugging lines. Can be used in conjunction -with B<--test> to test new messaging rules. - -=item B<--color|--status> I - -Specified the status color of the event being reported. I can be -green, yellow or red. - -=item B<--host> I - -The hostname of the server that is being reported on. - -=item B<--service> I - -The name of the service that is being reported on. - -=item B<--time> I