-
Notifications
You must be signed in to change notification settings - Fork 36
TASK-160237: Momentum 5.2 release documentation #814
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dkoerichbird
wants to merge
14
commits into
main
Choose a base branch
from
TASK-160237
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
bd81620
TASK-113041: New configuration options for debug throttling (#813)
dkoerichbird 16d112a
TASK-144791: Updated documentation for `DELETE /stats/summary` (#812)
dkoerichbird a716bfb
TASK-122054: Note about removal of msys-clamav (#811)
dkoerichbird 38b0497
TASK-160237 (TASK-113041) Clarifying throttling behavior (per review …
dkoerichbird 5725a63
TASK-86684: Adding dns_max_udp_queries_per_port to documentation (#815)
dkoerichbird 1fffc9c
TASK-115992: New attempted_ip info in ec_message (for logging) (#817)
dkoerichbird 3b3d1e7
TASK-91082: Adding doc for new dns_udp_xxxbuf_size options (#816)
dkoerichbird c7723f0
TASK-160237: Removing task number from doc
dkoerichbird 0587a17
TASK-160237: Minor change in Dockerfile to reflect installation manual
dkoerichbird 150defe
TASK-160237: Added changelog for Momentum 5.2
dkoerichbird 6d2919a
TASK-160237: Minor change to fix version number
dkoerichbird 6d16fcf
TASK-160237: Late addition to changelog
dkoerichbird 62bbc82
TASK-160237: Change from review
dkoerichbird c7c80aa
TASK-160237: Another minor change from reviewers
dkoerichbird File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| --- | ||
| lastUpdated: "12/31/2025" | ||
| title: "Throttling Debug Messages" | ||
| description: "Configure throttling to tell Momentum how to suppress repeated debug messages. When using the default logging module the messages will appear in the paniclog. The throttle is a decimal number representing the maximum number of repeated debug messages to log within a specified time interval" | ||
| --- | ||
|
|
||
| When using the default logging module, debug messages will appear in the [paniclog](/momentum/4/log-formats-paniclog) | ||
| depending on subsystem and level settings configured in [Debug_Flags](/momentum/4/config/ref-debug-flags). `Debug_Flags` is | ||
| usually empty, so very few events are written to the `paniclog`. However, under certain circumstances, you need to get more | ||
| information about some subsystem's behavior (e.g., SMTP), then by setting `Debug_Flags`, you can enable more verbose logging | ||
| into `paniclog`. On the other hand, depending on the chosen level, `paniclog` may get populated with several lines of the same | ||
| message, including some that might not be of your interest. | ||
|
|
||
| Momentum’s debug throttling configuration allows you to suppress repeated debug messages. The throttle suppresses the logging | ||
| of repeated messages beyond a specified limit during a time interval also specified. It is a global setting that applies to | ||
| messages of all subsystems. | ||
|
|
||
| > **NOTE:** Debug throttling global configuration **DOES NOT** apply to messages logged at the `CRITICAL`, `ERROR`, or | ||
| > `WARNING` levels of any subsystem, due to their relevance for operation and diagnosis. | ||
|
|
||
| It is important to note that debug throttling is applied not necessarily to *identical* messages, but to messages that are | ||
| considered the same after removing variable parts such as timestamps, IP addresses, or other dynamic content. In other words, | ||
| if the source of the message is something like this: | ||
|
|
||
| ``` | ||
| <timestamp> Message received from: <mailfrom> | ||
| ``` | ||
|
|
||
| then all messages that match this pattern will be considered the same for throttling purposes, regardless of the actual | ||
| values of `<timestamp>` and `<mailfrom>`. This happens because the default logging module is based on `printf`-style | ||
| format strings, which allows variable content in log messages, and it is the format string that determines message sameness. | ||
|
|
||
| > __**_WARNING:_**__ Be cautious when enabling debug throttling, as it may cause some performance overhead due to the additional | ||
| > processing required to track and suppress repeated messages. | ||
|
|
||
| <a name="conf.ref.debug_throttle"></a> | ||
| # Configuration options | ||
|
|
||
| Debug throttling is configured using the following options in the global scope of your `ecelerity.conf` file: | ||
| - **debug_throttle_max_num_same_message** | ||
| - **debug_throttle_period_secs** | ||
|
|
||
| <a name="conf.ref.debug_throttle_max_num_same_message"></a> | ||
| ## Maximum number of the same message | ||
|
|
||
| <a name="conf.ref.debug_throttle_max_num_same_message.name"></a> | ||
| ### Name | ||
|
|
||
| `debug_throttle_max_num_same_message` | ||
|
|
||
| <a name="conf.ref.debug_throttle_max_num_same_message.description"></a> | ||
| ### Description | ||
|
|
||
| Sets the maximum number of repeated debug messages to log within a specified time interval. The default is `0`, which means no | ||
| throttling is applied to the logging of repeated debug messages. | ||
|
|
||
| <a name="conf.ref.debug_throttle_period_secs.example"></a> | ||
| ### Example | ||
|
|
||
| ``` | ||
| debug_throttle_max_num_same_message = 5 | ||
| ``` | ||
|
|
||
| With this configuration, if the same debug message occurs 20 times within the time interval specified by `debug_throttle_period_secs`, | ||
| only the first 5 instances will be logged. The remaining 15 messages are suppressed. | ||
|
|
||
| <a name="conf.ref.debug_throttle_period_secs"></a> | ||
| ## Time interval of throttling | ||
|
|
||
| <a name="conf.ref.debug_throttle_period_secs.name"></a> | ||
| ### Name | ||
| `debug_throttle_period_secs` | ||
|
|
||
| <a name="conf.ref.debug_throttle_period_secs.description"></a> | ||
| ### Description | ||
|
|
||
| Sets the time interval in seconds during which repeated debug messages are counted for throttling purposes. | ||
| The counters are reset when starting a new interval. The default is `1` second, with a maximum of `60` seconds. | ||
|
|
||
| <a name="conf.ref.debug_throttle_period_secs.example"></a> | ||
| ### Example | ||
| ``` | ||
| debug_throttle_period_secs = 30 | ||
| ``` | ||
| With this configuration, the time interval for counting repeated debug messages is set to 30 seconds. Combined with the | ||
| previous example for `debug_throttle_max_num_same_message`, up to 5 lines of the same debug message will be logged every | ||
| 30 seconds. After that, the counter resets and other 5 instances can be logged during the next 30-second window. | ||
|
|
||
| <a name="conf.ref.debug_throttle.scope"></a> | ||
| # Scope | ||
|
|
||
| Debug throttling options are valid in the global scope. | ||
26 changes: 26 additions & 0 deletions
26
content/momentum/4/config/ref-dns-max-udp-queries-per-port.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| lastUpdated: "01/31/2026" | ||
| title: "dns_max_udp_queries_per_port" | ||
| description: "dns max udp queries per port limit the number of DNS queries sent using the same UDP source port Momentum uses User Datagram Protocol UDP for DNS queries However the size of a UDP packet is limited and a DNS query can exceed it Set this option to..." | ||
| --- | ||
|
|
||
| <a name="conf.ref.dns_max_udp_queries_per_port"></a> | ||
| ## Name | ||
|
|
||
| dns_max_udp_queries_per_port — limit the number of DNS queries sent using the same UDP source port | ||
|
|
||
| ## Synopsis | ||
|
|
||
| `dns_max_udp_queries_per_port = 10` | ||
|
|
||
| <a name="idp69432014"></a> | ||
| ## Description | ||
|
|
||
| Momentum uses User Datagram Protocol (UDP) for DNS queries. Each internal channel to the DNS server(s) is assigned a dynamic (ephemeral) UDP source port number. All DNS queries sent over that channel use the same source port. When many queries originate from a single source port, security devices such as firewalls may interpret this pattern as malicious behavior (e.g., a DNS-based attack) and drop or block the queries. This setting limits how many DNS queries will be sent from each source port before Momentum allocates a new port number, helping to avoid triggering such security measures. | ||
|
|
||
| The default value is `0` (no limit). Most users do not need to change this value unless experiencing DNS-related firewall blocks. | ||
|
|
||
| <a name="idp69432015"></a> | ||
| ## Scope | ||
|
|
||
| `dns_max_udp_queries_per_port` is valid in the global scope. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| lastUpdated: "01/31/2026" | ||
| title: "dns_udp_rcvbuf_size, dns_udp_sndbuf_size" | ||
| description: "dns_udp_***buf_size set the size of the UDP socket buffers used by DNS lookups" | ||
| --- | ||
|
|
||
| <a name="conf.ref.dns_udp_buffer_size"></a> | ||
| ## Name | ||
|
|
||
| dns_udp_rcvbuf_size — set the size of the UDP socket receiving buffer used by DNS lookups | ||
|
|
||
| dns_udp_sndbuf_size - set the size of the UDP socket sending buffer | ||
|
|
||
| ## Synopsis | ||
|
|
||
| `dns_udp_rcvbuf_size = 65536` | ||
|
|
||
| `dns_udp_sndbuf_size = 16384` | ||
|
|
||
| <a name="idp69437158"></a> | ||
| ## Description | ||
|
|
||
| By default, Momentum uses the operating system's default buffer sizes for the UDP sockets used for DNS lookups. In high-volume environments with tens of thousands of domains, these default buffer sizes may be insufficient. When the receive buffer fills up, incoming DNS responses can be dropped, causing unnecessary DNS failures and retries that further increase query volume. These configuration options allow you to increase the DNS socket buffer sizes at startup. | ||
|
|
||
| The default value for both options is `0` (use OS defaults). | ||
|
|
||
| <a name="idp69437159"></a> | ||
| ## Scope | ||
|
|
||
| Both `dns_udp_rcvbuf_size` and `dns_udp_sndbuf_size` are valid in the global scope. |
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this really non-trivial? I wouldn't expect there'd be that many unique format strings, and we save the cost of logging the msgs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Debug throttling is a feature that I believe is most useful when turning on debugging messages (level >=
INFO), and, depending on the subsystem the customer enables, many different strings (in different formats) can be printed.