Merge pull request #12579 from zmstone/0223-refine-log-throttle-desc

docs: refine throttled log time_window description
This commit is contained in:
Zaiming (Stone) Shi 2024-02-27 09:58:57 +01:00 committed by GitHub
commit cc919a3593
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 2 deletions

View File

@ -483,8 +483,13 @@ desc_log_throttling.desc:
dropping all but the first event within a configured time window. dropping all but the first event within a configured time window.
The throttling is automatically disabled if `console` or `file` log level is set to debug.""" The throttling is automatically disabled if `console` or `file` log level is set to debug."""
log_throttling_time_window.desc: log_throttling_time_window.desc: """~
"""For throttled messages, only log 1 in each time window.""" This configuration setting controls the logging behavior for throttled messages,
including, but not limited to messages like 'authorization_permission_denied'.
Within each defined time window, only one instance of a throttled message will be logged to prevent log flooding.
At the conclusion of each time window, a summary log will be generated, detailing the occurrence of any throttled messages during that period.
It's important to note that the shortest effective time window for this setting is 1 second (`1s`).
Should a value lower than `1s` be specified, it will automatically be adjusted to `1s`.~"""
log_throttling_time_window.label: log_throttling_time_window.label:
"""Log Throttling Time Window""" """Log Throttling Time Window"""