From f87ee2d28b0683592ca3c9570cb6060a5617f362 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Fri, 23 Feb 2024 21:56:06 +0100 Subject: [PATCH] docs: refine throttled log time_window description --- rel/i18n/emqx_conf_schema.hocon | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/rel/i18n/emqx_conf_schema.hocon b/rel/i18n/emqx_conf_schema.hocon index 4477b6a54..1ce7fd13e 100644 --- a/rel/i18n/emqx_conf_schema.hocon +++ b/rel/i18n/emqx_conf_schema.hocon @@ -483,8 +483,13 @@ desc_log_throttling.desc: 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.""" -log_throttling_time_window.desc: -"""For throttled messages, only log 1 in each time window.""" +log_throttling_time_window.desc: """~ + 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"""