-<HEAD><CENTER><TITLE>spong-server</TITLE>\r\r
-</CENTER></HEAD>\r\r
-<BODY><p><hr>\r\r
-\r\r
-<H1> \r\r
-<A NAME="spong-server_name_0">\r\r
-NAME</A>\r\r
-</H1>\r\r
-<STRONG>spong-server</STRONG> - save status information reported by spong programs\r\r
-<p><p><hr>\r\r
-\r\r
-<H1> \r\r
-<A NAME="spong-server_synopsis_0">\r\r
-SYNOPSIS</A>\r\r
-</H1>\r\r
-<STRONG>spong-server</STRONG> [--debug] [--kill|--restart] [config_file]\r\r
-<p><p><hr>\r\r
-\r\r
-<H1> \r\r
-<A NAME="spong-server_description_0">\r\r
-DESCRIPTION</A>\r\r
-</H1>\r\r
-The spong-server program starts up and listens to status reports from various\r\r
-spong clients (specifically the spong-network and various spong-client programs\r\r
-running). It takes the information reported by the various spong clients and\r\r
-does the following:\r\r
-<p>\r\r
-<XMP>\r\r
- * Check for valid messages, and discards any invalid ones.\r\r
- * If the message is something worth notifying someone about, it calls\r\r
- the spong-message program and lets it determine how/if to contact \r\r
- someone about the problem.\r\r
- * Check to see if the color of this message is different then it\r\r
- used to be, and if so generate a history item indicating the change.\r\r
- * Save the information in the $SPONGSTATUS directory.\r\r
-\r\r
-</XMP>\r\r
-<p>Each time a message comes in, a child process is forked off to handle the above\r\r
-tasks, while the main spong-server program goes back to waiting for more\r\r
-status reports.\r\r
-<p>You should start this program in your system startup file, and it should be\r\r
-running constantly. If you provide the --debug flag, then debugging\r\r
-information will be printed to stdout, otherwise output will only be\r\r
-produced if there is a problem.\r\r
-<p>If you provide the --restart flag, a signal will be sent to the spong-server\r\r
-process that is currently running that will cause it to reload it's\r\r
-configuration files. If you provide the --kill flag, a signal will be sent to\r\r
-the running spong-server process causing it to exit.\r\r
-<p><p><hr>\r\r
-\r\r
-<H1> \r\r
-<A NAME="spong-server_configuration_0">\r\r
-CONFIGURATION</A>\r\r
-</H1>\r\r
-The configuration of the spong-server program is two fold, the first part is\r\r
-the \r\r
-<A HREF="spong-server.html#spong-server_usr_local_etc_spong_spong_hosts_0">/usr/local/etc/spong/spong.hosts</A>\r\r
- file. This file lists the host that are being\r\r
-monitored by the spong-network and spong-client programs. Only status\r\r
-information on hosts in the spong.hosts file are considered valid and saved.\r\r
-<p>The second part of the configuration is the \r\r
-<A HREF="spong-server.html#spong-server_usr_local_etc_spong_spong_conf_0">/usr/local/etc/spong/spong.conf</A>\r\r
- file which\r\r
-define some specific variables that you probably don't need to override. By\r\r
-default the spong.conf file is read on startup. You can specify an alternate\r\r
-config file via a command line option and it will read that file instead. If\r\r
-you change values in the configuration file you will need to restart this\r\r
-program for those changes to be re-read.\r\r
-<p>After reading the configuration file that you specify (or the default), it then\r\r
-reads the <EM>/usr/local/etc/spong/spong.conf.[host]</EM> file where [host] is the hostname of\r\r
-the machine that you are running on. Since these configuration files are just\r\r
-standard perl code that gets imported, the variables that you define in the\r\r
-host specific config file will take precedence over the standard configuration\r\r
-settings.\r\r
-<p>Here are a list of variables in the spong.conf file that are applicable to the\r\r
-spong-server program:\r\r
-<p>\r\r
-<DL>\r\r
-<DT>\r\r
-\r\r
-<STRONG>\r\r
-\r\r
-<A NAME="spong-server_send_message_0">\r\r
-$SEND_MESSAGE</A>\r\r
-\r\r
-</DT></STRONG>\r\r
-<DD>\r\r
-\r\r
-<A HREF="spong-server.html#spong-server_send_message_0">$SEND_MESSAGE</A>\r\r
- defines when spong-message is called by spong-server. This\r\r
-variable can contain one of three valid values. If it is ``RED'', then\r\r
-spong-message is called for every time a system or service reports a problem.\r\r
-If its value is ``CHANGE'', then spong-message is only called when there is a\r\r
-change of state (going from green to red, and then again going from red to\r\r
-green). If its value is ``NONE'', then spong-message is never called.\r\r
-<p>\r\r
-<DT>\r\r
-<STRONG>$SPONGPORT</STRONG>, <STRONG>$SPONGSTATUS</STRONG>, <STRONG>$SPONGHISTORY</STRONG>, <STRONG>$SPONGNOTES</STRONG><DD>\r\r
-The port number that the server should be listening at, and some directory\r\r
-locations where status information, history information, and host specific\r\r
-documentation are kept.\r\r
-<p>\r\r
-</DL>\r\r
-<p><hr>\r\r
-\r\r
-<H1> \r\r
-<A NAME="spong-server_files_0">\r\r
-FILES</A>\r\r
-</H1>\r\r
-<p>\r\r
-<DL>\r\r
-<DT>\r\r
-\r\r
-<STRONG>\r\r
-\r\r
-<A NAME="spong-server_usr_local_etc_spong_spong_conf_0">\r\r
-/usr/local/etc/spong/spong.conf</A>\r\r
-\r\r
-</DT></STRONG>\r\r
-<DD>\r\r
-Configuration file. This contains variables that detail spong and OS specific\r\r
-definitions used by spong-server. See <EM>spong.conf</EM> for additional\r\r
-documentation.\r\r
-<p>\r\r
-<DT>\r\r
-\r\r
-<STRONG>\r\r
-\r\r
-<A NAME="spong-server_usr_local_etc_spong_spong_hosts_0">\r\r
-/usr/local/etc/spong/spong.hosts</A>\r\r
-\r\r
-</DT></STRONG>\r\r
-<DD>\r\r
-Host and human configuration file. This defines what hosts you are monitoring,\r\r
-and what human you should contact if there is a problem. See <EM>spong.hosts</EM>\r\r
-for additional documentation.\r\r
-<p>\r\r
-<DT>\r\r
-\r\r
-<STRONG>\r\r
-\r\r
-<A NAME="spong-server_local_www_docs_spong_status_0">\r\r
-/local/www/docs/spong/status/</A>\r\r
-\r\r
-</DT></STRONG>\r\r
-<DD>\r\r
-The directory where status information is saved. The files in this directory\r\r
-should be readable by your web server as spong-display using this information\r\r
-to generate the web pages that it displays.\r\r
-<p>\r\r
-<DT>\r\r
-\r\r
-<STRONG>\r\r
-\r\r
-<A NAME="spong-server_local_www_docs_spong_history_0">\r\r
-/local/www/docs/spong/history/</A>\r\r
-\r\r
-</DT></STRONG>\r\r
-<DD>\r\r
-The directory where history information is stored. The files in this directory\r\r
-should also be readable by your web server.\r\r
-<p>\r\r
-<DT>\r\r
-\r\r
-<STRONG>\r\r
-\r\r
-<A NAME="spong-server_local_www_docs_spong_notes_0">\r\r
-/local/www/docs/spong/notes/</A>\r\r
-\r\r
-</DT></STRONG>\r\r
-<DD>\r\r
-The directory where host specific information is stored. For each host that\r\r
-you monitor, if there is a file in this directory with the same name as that\r\r
-host then that file will be displayed by spong-display when the user clicks on\r\r
-a specific host.\r\r
-<p>\r\r
-</DL>\r\r
-<p><hr>\r\r
-\r\r
-<H1> \r\r
-<A NAME="spong-server_dependencies_0">\r\r
-DEPENDENCIES</A>\r\r
-</H1>\r\r
-Perl v5.003 or greater is required.\r\r
-<p><p><hr>\r\r
-\r\r
-<H1> \r\r
-<A NAME="spong-server_bugs_0">\r\r
-BUGS</A>\r\r
-</H1>\r\r
-It is not sufficiently paranoid. It should probably perform more strict\r\r
-authentication to protect against bogus data.\r\r
-<p><p><hr>\r\r
-\r\r
-<H1> \r\r
-<A NAME="spong-server_see_0">\r\r
-SEE ALSO</A>\r\r
-</H1>\r\r
-the <EM>spong-network</EM> manpage\r\r
-, the <EM>spong-client</EM> manpage\r\r
-, the <EM>spong-display</EM> manpage\r\r
-, the <EM>spong-message</EM> manpage\r\r
-,\r\r
-<EM>spong.hosts</EM>, <EM>spong.conf</EM>\r\r
-<p><p><hr>\r\r
-\r\r
-<H1> \r\r
-<A NAME="spong-server_author_0">\r\r
-AUTHOR</A>\r\r
-</H1>\r\r
-Ed Hill (<A HREF="MAILTO:ed-hill@uiowa.edu">ed-hill@uiowa.edu</A>), Unix System Administrator, The University of Iowa\r\r
-<p>Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong).\r\r
-<p>\r\r
-</BODY>\r\r
-</HTML>\r\r
+<!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>spong-server</b> - save status information reported by spong programs
+<p>
+<hr>
+<h1>
+<a NAME="spong-server_synopsis_0"></a>SYNOPSIS</h1>
+<b>spong-server</b> [--debug] [--kill|--restart] [config_file]
+<p>
+<hr>
+<h1>
+<a NAME="spong-server_description_0"></a>DESCRIPTION</h1>
+The spong-server program starts up and listens to status reports from various
+spong clients (specifically the spong-network and various spong-client
+programs running). It takes the information reported by the various spong
+clients and does the following:
+<pre>
+ * Check for valid messages, and discards any invalid ones.
+
+ * If the message is something worth notifying someone about, it calls
+
+ the spong-message program and lets it determine how/if to contact
+
+ someone about the problem.
+
+ * Check to see if the color of this message is different then it
+
+ used to be, and if so generate a history item indicating the change.
+
+ * Save the information in the $SPONGSTATUS directory.
+
+
+
+
+
+</pre>
+Each time a message comes in, a child process is forked off to handle the
+above tasks, while the main spong-server program goes back to waiting for
+more status reports.
+<p>You should start this program in your system startup file, and it should
+be running constantly. If you provide the --debug flag, then debugging
+information will be printed to stdout, otherwise output will only be produced
+if there is a problem.
+<p>If you provide the --restart flag, a signal will be sent to the spong-server
+process that is currently running that will cause it to reload it's configuration
+files. If you provide the --kill flag, a signal will be sent to the running
+spong-server process causing it to exit.
+<p>
+<hr>
+<h1>
+<a NAME="spong-server_configuration_0"></a>CONFIGURATION</h1>
+The configuration of the spong-server program is two fold, the first part
+is the <a href="spong-server.html#spong-server_usr_local_etc_spong_spong_hosts_0">/usr/local/etc/spong/spong.hosts</a>
+file. This file lists the host that are being monitored by the spong-network
+and spong-client programs. Only status information on hosts in the spong.hosts
+file are considered valid and saved.
+<p>The second part of the configuration is 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. By default the spong.conf file is read 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.
+<p>After reading the configuration file that you specify (or the default),
+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.
+<p>Here are a list of variables in the spong.conf file that are applicable
+to the spong-server program:
+<dl>
+<dt>
+<a NAME="spong-server_send_message_0"></a><b>$SEND_MESSAGE</b></dt>
+
+<dd>
+<a href="spong-server.html#spong-server_send_message_0">$SEND_MESSAGE</a>
+defines when spong-message is called by spong-server. This variable can
+contain one of three 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 (going from green to red, and then again going from red
+to
+green). If its value is ``NONE'', then spong-message is never called.</dd>
+
+<dt>
+<b>$SPONGPORT</b>, <b>$SPONGSTATUS</b>, <b>$SPONGHISTORY</b>, <b>$SPONGNOTES</b></dt>
+
+<dd>
+ The port number that the server should be listening at, and some
+directory locations where status information, history information, and
+host specific documentation are kept.</dd>
+
+<br>
+<hr WIDTH="100%">
+<h3>
+DATA MODULES</h3>
+<b>spong-server</b> has a plugin and registry mechanism what provides a
+hook for access incoming status updates. Any data plugin modules placed
+into the <i>SPONGHOME/lib/Spong/plugins</i> directory will be loaded upon
+<b>spong-server</b> initialization. As each module it registers itself
+with the plugin registry (see the <a href="developer-guide.html">Developer
+Guide</a>). There are no standard Server Data Modules. There are some sample
+modules in the <i>contrib/plugins/spong-server</i> directory of the Spong
+distribution. For more information in developing a Server Data Modules
+see the <b><a href="spong-server-mod-template.html">spong-server
+module template</a></b> documenation.</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>
+
+<dt>
+<a NAME="spong-server_usr_local_etc_spong_spong_hosts_0"></a><b>/usr/local/etc/spong/spong.hosts</b></dt>
+
+<dd>
+Host and human configuration file. This defines what hosts you are monitoring,
+and what human you should contact if there is a problem. See <i>spong.hosts</i>
+for additional documentation.</dd>
+
+<dt>
+<a NAME="spong-server_local_www_docs_spong_status_0"></a><b>/local/www/docs/spong/status/</b></dt>
+
+<dd>
+The directory where status information is saved. The files in this directory
+should be readable by your web server as spong-display using this information
+to generate the web pages that it displays.</dd>
+
+<dt>
+<a NAME="spong-server_local_www_docs_spong_history_0"></a><b>/local/www/docs/spong/history/</b></dt>
+
+<dd>
+The directory where history information is stored. The files in this directory
+should also be readable by your web server.</dd>
+
+<dt>
+<a NAME="spong-server_local_www_docs_spong_notes_0"></a><b>/local/www/docs/spong/notes/</b></dt>
+
+<dd>
+The directory where host specific information is stored. For each host
+that you monitor, if there is a file in this directory with the same name
+as that host then that file will be displayed by spong-display when the
+user clicks on a specific host.</dd>
+
+<br>
+<p> </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>
+It is not sufficiently paranoid. It should probably perform more strict
+authentication to protect against bogus data.
+<p>
+<hr>
+<h1>
+<a NAME="spong-server_see_0"></a>SEE ALSO</h1>
+the <i>spong-network</i> manpage , the <i>spong-client</i> manpage , the
+<i>spong-display</i> manpage , the <i>spong-message</i> manpage , <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
+<p>Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong).
+</body>
+</html>
projects / spong.git / commitdiff