[Mon-commit] mon/doc mon.8,1.1.1.1,1.2

[David N. <vi...@us...>]

Update of /cvsroot/mon/mon/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29517/doc

Modified Files:
	mon.8 
Log Message:
Added documentation for various new features that will be in Mon 1.1:
'-l' commandline option now supports saving/loading opstatus
new dependency type, 'host'
multiple simultaneous dependency types now possible
'trustlocal' authorization type 
dependency memory
'monremote' config option, for propagating client requests to other servers


Index: mon.8
===================================================================
RCS file: /cvsroot/mon/mon/doc/mon.8,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -C2 -d -r1.1.1.1 -r1.2
*** mon.8	9 Jun 2004 05:18:06 -0000	1.1.1.1
--- mon.8	14 Jun 2004 11:08:21 -0000	1.2
***************
*** 23,26 ****
--- 23,28 ----
  .IR num ]
  .RB [ \-l
+ .IR [ statetype ] ]
+ .RB [ \-L
  .IR dir ]
  .RB [ \-m
***************
*** 106,112 ****
  to 100.
  .TP
! .BI \-l
! Load state from the last saved state file. Currently the only
! supported saved state is disabled watches, services, and hosts.
  .TP
  .BI \-L\ dir
--- 108,124 ----
  to 100.
  .TP
! .BI \-l\ statetype
! Load state from the last saved state file. The 
! supported saved state types are 
! .B disabled
! for disabled watches, services, and hosts, 
! .B opstatus
! for failure/alert/ack status of 
! all services,
! and 
! .B all 
! for both.  If no statetype is provided, 
! .B disabled
! is assumed.
  .TP
  .BI \-L\ dir
***************
*** 347,351 ****
  is set to
  .IR "'a'" ,
! and a parent dependency is failing, then suppress the alert.
  If the alert has previously been acknowledged, do not send
  the alert, unless it is an upalert.
--- 359,365 ----
  is set to
  .IR "'a'" ,
! or
! .B alertdepend
! is set, and a parent dependency is failing, then suppress the alert.
  If the alert has previously been acknowledged, do not send
  the alert, unless it is an upalert.
***************
*** 632,635 ****
--- 646,658 ----
  service will be used.
  
+ If
+ .I type
+ is
+ .BR trustlocal ,
+ then if the client connection comes from locahost, the username passed from 
+ the client will be trusted, and the password will be ignored.  This can be used 
+ when you want the client to handle the authentication for you.  I.e. a CGI script 
+ using one of the many apache authentication methods.
+ 
  .TP
  .BI "userfile = " file
***************
*** 830,840 ****
  
  .TP
! .BI "dep_behavior = " {a|m}
  .B dep_behavior
  controls whether the dependency expression
! suppresses either the running of alerts or monitors
! when a node in the dependency graph fails. Read more
! about the behavior in the "Service Definitions" section
! below.
  
  This is a global setting which controls the default
--- 853,877 ----
  
  .TP
! .BI "dep_behavior = " {a|m|hm}
  .B dep_behavior
  controls whether the dependency expression
! suppresses one of: the running of alerts, the running of 
! monitors, or the passing of individual hosts to the monitors.
! Read more about the behavior in the "Service Definitions" 
! section below.
! 
! This is a global setting which controls the default
! settings for the service-specified variable.
! 
! .TP
! .BI "dep_memory = " timeval
! If set, dep_memory will cause dependencies to continue to prevent
! alerts/monitoring for a period of time after the service returns to a
! normal state.  This can be used to prevent over-eager alerting when a
! machine is rebooting, for example.  See the explanation of
! .I interval
! in the "Service Definitions" section
! for a description of
! .IR timeval .
  
  This is a global setting which controls the default
***************
*** 847,850 ****
--- 884,889 ----
  is the default.
  
+ 
+ 
  .TP
  .BI "startupalerts_on_reset = " {yes|no}
***************
*** 854,857 ****
--- 893,905 ----
  client command is executed. The default is "no".
  
+ .TP
+ .BI "monremote = " program
+ 
+ If set, this external program will be called by Mon when various
+ client requests are processed.  This can be used to propagate those
+ changes from one Mon server to another, if you have multiple
+ monitoring machines.  An example script, 
+ .B monremote.pl
+ is available in the clients directory.
  
  .SS "Hostgroup Entries"
***************
*** 1054,1061 ****
  
  .TP
! .BI dep_behavior " {a|m}"
! The evaluation of dependency graphs
  can control the
! suppression of either alert or monitor invocations.
  
  .BR "Alert suppression" .
--- 1102,1112 ----
  
  .TP
! .BI dep_behavior " {a|m|hm}"
! The evaluation of the dependency graphs specified via the
! .B depend
! keyword
  can control the
! suppression of alert or monitor invocations, or the suppression
! of individual hosts passed to the monitor.
  
  .BR "Alert suppression" .
***************
*** 1079,1082 ****
--- 1130,1177 ----
  the same.
  
+ .BR "Host suppression" .
+ If it is set to "hm" then Mon will extract the list of "parent"
+ services from the dependency expression.  (In fact the expression can
+ be just a list of services.) Then when the monitor for the service is
+ about to be run, for each host in the current hostgroup Mon will
+ search all the parent services which are currently failing and look
+ for the hostname in the current summary output.  If the hostname is
+ found, this host will be excluded from this run of the monitor.  This
+ can be used to e.g. allow an SMTP test on a group of hosts to still be run
+ even when a single host is not ping-reachable.  If all the rest of the
+ hosts are working fine, the service will be in an OK state, but if
+ another host fails the SMTP test Mon can still alert about that host
+ even though the parent dependency was failing.  The dependency
+ expression will
+ .B not
+ be used recursively in this case.
+ 
+ .TP
+ .BI alertdepend " dependexpression"
+ .TP
+ .BI monitordepend " dependexpression"
+ .TP
+ .BI hostdepend " dependexpression"
+ These keywords allow you to specify multiple dependency expressions of 
+ different types.  Each one corresponds to the different 
+ .B dep_behavior
+ settings listed above.  They will be evaluated independently in the different
+ contexts as listed above.  If
+ .B depend
+ is present, it takes precedence over the matching keyword, depending on the
+ .B dep_behavior
+ setting.
+ 
+ .TP
+ .BI "dep_memory = " timeval
+ If set, dep_memory will cause dependencies to continue to prevent
+ alerts/monitoring for a period of time after the service returns to a
+ normal state.  This can be used to prevent over-eager alerting when a
+ machine is rebooting, for example.  See the explanation of
+ .I interval
+ in the "Service Definitions" section
+ for a description of
+ .IR timeval .
+ 
  .SS "Period Definitions"