From: Ethan G. <ega...@us...> - 2007-05-30 18:21:29
|
Update of /cvsroot/nagios/nagios/html/docs In directory sc8-pr-cvs16.sourceforge.net:/tmp/cvs-serv18723/html/docs Modified Files: objectdefinitions.html timeperiods.html whatsnew.html Log Message: Timeperiod overhaul! Index: timeperiods.html =================================================================== RCS file: /cvsroot/nagios/nagios/html/docs/timeperiods.html,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** timeperiods.html 2 Mar 2007 23:55:42 -0000 1.3 --- timeperiods.html 30 May 2007 18:21:23 -0000 1.4 *************** *** 52,55 **** --- 52,76 ---- <p> + <strong><u>Precedence in Time Periods</u></strong> + </p> + + <p> + Timeperod <a href="objectdefinitions.html#timeperiod">definitions</a> may contain multiple types of directives, including weekdays, days of the month, and calendar dates. Different types of directives have different precendence levels and may override other directives in your timeperiod definitions. The order of precedence for different types of directives (in descending order) is as follows: + </p> + + <ul> + <li>Calendar date (2008-01-01)</li> + <li>Specific month date (January 1st)</li> + <li>Generic month date (Day 15)</li> + <li>Offset weekday of specific month (2nd Tuesday in December)</li> + <li>Offset weekday (3rd Monday)</li> + <li>Normal weekday (Tuesday)</li> + </ul> + + <p> + Examples of different timeperiod directives can be found <a href="objectdefinitions.html#timeperiod">here</a>. + </p> + + <p> <strong><u>How Time Periods Work With Host and Service Checks</u></strong> </p> Index: objectdefinitions.html =================================================================== RCS file: /cvsroot/nagios/nagios/html/docs/objectdefinitions.html,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** objectdefinitions.html 8 May 2007 18:56:30 -0000 1.5 --- objectdefinitions.html 30 May 2007 18:21:23 -0000 1.6 *************** *** 1241,1245 **** <p><div class="SectionTitle">Description:</div></p> <p> ! A time period is a list of times during various days that are considered to be "valid" times for notifications and service checks. It consists one or more time periods for each day of the week that "rotate" once the week has come to an end. Exceptions to the normal weekly time range rotations are not suported. </p> --- 1241,1245 ---- <p><div class="SectionTitle">Description:</div></p> <p> ! A time period is a list of times during various days that are considered to be "valid" times for notifications and service checks. It consists of time ranges for each day of the week that "rotate" once the week has come to an end. Different types of exceptions to the normal weekly time are supported, including: specific weekdays, days of generic months, days of specific months, and calendar dates. </p> *************** *** 1255,1265 **** <tr><td></td><td class="Required">timeperiod_name</td><td class="Required"><i>timeperiod_name</i></td></tr> <tr><td></td><td class="Required">alias</td><td class="Required"><i>alias</i></td></tr> ! <tr><td></td><td class="Optional">sunday</td><td class="Optional"><i>timeranges</i></td></tr> ! <tr><td></td><td class="Optional">monday</td><td class="Optional"><i>timeranges</i></td></tr> ! <tr><td></td><td class="Optional">tuesday</td><td class="Optional"><i>timeranges</i></td></tr> ! <tr><td></td><td class="Optional">wednesday</td><td class="Optional"><i>timeranges</i></td></tr> ! <tr><td></td><td class="Optional">thursday</td><td class="Optional"><i>timeranges</i></td></tr> ! <tr><td></td><td class="Optional">friday</td><td class="Optional"><i>timeranges</i></td></tr> ! <tr><td></td><td class="Optional">saturday</td><td class="Optional"><i>timeranges</i></td></tr> <tr><td> </td><td colspan=2 class="Definition">}</td></tr> --- 1255,1260 ---- <tr><td></td><td class="Required">timeperiod_name</td><td class="Required"><i>timeperiod_name</i></td></tr> <tr><td></td><td class="Required">alias</td><td class="Required"><i>alias</i></td></tr> ! <tr><td></td><td class="Optional">[weekday]</td><td class="Optional"><i>timeranges</i></td></tr> ! <tr><td></td><td class="Optional">[exception]</td><td class="Optional"><i>timeranges</i></td></tr> <tr><td> </td><td colspan=2 class="Definition">}</td></tr> *************** *** 1267,1271 **** </p> ! <p><div class="SectionTitle">Example Definition:</div></p> <p class="SectionBody"> <pre> --- 1262,1266 ---- </p> ! <p><div class="SectionTitle">Example Definitions:</div></p> <p class="SectionBody"> <pre> *************** *** 1273,1283 **** timeperiod_name nonworkhours alias Non-Work Hours ! sunday 00:00-24:00 ! monday 00:00-09:00,17:00-24:00 ! tuesday 00:00-09:00,17:00-24:00 ! wednesday 00:00-09:00,17:00-24:00 ! thursday 00:00-09:00,17:00-24:00 ! friday 00:00-09:00,17:00-24:00 ! saturday 00:00-24:00 } </pre> --- 1268,1313 ---- timeperiod_name nonworkhours alias Non-Work Hours ! sunday 00:00-24:00 ; Every Sunday of every week ! monday 00:00-09:00,17:00-24:00 ; Every Monday of every week ! tuesday 00:00-09:00,17:00-24:00 ; Every Tuesday of every week ! wednesday 00:00-09:00,17:00-24:00 ; Every Wednesday of every week ! thursday 00:00-09:00,17:00-24:00 ; Every Thursday of every week ! friday 00:00-09:00,17:00-24:00 ; Every Friday of every week ! saturday 00:00-24:00 ; Every Saturday of every week ! } ! ! define timeperiod{ ! timeperiod_name misc-single-days ! alias Misc Single Days ! 1999-01-28 00:00-24:00 ; January 28th, 1999 ! monday 3 00:00-24:00 ; 3rd Monday of every month ! day 2 00:00-24:00 ; 2nd day of every month ! february 10 00:00-24:00 ; February 10th of every year ! february -1 00:00-24:00 ; Last day in February of every year ! friday -2 00:00-24:00 ; 2nd to last Friday of every month ! thursday -1 november 00:00-24:00 ; Last Thursday in November of every year ! } ! ! define timeperod{ ! timeperiod_name misc-date-ranges ! alias Misc Date Ranges ! 2007-01-01 - 2008-02-01 00:00-24:00 ; January 1st, 2007 to February 1st, 2008 ! monday 3 - thursday 4 00:00-24:00 ; 3rd Monday to 4th Thursday of every month ! day 1 - 15 00:00-24:00 ; 1st to 15th day of every month ! day 20 - -1 00:00-24:00 ; 20th to the last day of every month ! july 10 - 15 00:00-24:00 ; July 10th to July 15th of every year ! april 10 - may 15 00:00-24:00 ; April 10th to May 15th of every year ! tuesday 1 april - friday 2 may 00:00-24:00 ; 1st Tuesday in April to 2nd Friday in May of every year ! } ! ! define timeperod{ ! timeperiod_name misc-skip-ranges ! alias Misc Skip Ranges ! 2007-01-01 - 2008-02-01 / 3 00:00-24:00 ; Every 3 days from January 1st, 2007 to February 1st, 2008 ! 2008-04-01 / 7 00:00-24:00 ; Every 7 days from April 1st, 2008 (continuing forever) ! monday 3 - thursday 4 / 2 00:00-24:00 ; Every other day from 3rd Monday to 4th Thursday of every month ! day 1 - 15 / 5 00:00-24:00 ; Every 5 days from the 1st to the 15th day of every month ! july 10 - 15 / 2 00:00-24:00 ; Every other day from July 10th to July 15th of every year ! tuesday 1 april - friday 2 may / 6 00:00-24:00 ; Every 6 days from the 1st Tuesday in April to the 2nd Friday in May of every year } </pre> *************** *** 1300,1306 **** </tr> <tr> ! <td valign="top"><strong><i>some</i>day</strong>:</td> <td> ! The <i>sunday</i> through <i>saturday</i> directives are comma-delimited lists of time ranges that are "valid" times for a particular day of the week. Notice that there are seven different days for which you can define time ranges (Sunday through Saturday). Each time range is in the form of <b>HH:MM-HH:MM</b>, where hours are specified on a 24 hour clock. For example, <b>00:15-24:00</b> means 12:15am in the morning for this day until 12:20am midnight (a 23 hour, 45 minute total time range). If you wish to exclude an entire day from the timeperiod, simply do not include it in the timeperiod definition. </td> </tr> --- 1330,1347 ---- </tr> <tr> ! <td valign="top"><strong>[<i>weekday</i>]</strong>:</td> <td> ! The weekday directives ("<i>sunday</i>" through "<i>saturday</i>")are comma-delimited lists of time ranges that are "valid" times for a particular day of the week. Notice that there are seven different days for which you can define time ranges (Sunday through Saturday). Each time range is in the form of <b>HH:MM-HH:MM</b>, where hours are specified on a 24 hour clock. For example, <b>00:15-24:00</b> means 12:15am in the morning for this day until 12:20am midnight (a 23 hour, 45 minute total time range). If you wish to exclude an entire day from the timeperiod, simply do not include it in the timeperiod definition. ! </td> ! </tr> ! <tr> ! <td valign="top"><strong>[<i>exception</i>]</strong>:</td> ! <td> ! <p> ! You can specify several different types of exceptions to the standard rotating weekday schedule. Exceptions can take a number of different forms including single days of a specific or generic month, single weekdays in a month, or single calendar dates. You can also specify a range of days/dates and even specify skip intervals to obtain functionality described by "every 3 days between these dates". Rather than list all the possible formats for exception strings, I'll let you look at the example timeperiod definitions above to see what's possible. :-) ! </p> ! <p> ! Weekdays and different types of exceptions all have different levels of precedence, so its important to understand how they can affect each other. More information on this can be found in the documentation on <a href="timeperiods.html">timeperiods</a>. ! </p> </td> </tr> Index: whatsnew.html =================================================================== RCS file: /cvsroot/nagios/nagios/html/docs/whatsnew.html,v retrieving revision 1.25 retrieving revision 1.26 diff -C2 -d -r1.25 -r1.26 *** whatsnew.html 22 May 2007 23:12:29 -0000 1.25 --- whatsnew.html 30 May 2007 18:21:23 -0000 1.26 *************** *** 223,226 **** --- 223,234 ---- <br> + <li><b>Timeperiods</b>:<br> + <ul> + <li>Timeperiods were overdue for a major overhaul and have finally been extended to allow for date exceptions, skip dates (every 3 days), etc! This should help you out when defining notification timeperiods for pager rotations.</li> + <li>More information on the new timeperiod directives can be found <a href="objectdefinitions.html#timeperiod">here</a> and <a href="timeperiods.html">here</a>.</li> + </ul> + </li> + <br> + <li><b>Event Broker</b>:<br> <ul> |