Skip to content

Commit 8851cdf

Browse files
committed
Additional documentation to explain discontinuity event behaviour
1 parent fb69cc3 commit 8851cdf

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/reference/watcher/trigger/schedule.asciidoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,31 @@ in the schedule.
1313
are triggered when expected, you should synchronize the clocks of all nodes in the
1414
cluster using a time service such as http://www.ntp.org/[NTP].
1515

16+
When specifying a timezone for a watch, keep in mind the effect daylight savings time
17+
transitions may have on the schedule, especially if the watch is scheduled to run
18+
during the transition. Here's how {watcher} handles watches scheduled during discontinuities:
19+
20+
==== Gap Transitions
21+
These occur when the clock moves forward, such as when daylight savings time starts
22+
and cause certain hours or minutes to be skipped. If your watch is scheduled to run
23+
during a gap transition, the watch is executed at the same time as before the transition.
24+
25+
Example: If a watch is scheduled to run daily at 1:30AM in the `Europe/London` time zone and
26+
the clock moves forward one hour from 1:00AM (GMT+0) to 2:00AM (GMT+1), the watch is executed
27+
at 2:30AM (GMT+1) which would have been 1:30AM before the transition. Subsequent executions
28+
happen at 1:30AM (GMT+1).
29+
30+
==== Overlap Transitions
31+
These occur when the clock moves backward, such as when daylight savings time ends
32+
and cause certain hours or minutes to be repeated. If your watch is scheduled to run
33+
during an overlap transition, only the first occurrence of the time causes to the watch
34+
to execute with the second being skipped.
35+
36+
Example: If a watch is scheduled to run at 1:30 AM and the clock moves backward one hour
37+
from 2:00AM to 1:00AM, the watch is executed at 1:30AM and the second occurrence after the
38+
change is skipped.
39+
40+
=== Throttling
1641
Keep in mind that the throttle period can affect when a watch is actually executed.
1742
The default throttle period is five seconds (5000 ms). If you configure a schedule
1843
that's more frequent than the throttle period, the throttle period overrides the
@@ -21,6 +46,7 @@ and set the schedule to every 10 seconds, the watch is executed no more than
2146
once per minute. For more information about throttling, see
2247
<<actions-ack-throttle>>.
2348

49+
=== Schedule Types
2450
{watcher} provides several types of schedule triggers:
2551

2652
* <<schedule-hourly, `hourly`>>

0 commit comments

Comments
 (0)