From 367879bc09325dd7b61aef6552b74a86f0dcbdab Mon Sep 17 00:00:00 2001 From: cvs Date: Tue, 7 Dec 1999 07:17:09 +0000 Subject: [PATCH] Updated documentation with lastest changed. --- www/docs/admin-guide.html | 18 +++++ www/docs/spong-message.html | 4 ++ www/docs/spong_conf.html | 39 +++++++++++ www/docs/spong_message.html | 4 ++ www/docs/todo.html | 136 ++++++++++++++---------------------- 5 files changed, 117 insertions(+), 84 deletions(-) diff --git a/www/docs/admin-guide.html b/www/docs/admin-guide.html index 45f666a..83ee980 100755 --- a/www/docs/admin-guide.html +++ b/www/docs/admin-guide.html @@ -251,6 +251,24 @@ are pager. Most alpha-pages have a message limit of 150-250 characters.  The rest of the form should be populated with whatever field that you need into order to send your messages.
  + +

Customized Action Bar

+The Action Bar of the Host and Service Status Displays (see the +User Guide for more details) can be customized +with the $WWW_ACTIONBAR_CUSTOM + configuration parameter. Any HTML code defined in this parameter +will be included on the end of the Action Bars. + +

This parameter is preprocessed +with eval before the contents are printed. This allows you to +include complex perl variables or perl code. Because of the eval you +should use single quotes to enclose the contents of this parameter. This +will prevent premature evaluation of perl variables before the preprocessing. + +

If your do not need this customization, just leave +$WWW_ACTIONBAR_CUSTOM undefined. Nothing will be added to the Action Bars. + +

WWW_REFRESH LOGIC

The default of the spong-server is to not allow auto-refreshes if @WWW_REFRESH_ALLOW diff --git a/www/docs/spong-message.html b/www/docs/spong-message.html index c152a2f..84c9425 100755 --- a/www/docs/spong-message.html +++ b/www/docs/spong-message.html @@ -97,10 +97,14 @@ contacted, when and how often. attributes:
    * hosts              a list of hosts to match
 
+
    * host_groups             a list of host groups to match
+
     * services           a list of services to match
 
     * exclude_hosts      a list of hosts to exclude
 
+    * exclude_host_groups      a list of hosts groups to exclude
+
     * exclude_services   a list of services to exclude
 
     * times              a list of days/times to match
diff --git a/www/docs/spong_conf.html b/www/docs/spong_conf.html index 7a87b43..2577a59 100755 --- a/www/docs/spong_conf.html +++ b/www/docs/spong_conf.html @@ -168,6 +168,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 + +
+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. +
+
@WWW_REFRESH_ALLOW
@@ -192,6 +204,33 @@ Guide for more details.
  +
+

SPONG CLEANUP VARIABLES + +
+
$SPONG_ARCHIVE + +
+The directory where to put old history file entries for each host. Each host have it's own file in this directory +
+ +
$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. +
+ +
$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. +
+ +
+

SERVICE THRESHOLD VARIABLES

diff --git a/www/docs/spong_message.html b/www/docs/spong_message.html index 8884128..06b145d 100755 --- a/www/docs/spong_message.html +++ b/www/docs/spong_message.html @@ -23,12 +23,16 @@ of the matching criteria are met. attributes:
    * hosts              a list of hosts to match
 
+    * host_groups        a list of hosts groups to match
+
     * services           a list of services to match
 
     * exclude_hosts      a list of hosts to exclude
 
     * exclude_services   a list of services to exclude
 
+    * exclude_host_groups   a list of host groups to exclude
+
     * times              a list of days/times to match
And each rule must have the following attributes:
    * contacts           a list of contacts to notify
diff --git a/www/docs/todo.html b/www/docs/todo.html index a6dbce7..594602d 100755 --- a/www/docs/todo.html +++ b/www/docs/todo.html @@ -1,84 +1,52 @@ - - -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.

- -

    -
  • (*) Rework some of the design of spong to make things more object oriented. -The first version of spong was basically a port of BB, version 2.0 will be -different. This will allow me to more easily integrate new features over time. - -
  • (*) Add nfs (and other rpc based services) to spong-network (using the -rpcinfo command). - -
  • Client support (spong-client) for NT -
  • Server support (spong-server, spong-network, spong-display) support for NT - -
  • (*) Provide different interfaces (currently only web - provide a PerlTk, -and a terminal based interface). - -
  • Provide the ability to view spong information (run the spong, tkspong, and -wwwspong (currently known as spong-display) programs from machines other then -the spong server). - -
  • (*) Redo the web based spong-display to make it more extensible -
      -
    • Allow people to easily put the spong-server CGI program in /cgi-bin/ -
    • Allow people to easily define their own interfaces -
    • Allow people to easily include parts of spong-display.cgi output in -other pages -
    • Allow for multiple views (table, network diagram, simple host summary -with drill down for more specific information) -
    • Handle groups better. - -
    - -
  • Provide a rules based solution to sending pages - this will allow people to -specify whatever rules they want for sending pages when there are problems. - -
  • (*) Add acknowledgements - so that you can say that you know a service is -red - and that you don't want paged about it. You can also add some text so -that others reading spong can have an idea what the problem is, and know -someone is working on it. - -
  • Make spong-network more parallel, have it perform checks from a pool of -children, that way if a system can not be pinged - it will not slow up the rest -of the checks. - -
  • Make spong-network check more often on hosts that do not respond on the -first try - -
  • Optimize the communication between client and server - by pipelining -reports through a single channel and perhaps compressing the data before -sending it. - -
  • Fix the log file checking - make it smarter. - -
  • Make it so that you can click on a host and find out status, history, -configuration (inventory), and statistics. (starting to branch out). -
      -
    • Integrate my gstats (statistics collection) program. "spong-stats" -
    • Add an inventory/configuration module. "spong-config" -
    -
-
-Most recently updated on May 8, 1997 by -Ed Hill -(ed-hill@uiowa.edu) - - + + +Spong v1.1 - Todo List + + + +

Spong - Todo List

+
+ +Here are the features/changes that I and others want to make to spong. They +are in no particular order, If you have any suggestions or comments, send +email to sjohnson@monsters.org.

+ +

    + +
  • Make web interface more configurable: (user selectable backgroup colors/ +method, table shading scheme) + +
  • Add option to use style sheets on Web Interface. + +
  • Client support (spong-client) for NT +
  • Server support (spong-server, spong-network, spong-display) support for NT + +
  • Make spong-network more parallel, have it perform checks from a pool of +children, that way if a system can not be pinged - it will not slow up the rest +of the checks. + +
  • Make spong-network check more often on hosts that do not respond on the +first try + +
  • Optimize the communication between client and server - by pipelining +reports through a single channel and perhaps compressing the data before +sending it. + +
  • Make it so that you can click on a host and find out status, history, +configuration (inventory), and statistics. (starting to branch out). + +
  • Integrate my gstats (statistics collection) program. "spong-stats" (Ed Hill) +
  • Add an inventory/configuration module. "spong-config" + +
  • Continue modularizing to move towards Object Oriented as much as possible. + +
  • Add control ports to spong-client,spong-network, and spong-server to +ultimately allow the programs to be control and configured remotely + +
+
+Most recently updated on Dec. 6, 1999 by +Stephen L Johnson +(sjohnson@monsters.org) + + -- 2.30.2