TASK-113041: New configuration options for debug throttling #810
Conversation
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>
Signed-off-by: Doug Koerich <douglas.koerich@bird.com>
Signed-off-by: Doug Koerich <douglas.koerich@bird.com>
| <timestamp> Message received from: <mailfrom> | ||
| ``` | ||
|
|
||
| then all messages that match this pattern will be considered the same for throttling purposes, regardless of the actual |
There was a problem hiding this comment.
Curious how we do this matching, and what parts are considered to be dedupe-able? We might want to consider documenting the exact semantic as the behavior observed in logs will be customer visible.
There was a problem hiding this comment.
Please look at the updated paragraph.
Signed-off-by: Doug Koerich <douglas.koerich@bird.com>
|
|
||
| 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 | ||
| formatting, which allows variable content in log messages, and it is the formatting that determines message sameness. |
There was a problem hiding this comment.
(nit) I'd say format string rather than formatting
There was a problem hiding this comment.
Steeping back, though, do we have examples of some msgs that inspired this feature? There may be cases where a user really wants to see all unique msgs rather than skipping msgs with just the same format string. If the msgs that are typically the problem are all truly the same, that may be preferable. When debugging, the unique values are usually important.
There was a problem hiding this comment.
Yes, the customer provided this example of a log message that had thousands of instances, each for a different message ID:
1751049883:OSA-00747 read [235] from server for 41/A5-36243-996EE586
that is a DEBUG-level message generated by this line:
ec_mod_debug(self, DDEBUG, "OSA-%05d read [%d] from server for %s\n", __LINE__, retval, ctx->msg_id);In a debugging session the throttling could be temporarily disabled by setting debug_throttle_max_num_same_message to 0. Also, please remember that log messages that were classified as CRITICAL, ERROR, and WARNING due to their relevance in unexpected behaviors aren't subject to throttling at all.
Signed-off-by: Doug Koerich <douglas.koerich@bird.com>
Note
Documents debug message throttling (new page and two config options) and redacts a key in an HTTP request example.
content/momentum/4/config/ref-debug-throttle.mddetailing debug throttling and optionsdebug_throttle_max_num_same_messageanddebug_throttle_period_secs.debug_throttle_max_num_same_messageanddebug_throttle_period_secstocontent/momentum/4/config-options-summary.mdwith defaults and scope.auth_keyincontent/momentum/3/3-push/push-http-request-eval.md.Written by Cursor Bugbot for commit 7bc2d21. This will update automatically on new commits. Configure here.