From 0cecbfbb3b6934f8f67665a4809bf59651144898 Mon Sep 17 00:00:00 2001 From: Stephen L Johnson Date: Wed, 29 Dec 1999 04:28:22 +0000 Subject: [PATCH] Updated documentation for Status History feature. --- www/docs/spong_conf.html | 150 +++++++++++++++++++++------------------ www/docs/user-guide.html | 12 ++-- 2 files changed, 84 insertions(+), 78 deletions(-) diff --git a/www/docs/spong_conf.html b/www/docs/spong_conf.html index 2577a59..2d892a6 100755 --- a/www/docs/spong_conf.html +++ b/www/docs/spong_conf.html @@ -109,6 +109,15 @@ The port the the spong-server listens at for Big Brother client status updates. This spong-server only provides partial Big Brother emulation at present. It will only understand status updates, +
+$STATUS_HISTORY
+ +
+This flag is used to enable status updates to keep in the History. If active, +any status update that generated a History event will be store with the +event.  This option can potentially generate a large amount of file +data. The file system then the $SPONGDB resides should have a large capacity.
+
$WWW_USE_IMAGES
@@ -168,17 +177,18 @@ staff. www-spong will generate "smart" links depending on the web page being displayed. for more information on this feature, please see the Administrator Guide. -
$WWW_ACTIONBAR_CUSTOM +
+$WWW_ACTIONBAR_CUSTOM
-This parameter can be used to customize the Host/Service displays Action Bar -of the Web Interface. Any HTML code in this parameter will be included on -the Web Pages when they are displayed. This parameter is preprocessed by -eval'ed before the contents is printed. Your can include complex +This parameter can be used to customize the Host/Service displays Action +Bar of the Web Interface. Any HTML code in this parameter will be included +on the Web Pages when they are displayed. This parameter is preprocessed +by +eval'ed before the contents is printed. Your can include complex perl variables and simple Perl code in this parameter. NOTE: Use single -quoted to enclose the parameter contents to prevent premature expansion of -any perl variables defined. -
+quoted to enclose the parameter contents to prevent premature expansion +of any perl variables defined.
@WWW_REFRESH_ALLOW
@@ -187,7 +197,7 @@ any perl variables defined. A list of Perl regular expressions that are checked against the REMOTE_ADDR, REMOTE_HOST and REMOTE_USER enviornmental CGI varables. If there is a match on any of these variables, www-spong will -attach a REFRESH meta tag to reload the web pages every $SPONGSLEEP +attach a REFRESH meta tag to reload the web pages every $SPONGSLEEP seconds. See the Administrator Guide for more details. @@ -205,35 +215,37 @@ Guide for more details.
 
-

SPONG CLEANUP VARIABLES +

+SPONG CLEANUP VARIABLES

-
$SPONG_ARCHIVE +
+$SPONG_ARCHIVE
-The directory where to put old history file entries for each host. Each host have it's own file in this directory -
+The directory where to put old history file entries for each host. Each +host have it's own file in this directory -
$OLD_HISTORY +
+$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 $SPONG_ARCHIVE directory. -
+
+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 +$SPONG_ARCHIVE directory.>
-
$OLD_SERVICE +
+$OLD_SERVICE
-
This is the number of days to retain stale service status (i.e. purple +
+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. -
- +entries older than $OLD_SERVICE days old are deleted from the database.

-SERVICE THRESHOLD VARIABLES

+SERVICE THRESHOLD VARIABLES
@@ -246,31 +258,30 @@ having ``:'' in this list will cause NFS file system mounts to be ignored.
 
-%DFWARN, %DFCRIT
+%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.
+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.
 
-$CPUWARN, $CPUCRIT
+$CPUWARN, $CPUCRIT
- A number indicating the CPU load that triggers a problem ($CPUWARN -triggers warnings - yellow, and $CPUCRIT triggers alerts - red).
+A number indicating the CPU load that triggers a problem ($CPUWARN triggers +warnings - yellow, and $CPUCRIT triggers alerts - red).
 
-@PROCSWARN, @PROCSCRIT
+@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).
+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).
 
@@ -278,47 +289,45 @@ then trigger a problem (processes in @PROCSWARN trigger a warning
A list of hashes which defined checks to apply to log files. Each hash -contains the fields logfile which is the full path to the log file -to check and checks whch  is a list of check to apply to the -log file. Each check is a hash that contains the fields: pattern -- a Perl regular expression to be scanned for, status - the status -color to reported lines matching pattern, duration - the duration that -each event is to be reported to the server, text - the text to reported -back in the detailed message field of the status report (which can include -match position variables from pattern) and id - an optional -key field to associated with each event generated.  See the check_logs -documentation for more information and examples.
+contains the fields logfile which is the full path to the log file to check +and checks whch  is a list of check to apply to the log file. Each +check is a hash that contains the fields: pattern - a Perl regular expression +to be scanned for, status - the status color to reported lines matching +pattern, duration - the duration that each event is to be reported to the +server, text - the text to reported back in the detailed message field +of the status report (which can include match position variables from pattern) +and id - an optional key field to associated with each event generated.  +See the check_logs documentation for +more information and examples.
 
-%HTTPDOCS, %HTTPPORT
+%HTTPDOCS, %HTTPPORT
These variables provide some parameters when checking http based servers. -The %HTTPDOCS variable is keyed by host (or the string ``ALL'' for -all hosts), and contains as a value, a list of documents to check on that -host. The default setting is to search for the ``/robots.txt'' file on -all hosts.
+The %HTTPDOCS variable is keyed by host (or the string ``ALL'' for all +hosts), and contains as a value, a list of documents to check on that host. +The default setting is to search for the ``/robots.txt'' file on all hosts.
-The %HTTPPORT variable contains the port number that web server -on a given host is running on. By default the value is 80, but this can -be overridden on a host by host basis
+The %HTTPPORT variable contains the port number that web server on a given +host is running on. By default the value is 80, but this can be overridden +on a host by host basis
 
$SEND_MESSAGE
-$SEND_MESSAGE defines when spong-message is called by spong-server. -This variable can contain one of four valid values. If it is ``RED'', then -spong-message +$SEND_MESSAGE defines when spong-message is called by spong-server. This +variable can contain one of four 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 . If this values is "RED-CHANGE", then spong-message -is called  everytime a system of service reported a problem and when +value is ``CHANGE'', then spong-message is only called when there is a +change of state . If this values is "RED-CHANGE", then spong-message is +called  everytime a system of service reported a problem and when the condition is cleared. (going from green/yellow to red, and then again -going from red to green/yellow). If its value is ``NONE'', then spong-message +going from red to green/yellow). If its value is ``NONE'', then spong-message is never called.

  @@ -343,12 +352,11 @@ person in an hour. The default value is 3.

-OS SPECIFIC VARIABLES

+OS SPECIFIC VARIABLES
-$DF, $UPTIME, $PS, $GREP, $PING, $TRACEROUTE, -$MAILQ
+$DF, $UPTIME, $PS, $GREP, $PING, $TRACEROUTE, $MAILQ
These variables are OS specific variables, which are hopefully set correctly @@ -358,7 +366,7 @@ what OS you are running on, and what the correct value should be.

-FUNCTIONS

+FUNCTIONS DEPRECIATED:  spong-client checks are now modules. See Client Modules in the Developer Guide documentation. @@ -398,7 +406,7 @@ mail queue is not getting too large.

-FILES

+FILES
@@ -423,16 +431,16 @@ first, and then if it can not find it - it looks for the shorter name.

-SEE ALSO

+SEE ALSO the perl manpage , the spong-server manpage , the spong-network manpage , the spong-client manpage , the spong-display manpage , the spong-message manpage , spong.hosts

-AUTHOR

+AUTHOR Ed Hill (ed-hill@uiowa.edu), Unix -System Administrator, The University of Iowa +System Administrator, The University of Iowa<
Stephen L Johnson (stephen.johnson@mail.state.ar.us) or (sjohnson@monsters.org), Unix System Administator, DIS - State of Arkansas

Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong). diff --git a/www/docs/user-guide.html b/www/docs/user-guide.html index ec5959e..b412805 100755 --- a/www/docs/user-guide.html +++ b/www/docs/user-guide.html @@ -213,7 +213,9 @@ History The recent event history of the host will be displayed in this section. The events are displayed in reverse chronological orders divided into seperate days. Each event has the status color, time (in 24 hour format), host name, -service name, and message summary line of the event. +service name, and message summary line of the event. If $STATUS_HISTORY +is enabled, the status color icon/box will be a link that will display +the Service Status update that generated the event.

Service Status Display

This display shows all of the infomation available for the service/host. @@ -257,12 +259,8 @@ Acknowledgment. See the www-spong-ack documentation for more information.

COMMAND LINE USER INTERFACE

-The command line interface is provided by the spong documentation. - +The command line interface is provided by the spong +documentation.

ACKNOWLEDGMENTS

Spong Acknowlegements are a mechanism that allows the user to notify the -- 2.30.2