From: Stephen L Johnson <sjohnson@monsters.org> Date: Wed, 17 Nov 1999 05:19:44 +0000 (+0000) Subject: Initial import X-Git-Tag: start~13 X-Git-Url: http://git.etc.gen.nz/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=41740f51be4746c1c13e0bfbaa11bfe1c82b5479;p=spong.git Initial import --- 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 @@ +<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <meta name="GENERATOR" content="Mozilla/4.61 [en] (X11; U; Linux 2.2.12-20 i686) [Netscape]"> + <title>spong-server</title> +</head> +<body> + +<hr> +<h1> +<a NAME="spong-server_name_0"></a>NAME</h1> +<b>www-spong</b> - display spong system status via the web or generate +static HTML pages of system status +<p> +<hr> +<h1> +<a NAME="spong-server_synopsis_0"></a>SYNOPSIS</h1> +<b>www-spong</b> [--summary [hostlist] | --problems [hostlist] | --history +[hostlist] | --host host | --services host | --stats host +<br> +| --config host | --info host | --service host:service ] [--brief | --standard +| --full ] +<p> +<hr> +<h1> +<a NAME="spong-server_description_0"></a>DESCRIPTION</h1> +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. +<p>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 <b><a href="/home/sjohnson/user-guide.html">User +Guide</a></b>. +<p>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. +<br> +<h2> +Options</h2> + +<dt> +<b>--summary [hostlist]</b></dt> + +<dd> + 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.</dd> + +<dt> +<b>--problems [hostlist]</b></dt> + +<dd> +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.</dd> + +<dt> +<b>--history [hostlist]</b></dt> + +<dd> +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.</dd> + +<br> +<p> +<br> +<br> +<dt> +<b>--host host</b></dt> + +<dd> +Shows all information availiable for the given host.</dd> + +<dt> +<b>--services host</b></dt> + +<dd> +Shows detailed service information for the given host.</dd> + +<dt> +<b>--stats host</b></dt> + +<dd> +Show statistical information for the given host.</dd> + +<dt> +<b>--config host</b></dt> + +<dd> +Shows configuration intomation for the given host.</dd> + +<dt> +<b>--info host</b></dt> + +<dd> +Shows admin supplied text for the given host.</dd> + +<br> +<p> +<br> +<br> +<dt> +<b>--service host:service</b></dt> + +<dd> +Shows detailed information for the given host/service. The</dd> + +<br> +<p> +<p><b>--brief</b> +<dd> +Display output in a brief format</dd> + +<dt> +<b>--standard</b></dt> + +<dd> +Display output in standard format (the default)</dd> + +<dt> +<b>--full</b></dt> + +<dd> +Display the maximum amount of information possible.</dd> + +<br> +<p> +<p> +<hr> +<h1> +<a NAME="spong-server_configuration_0"></a>CONFIGURATION</h1> +By default, www-spong reads the <a href="spong-server.html#spong-server_usr_local_etc_spong_spong_conf_0">/usr/local/etc/spong/spong.conf</a> +file which define some specific variables that you probably don't need +to override. +<p>By default the <a href="spong-server.html#spong-server_usr_local_etc_spong_spong_conf_0">/usr/local/etc/spong/spong.conf</a> +file is read on startup. It defines some specific variable that you probably +don't need to override. +<p>After reading the configuration fil, it then reads the <i>/usr/local/etc/spong/spong.conf.[host]</i> +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. +<dl>Here are a list of variables in the spong.conf file that are applicable +to the spong-server program: +<br> +<dt> +$<b>SPONGSERVER</b></dt> + +<dd> +The make of the server that spong-server is running on.</dd> + +<br> +<dt> +<b>$SPONG_QUERY_PORT</b></dt> + +<dd> +The port numbr that spong-server listens at for database queries.</dd> +</dl> + +<hr> +<h1> +<a NAME="spong-server_files_0"></a>FILES</h1> + +<dl> +<dt> +<a NAME="spong-server_usr_local_etc_spong_spong_conf_0"></a><b>/usr/local/etc/spong/spong.conf</b></dt> + +<dd> +Configuration file. This contains variables that detail spong and OS specific +definitions used by spong-server. See <i>spong.conf</i> for additional +documentation.</dd> +</dl> + +<hr> +<h1> +<a NAME="spong-server_dependencies_0"></a>DEPENDENCIES</h1> +Perl v5.003 or greater is required. +<p> +<hr> +<h1> +<a NAME="spong-server_bugs_0"></a>BUGS</h1> +The <b>--stats</b>, <b>--config</b>, and <b>--info</b> parameters are currently +not implemented in the spong-server. When specified they will just generate +a blank HTML page.. +<br> +<hr> +<h1> +<a NAME="spong-server_see_0"></a>SEE ALSO</h1> + <i>spong.hosts</i>, <i>spong.conf</i> +<p> +<hr> +<h1> +<a NAME="spong-server_author_0"></a>AUTHOR</h1> +Ed Hill (<a href="MAILTO:ed-hill@uiowa.edu">ed-hill@uiowa.edu</a>), Unix +System Administrator, The University of Iowa +<br>Stephen L Johnson (<a href="MAILTO:stephen.johnson@mail.state.ar.us">stephen.johnson@mail.state.ar.us</a>) +or (<a href="MAILTO:sjohnson@monsters.org">sjohnson@monsters.org</a>), +Unix System Administator, DIS - State of Arkansas +<p>Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong). +</body> +</html>