From f40e2421f9dd7073b340879953cf2b8e04854a95 Mon Sep 17 00:00:00 2001 From: Stephen L Johnson Date: Wed, 17 Nov 1999 05:19:44 +0000 Subject: [PATCH] Initial revision --- www/docs/www-spong.html | 210 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 210 insertions(+) create mode 100755 www/docs/www-spong.html diff --git a/www/docs/www-spong.html b/www/docs/www-spong.html new file mode 100755 index 0000000..376467f --- /dev/null +++ b/www/docs/www-spong.html @@ -0,0 +1,210 @@ + + + + + + spong-server + + + +
+

+NAME

+www-spong - display spong system status via the web or generate +static HTML pages of system status +

+

+

+SYNOPSIS

+www-spong [--summary [hostlist] | --problems [hostlist] | --history +[hostlist] | --host host | --services host | --stats host +
                           +| --config host | --info host | --service host:service ] [--brief | --standard +| --full ] +

+

+

+DESCRIPTION

+The www-spong program interfaces with the spong-server to display the collected +information  in HTML format. www-spong can be run in two modes: as +a CGI program and from the command line. +

When run as a CGI program it does not have to loaded onto the same machine +that spong-server is runnning. It queries the spong-server through it's +query port. it will display information via a web page that reloads itself +at regular intervals.  When run with no parameters it created a page +wth two frames.  The left frame displays a summary of systems along +with their associated problems (services that are red). The right panel +is a table that lists the hosts and services, and the current status is +a colored block or an icon depending on how spong-server is configured. +For further information on how to use the web interface see the User +Guide. +

When run from a command line, www-spong generatesHTML pages that are +printed to the console. This mode can be used to generate static HTML pages. +If www-spong is run with any parameters a page that contains a summary +display for all hosts is generated. +
  +

+Options

+ +
+--summary  [hostlist]
+ +
+ Summarize the status of hosts, in hostlist, in a table that lists +the hosts and services, and the current status is a colored block or an +icon depending on how spong-server is configured. If hostlist if not specified +all hosts defined in spong.hosts are displayed.
+ +
+--problems  [hostlist]
+ +
+Shows a summary of all the problems (services that are red) for the all +the hosts in hostlist. If hostlist is not specified, all hosts defined +in spong.hosts are displayed.
+ +
+--history  [hostlist]
+ +
+Show history information for the the list of hosts in hostlist. If host +list is not specified, all hosts defined in spong.hosts are displayed.
+ +
  +

  +
  +
  +

+--host  host
+ +
+Shows all information availiable for the given host.
+ +
+--services host
+ +
+Shows detailed service information for the given host.
+ +
+--stats host
+ +
+Show statistical information for the given host.
+ +
+--config host
+ +
+Shows configuration intomation for the given host.
+ +
+--info host
+ +
+Shows admin supplied text for the given host.
+ +
  +

  +
  +
  +

+--service host:service
+ +
+Shows detailed information for the given host/service. The
+ +
  +

  +

--brief +

+Display output in a brief format
+ +
+--standard
+ +
+Display output in standard format (the default)
+ +
+--full
+ +
+Display the maximum amount of information possible.
+ +
  +

  +

+

+

+CONFIGURATION

+By default, www-spong reads the /usr/local/etc/spong/spong.conf +file which define some specific variables that you probably don't need +to override. +

By default the  /usr/local/etc/spong/spong.conf   +file is read on startup. It defines some specific variable that you probably +don't need to override. +

After reading the configuration fil,  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: +
  +
+$SPONGSERVER
+ +
+The make of the server that spong-server is running on.
+ +
  +
+$SPONG_QUERY_PORT
+ +
+The port numbr that spong-server listens at for database queries.
+
+ +
+

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

+DEPENDENCIES

+Perl v5.003 or greater is required. +

+

+

+BUGS

+The --stats, --config, and --info parameters are currently +not implemented in the spong-server. When specified they will just generate +a blank HTML page.. +
+
+

+SEE ALSO

+ spong.hosts, spong.conf +

+

+

+AUTHOR

+Ed Hill (ed-hill@uiowa.edu), Unix +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). + + -- 2.30.2