TASK-144646: Documentation for new curfew module (SparkPost/Momentum#…#845
Open
dkoerichbird wants to merge 2 commits into
Open
TASK-144646: Documentation for new curfew module (SparkPost/Momentum#…#845dkoerichbird wants to merge 2 commits into
dkoerichbird wants to merge 2 commits into
Conversation
…1228) Signed-off-by: Doug Koerich <douglas.koerich@bird.com>
✅ Deploy Preview for support-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Doug Koerich <douglas.koerich@bird.com>
deepakpn
requested changes
May 21, 2026
|
|
||
| <dd> | ||
|
|
||
| The timezone in which the cron fields of every rule are interpreted. Accepted values are `local` and `UTC` (case-insensitive). Default value is `local`, which matches standard crontab semantics. Any unrecognized value is treated as `local`, with a warning written to the paniclog. |
Contributor
There was a problem hiding this comment.
can we clarify the expected timezone format with a few examples (e.g., are these abbreviations such as CDT, or timezone offsets, etc.)
|
|
||
| The `curfew` module schedules *quiet hours* (blackout windows) during which Momentum will not attempt deliveries for selected bindings, binding groups, or domains. The schedule is expressed in crontab-style syntax and is read from a plain-text file. | ||
|
|
||
| Curfew replaces *ad-hoc* operator workflows that toggle [`suspend_delivery`](/momentum/4/config/ref-suspend-delivery), e.g., from external cron jobs. Driving suspension state from outside the MTA is fragile: a missed cron firing can leave messages stuck on the spool, and a race between the cron job and a configuration commit can leave the binding suspended forever. Curfew evaluates its rules from inside the suspension decision path on every delivery attempt, so quiet hours engage and lift on schedule without operator intervention and without persistent state changes to the binding/domain scope. |
Contributor
There was a problem hiding this comment.
Can we clarify the semantics w.r.t. message expiration when the curfew is lifted? i.e., if a message has expired by the time curfew is lifted, would it be attempted once for delivery or would it be expired immediately?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…1228)
Note
Low Risk
Documentation-only change that adds a new module page and cross-references it from command/config/module indexes; no runtime behavior or configuration parsing code is modified.
Overview
Adds documentation for the new
curfewmodule, including configuration (Schedule_File,Timezone,Fuzz_Seconds), schedule file format, precedence with other suspension mechanisms, logging behavior, and provided console commands.Updates the console-commands summary, config-options summary, modules index/summary tables, and the
5.3.0changelog to referencecurfewand its new console commands/options.Reviewed by Cursor Bugbot for commit 68a41cf. Bugbot is set up for automated code reviews on this repo. Configure here.