[Nagios-checkins] nagios/html/docs monitoring-windows.html, 1.5, 1.6 perfdata.html, 1.5, 1.6 quicks

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

Update of /cvsroot/nagios/nagios/html/docs
In directory sc8-pr-cvs16.sourceforge.net:/tmp/cvs-serv22781/html/docs

Modified Files:
	monitoring-windows.html perfdata.html quickstart-fedora.html 
	quickstart-opensuse.html quickstart-ubuntu.html 
Log Message:
Doc updates, new status CGI filter properties

Index: quickstart-ubuntu.html
===================================================================
RCS file: /cvsroot/nagios/nagios/html/docs/quickstart-ubuntu.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** quickstart-ubuntu.html	18 Jun 2007 16:56:30 -0000	1.6
--- quickstart-ubuntu.html	28 Aug 2007 16:41:51 -0000	1.7
***************
*** 150,159 ****

! Download the source code tarballs of both Nagios and the Nagios plugins (visit <a href="http://www.nagios.org/download/">http://www.nagios.org/download/</a> for links to the latest versions). At the time of writing, the latest versions of Nagios and the Nagios plugins were 3.0a4 and 1.4.7, respectively.

  <p>
  <pre>
! wget http://osdn.dl.sourceforge.net/sourceforge/nagios/nagios-3.0a4.tar.gz
  wget http://osdn.dl.sourceforge.net/sourceforge/nagiosplug/nagios-plugins-1.4.7.tar.gz
  </pre>
--- 150,159 ----

! Download the source code tarballs of both Nagios and the Nagios plugins (visit <a href="http://www.nagios.org/download/">http://www.nagios.org/download/</a> for links to the latest versions). At the time of writing, the latest versions of Nagios and the Nagios plugins were 3.0b2 and 1.4.7, respectively.

  <p>
  <pre>
! wget http://osdn.dl.sourceforge.net/sourceforge/nagios/nagios-3.0b2.tar.gz
  wget http://osdn.dl.sourceforge.net/sourceforge/nagiosplug/nagios-plugins-1.4.7.tar.gz
  </pre>
***************
*** 171,176 ****
  <pre>
  cd ~/downloads
! tar xzf nagios-3.0a4.tar.gz
! cd nagios-3.0a4
  </pre>
  </p>
--- 171,176 ----
  <pre>
  cd ~/downloads
! tar xzf nagios-3.0b2.tar.gz
! cd nagios-3.0b2
  </pre>
  </p>

Index: perfdata.html
===================================================================
RCS file: /cvsroot/nagios/nagios/html/docs/perfdata.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** perfdata.html	18 Jun 2007 16:56:30 -0000	1.5
--- perfdata.html	28 Aug 2007 16:41:50 -0000	1.6
***************
*** 54,70 ****

! Check performance data is internal data that relates to the actual execution of a host or service check. This might include things like service check latency (i.e. how "late" was the service check from its scheduled execution time) and the number of seconds a host or service check took to execute. This type of performance data is available for all checks that are performed. The <a href="macrolist.html#hostexecutiontime">$HOSTEXECUTIONTIME$</a> and <a href="macrolist.html#serviceexecutiontime">$SERVICEEXECUTIONTIME$</a> <a href="macros.html">macros</a> can be used to determine the number of seconds a host or service check was running and the <a href="macrolist.html#hostlatency">$HOSTLATENCY$</a> and <a href="macrolist.html#servicelatency">$SERVICELATENCY$</a> macros can be used to determine how "late" a regularly-scheduled host or service check was.

! Plugin performance data is external data specific to the plugin used to perform the host or service check. Plugin-specific data can include things like percent packet loss, free disk space, processor load, number of current users, etc. - basically any type of metric that the plugin is measuring when it executes. Plugin-specific performance data is optional and may not be supported by all plugins. As of this writing, no plugins return performance data, although they mostly likely will in the near future. Plugin-specific performance data (if available) can be obtained by using the <a href="macrolist.html#hostperfdata">$HOSTPERFDATA$</a> and <a href="macrolist.html#serviceperfdata">$SERVICEPERFDATA$</a> <a href="macros.html">macros</a>. See below for more information on how plugins can return performance data to Nagios for inclusion in the $HOSTPERFDATA$ and $SERVICEPERFDATA$ macros.

  <p>
! <strong><u>Performance Data Support For Plugins</u></strong>
  </p>

! Normally plugins return a single line of text that indicates the status of some type of measurable data. For example, the check_ping plugin might return a line of text like the following:

--- 54,70 ----

! Check performance data is internal data that relates to the actual execution of a host or service check. This might include things like service check latency (i.e. how "late" was the service check from its scheduled execution time) and the number of seconds a host or service check took to execute. This type of performance data is available for all checks that are performed. The <a href="macrolist.html#hostexecutiontime">$HOSTEXECUTIONTIME$</a> and <a href="macrolist.html#serviceexecutiontime">$SERVICEEXECUTIONTIME$</a> <a href="macros.html">macros</a> can be used to determine the number of seconds a host or service check was running and the <a href="macrolist.html#hostlatency">$HOSTLATENCY$</a> and <a href="macrolist.html#servicelatency">$SERVICELATENCY$</a> macros can be used to determine how "late" a regularly-scheduled host or service check was.

! Plugin performance data is external data specific to the plugin used to perform the host or service check. Plugin-specific data can include things like percent packet loss, free disk space, processor load, number of current users, etc. - basically any type of metric that the plugin is measuring when it executes. Plugin-specific performance data is optional and may not be supported by all plugins. Plugin-specific performance data (if available) can be obtained by using the <a href="macrolist.html#hostperfdata">$HOSTPERFDATA$</a> and <a href="macrolist.html#serviceperfdata">$SERVICEPERFDATA$</a> <a href="macros.html">macros</a>. Read on for more information on how plugins can return performance data to Nagios for inclusion in the $HOSTPERFDATA$ and $SERVICEPERFDATA$ macros.

  <p>
! <strong><u>Plugin Performance Data</u></strong>
  </p>

! At a minimum, Nagios plugins must return a single line of human-readable text that indicates the status of some type of measurable data. For example, the check_ping plugin might return a line of text like the following:

***************
*** 76,84 ****

! With this type of output, the entire line of text is available in the $HOSTOUTPUT$ or $SERVICEOUTPUT$ <a href="macros.html">macros</a> (depending on whether this plugin was used as a host check or service check).

! In order to facilitate the passing of plugin-specific performance data to Nagios, the plugin specification has been expanded. If a plugin wishes to pass performance data back to Nagios, it does so by sending the normal text string that it usually would, followed by a pipe character (|), and then a string containing one or more performance data metrics. Let's take the check_ping plugin as an example and assume that it has been enhanced to return percent packet loss and average round trip time as performance data metrics. A sample plugin output might look like this:

--- 76,84 ----

! With this simple type of output, the entire line of text is available in the $HOSTOUTPUT$ or $SERVICEOUTPUT$ <a href="macros.html">macros</a> (depending on whether this plugin was used as a host check or service check).

! Plugins can return optional performance data in their output by sending the normal, human-readable text string that they usually would, followed by a pipe character (|), and then a string containing one or more performance data metrics. Let's take the check_ping plugin as an example and assume that it has been enhanced to return percent packet loss and average round trip time as performance data metrics. Sample output from the plugin might look like this:

***************
*** 90,106 ****

! When Nagios seems this format of plugin output it will split the output into two parts: everything before the pipe character is considered to be the "normal" plugin output and everything after the pipe character is considered to be the plugin-specific performance data. The "normal" output gets stored in the $HOSTOUTPUT$ or $SERVICEOUTPUT$ macro, while the optional performance data gets stored in the $HOSTPERFDATA$ or $SERVICEPERFDATA$ macro. In the example above, the $HOSTOUTPUT$ or $SERVICEOUTPUT$ macro would contain "PING ok - Packet loss = 0%, RTA = 0.80 ms" (without quotes) and the $HOSTPERFDATA$ or $SERVICEPERFDATA$ macro would contain "percent_packet_loss=0, rta=0.80" (without quotes).

  <p>
! <strong><u>Format of Performance Data Output</u></strong>
  </p>

! The Nagios daemon doesn't directly process performance data, so it doesn't really care what the performance data looks like. There aren't really any inherent limitations on the format or content of the performance data. However, if you are using an external addon to process the performance data (i.e. PerfParse), the addon may be expecting that the plugin returns performance data in a specific format. Check the documentation that comes with the addon for more information. Also, make sure to check the plugin developer guidelines at SourceForge (<a href="http://nagiosplug.sourceforge.net/">http://nagiosplug.sourceforge.net/</a>) for information on writing plugins.

  <p>
! <strong><u>Enabling Performance Data Processing</u></strong>
  </p>

--- 90,117 ----

! When Nagios sees this plugin output format it will split the output into two parts:

! <ol>
! <li>Everything before the pipe character is considered to be the "normal" plugin output and will be stored in either the $HOSTOUTPUT$ or $SERVICEOUTPUT$ macro</li>
! <li>Everything after the pipe character is considered to be the plugin-specific performance data and will be stored in the $HOSTPERFDATA$ or $SERVICEPERFDATA$ macro</li>
! </ol>

! In the example above, the $HOSTOUTPUT$ or $SERVICEOUTPUT$ macro would contain "PING ok - Packet loss = 0%, RTA = 0.80 ms" (without quotes) and the $HOSTPERFDATA$ or $SERVICEPERFDATA$ macro would contain "percent_packet_loss=0, rta=0.80" (without quotes).

! Multiple lines of performace data (as well as normal text output) can be obtained from plugins, as described in the <a href="pluginapi.html">plugin API documentation</a>.
! 
! 
! 
! <img src="images/note.gif" border="0" align="bottom"> Note: The Nagios daemon doesn't directly process plugin performance data, so it doesn't really care what the performance data looks like. There aren't really any inherent limitations on the format or content of the performance data. However, if you are using an external addon to process the performance data (i.e. PerfParse), the addon may be expecting that the plugin returns performance data in a specific format. Check the documentation that comes with the addon for more information.
! 
! 
! 
! Processing Performance Data

***************
*** 112,133 ****
  <ol>
  <li>Enable the <a href="configmain.html#process_performance_data">process_performance_data</a> option.<br><br>
! <li>Configure Nagios so that performance data is written to files and/or processed by executing commands.
  </ol>
  </p>

  <p>
! <strong><u>Writing Performance Data To Files</u></strong>
  </p>

! You can have Nagios write all host and service performance data to files using the <a href="configmain.html#host_perfdata_file">host_perfdata_file</a> and <a href="configmain.html#service_perfdata_file">service_perfdata_file</a> options. You can control how the data is written to those files using the <a href="configmain.html#host_perfdata_file_template">host_perfdata_file_template</a> and <a href="configmain.html#service_perfdata_file_template">service_perfdata_file_template</a> options. Additionally, you can have Nagios periodically execute commands to process the performance data files using the <a href="configmain.html#host_perfdata_file_processing_command">host_perfdata_file_processing_command</a> and <a href="configmain.html#service_perfdata_file_processing_command">service_perfdata_file_processing_command</a> options.

  <p>
! <strong><u>Processing Performance Data Using Commands</u></strong>
  </p>

! You can have Nagios process host and service performance data by executing commands by using the <a href="configmain.html#host_perfdata_command">host_perfdata_command</a> or <a href="configmain.html#service_perfdata_command">service_perfdata_command</a> options. An example command definition that simply writes service performance data to a file is shown below:

--- 123,144 ----
  <ol>
  <li>Enable the <a href="configmain.html#process_performance_data">process_performance_data</a> option.<br><br>
! <li>Configure Nagios so that performance data is either written to files and/or processed by executing commands.
  </ol>
  </p>

! Read on for information on how to process performance data by writing to files or executing commands.

  <p>
! <strong><u>Processing Performance Data Using Commands</u></strong>
  </p>

! The most flexible way to process performance data is by having Nagios execute commands (that you specify) to process or redirect the data for later processing by external applications. The commands that Nagios executes to process host and service performance data are determined by the <a href="configmain.html#host_perfdata_command">host_perfdata_command</a> and <a href="configmain.html#service_perfdata_command">service_perfdata_command</a> options, respectively.

! An example command definition that redirects service check performance data to a text file for later processing by another application is shown below:

***************
*** 135,139 ****
  <pre>
  define command{
! 	command_name	process-service-perfdata
  	command_line	/bin/echo -e "$LASTSERVICECHECK$\t$HOSTNAME$\t$SERVICEDESC$\t$SERVICESTATE$\t$SERVICEATTEMPT$\t$SERVICESTATETYPE$\t$SERVICEEXECUTIONTIME$\t$SERVICELATENCY$\t$SERVICEOUTPUT$\t$SERVICEPERFDATA$" &gt;&gt; /usr/local/nagios/var/service-perfdata.dat
  	}
--- 146,150 ----
  <pre>
  define command{
! 	command_name	store-service-perfdata
  	command_line	/bin/echo -e "$LASTSERVICECHECK$\t$HOSTNAME$\t$SERVICEDESC$\t$SERVICESTATE$\t$SERVICEATTEMPT$\t$SERVICESTATETYPE$\t$SERVICEEXECUTIONTIME$\t$SERVICELATENCY$\t$SERVICEOUTPUT$\t$SERVICEPERFDATA$" &gt;&gt; /usr/local/nagios/var/service-perfdata.dat
  	}
***************
*** 142,145 ****
--- 153,185 ----

+ <p>
+ <img src="images/tip.gif" border="0" align="bottom"> Tip: This method, while flexible, comes with a relatively high CPU overhead.  If you're processing performance data for a large number of hosts and services, you'll probably want Nagios to write performance data to files instead.  This method is described in the next section.
+ </p>
+ 
+ <p>
+ <strong><u>Writing Performance Data To Files</u></strong>
+ </p>
+ 
+ <p>
+ You can have Nagios write all host and service performance data directly to text files using the <a href="configmain.html#host_perfdata_file">host_perfdata_file</a> and <a href="configmain.html#service_perfdata_file">service_perfdata_file</a> options.  The format in which host and service performance data is written to those files is determined by the <a href="configmain.html#host_perfdata_file_template">host_perfdata_file_template</a> and <a href="configmain.html#service_perfdata_file_template">service_perfdata_file_template</a> options.
+ </p>
+ 
+ <p>
+ An example file format template for service performance data might look like this:
+ </p>
+ 
+ <p>
+ <pre>
+ service_perfdata_file_template=[SERVICEPERFDATA]\t$TIMET$\t$HOSTNAME$\t$SERVICEDESC$\t$SERVICEEXECUTIONTIME$\t$SERVICELATENCY$\t$SERVICEOUTPUT$\t$SERVICEPERFDATA$
+ </pre>
+ </p>
+ 
+ <p>
+ By default, the text files will be opened in "append" mode. If you need to change the modes to "write" or "non-blocking read/write" (useful when writing to pipes), you can use the <a href="configmain.html#host_perfdata_file_mode">host_perfdata_file_mode</a> and <a href="configmain.html#service_perfdata_file_mode">service_perfdata_file_mode</a> options.
+ </p>
+ 
+ <p>
+ Additionally, you can have Nagios periodically execute commands to periocially process the performance data files (e.g. rotate them) using the <a href="configmain.html#host_perfdata_file_processing_command">host_perfdata_file_processing_command</a> and <a href="configmain.html#service_perfdata_file_processing_command">service_perfdata_file_processing_command</a> options.  The interval at which these commands are executed are governed by the <a href="configmain.html#host_perfdata_file_processing_interval">host_perfdata_file_processing_interval</a> and <a href="configmain.html#service_perfdata_file_processing_interval">service_perfdata_file_processing_interval</a> options, respectively.
+ </p>

Index: monitoring-windows.html
===================================================================
RCS file: /cvsroot/nagios/nagios/html/docs/monitoring-windows.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** monitoring-windows.html	17 Jul 2007 22:37:58 -0000	1.5
--- monitoring-windows.html	28 Aug 2007 16:41:50 -0000	1.6
***************
*** 73,77 ****

! Other Windows agents (like <a href="http://www.shatterit.com/nc_net/">NC_Net</a>) could be used instead of NSClient++ if you wish - provided you change command and service definitions, etc. a bit. For the sake of simplicity I will only cover using the NSClient++ addon in these instructions.

--- 73,77 ----

! Other Windows agents (like <a href="http://sourceforge.net/projects/nc-net">NC_Net</a>) could be used instead of NSClient++ if you wish - provided you change command and service definitions, etc. a bit. For the sake of simplicity I will only cover using the NSClient++ addon in these instructions.

Index: quickstart-opensuse.html
===================================================================
RCS file: /cvsroot/nagios/nagios/html/docs/quickstart-opensuse.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** quickstart-opensuse.html	18 Jun 2007 16:56:30 -0000	1.6
--- quickstart-opensuse.html	28 Aug 2007 16:41:51 -0000	1.7
***************
*** 121,130 ****

! Download the source code tarballs of both Nagios and the Nagios plugins (visit <a href="http://www.nagios.org/download/">http://www.nagios.org/download/</a> for links to the latest versions). At the time of writing, the latest versions of Nagios and the Nagios plugins were 3.0a4 and 1.4.7, respectively.

  <p>
  <pre>
! wget http://osdn.dl.sourceforge.net/sourceforge/nagios/nagios-3.0a4.tar.gz
  wget http://osdn.dl.sourceforge.net/sourceforge/nagiosplug/nagios-plugins-1.4.7.tar.gz
  </pre>
--- 121,130 ----

! Download the source code tarballs of both Nagios and the Nagios plugins (visit <a href="http://www.nagios.org/download/">http://www.nagios.org/download/</a> for links to the latest versions). At the time of writing, the latest versions of Nagios and the Nagios plugins were 3.0b2 and 1.4.7, respectively.

  <p>
  <pre>
! wget http://osdn.dl.sourceforge.net/sourceforge/nagios/nagios-3.0b2.tar.gz
  wget http://osdn.dl.sourceforge.net/sourceforge/nagiosplug/nagios-plugins-1.4.7.tar.gz
  </pre>
***************
*** 142,147 ****
  <pre>
  cd ~/downloads
! tar xzf nagios-3.0a4.tar.gz
! cd nagios-3.0a4
  </pre>
  </p>
--- 142,147 ----
  <pre>
  cd ~/downloads
! tar xzf nagios-3.0b2.tar.gz
! cd nagios-3.0b2
  </pre>
  </p>

Index: quickstart-fedora.html
===================================================================
RCS file: /cvsroot/nagios/nagios/html/docs/quickstart-fedora.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** quickstart-fedora.html	18 Jun 2007 16:56:30 -0000	1.3
--- quickstart-fedora.html	28 Aug 2007 16:41:50 -0000	1.4
***************
*** 144,153 ****

! Download the source code tarballs of both Nagios and the Nagios plugins (visit <a href="http://www.nagios.org/download/">http://www.nagios.org/download/</a> for links to the latest versions). At the time of writing, the latest versions of Nagios and the Nagios plugins were 3.0a4 and 1.4.7, respectively.

  <p>
  <pre>
! wget http://osdn.dl.sourceforge.net/sourceforge/nagios/nagios-3.0a4.tar.gz
  wget http://osdn.dl.sourceforge.net/sourceforge/nagiosplug/nagios-plugins-1.4.7.tar.gz
  </pre>
--- 144,153 ----

! Download the source code tarballs of both Nagios and the Nagios plugins (visit <a href="http://www.nagios.org/download/">http://www.nagios.org/download/</a> for links to the latest versions). At the time of writing, the latest versions of Nagios and the Nagios plugins were 3.0b2 and 1.4.7, respectively.

  <p>
  <pre>
! wget http://osdn.dl.sourceforge.net/sourceforge/nagios/nagios-3.0b2.tar.gz
  wget http://osdn.dl.sourceforge.net/sourceforge/nagiosplug/nagios-plugins-1.4.7.tar.gz
  </pre>
***************
*** 165,170 ****
  <pre>
  cd ~/downloads
! tar xzf nagios-3.0a4.tar.gz
! cd nagios-3.0a4
  </pre>
  </p>
--- 165,170 ----
  <pre>
  cd ~/downloads
! tar xzf nagios-3.0b2.tar.gz
! cd nagios-3.0b2
  </pre>
  </p>

[Nagios-checkins] nagios/html/docs monitoring-windows.html, 1.5, 1.6 perfdata.html, 1.5, 1.6 quicks

Nagios network monitoring software is enterprise server monitoring

[Nagios-checkins] nagios/html/docs monitoring-windows.html, 1.5, 1.6 perfdata.html, 1.5, 1.6 quickstart-fedora.html, 1.3, 1.4 quickstart-opensuse.html, 1.6, 1.7 quickstart-ubuntu.html, 1.6, 1.7