chore: fix comment in schema and config file
This commit is contained in:
parent
89b6cce0bd
commit
0748ca1238
|
@ -39,8 +39,8 @@
|
||||||
- Added configurations to enable more `client.disconnected` events (and counter bumps) [#9267](https://github.com/emqx/emqx/pull/9267).
|
- Added configurations to enable more `client.disconnected` events (and counter bumps) [#9267](https://github.com/emqx/emqx/pull/9267).
|
||||||
Prior to this change, the `client.disconnected` event (and counter bump) is triggered when a client
|
Prior to this change, the `client.disconnected` event (and counter bump) is triggered when a client
|
||||||
performs a 'normal' disconnect, or is 'kicked' by system admin, but NOT triggered when a
|
performs a 'normal' disconnect, or is 'kicked' by system admin, but NOT triggered when a
|
||||||
stale connection had to be 'discarded' (for clean session) or 'takenover' (for non-clean session).
|
stale connection had to be 'discarded' (for clean session) or 'takeovered' (for non-clean session) by new connection.
|
||||||
Now it is possible to set configs `broker.client_disconnect_discarded` and `broker.client_disconnect_takenover` to `on` to enable the event in these scenarios.
|
Now it is possible to set configs `broker.client_disconnect_discarded` and `broker.client_disconnect_takeovered` to `on` to enable the event in these scenarios.
|
||||||
|
|
||||||
- For Rule-Engine resource creation failure, delay before the first retry [#9313](https://github.com/emqx/emqx/pull/9313).
|
- For Rule-Engine resource creation failure, delay before the first retry [#9313](https://github.com/emqx/emqx/pull/9313).
|
||||||
Prior to this change, the retry delay was added *after* the retry failure.
|
Prior to this change, the retry delay was added *after* the retry failure.
|
||||||
|
|
|
@ -34,7 +34,7 @@
|
||||||
|
|
||||||
- 为更多类型的 `client.disconnected` 事件(计数器触发)提供可配置项 [#9267](https://github.com/emqx/emqx/pull/9267)。
|
- 为更多类型的 `client.disconnected` 事件(计数器触发)提供可配置项 [#9267](https://github.com/emqx/emqx/pull/9267)。
|
||||||
此前,`client.disconnected` 事件及计数器仅会在客户端正常断开连接或客户端被系统管理员踢出时触发,
|
此前,`client.disconnected` 事件及计数器仅会在客户端正常断开连接或客户端被系统管理员踢出时触发,
|
||||||
但不会在旧 session 被废弃 (clean_session = true) 或旧 session 被接管 (clean_session = false) 时被触发。
|
但不会在旧 session 被新连接废弃时 (clean_session = true) ,或旧 session 被新连接接管时 (clean_session = false) 被触发。
|
||||||
可将 `broker.client_disconnect_discarded` 和 `broker.client_disconnect_takovered` 选项设置为 `on` 来启用此场景下的客户端断连事件。
|
可将 `broker.client_disconnect_discarded` 和 `broker.client_disconnect_takovered` 选项设置为 `on` 来启用此场景下的客户端断连事件。
|
||||||
|
|
||||||
- 规则引擎资源创建失败后,第一次重试前增加一个延迟 [#9313](https://github.com/emqx/emqx/pull/9313)。
|
- 规则引擎资源创建失败后,第一次重试前增加一个延迟 [#9313](https://github.com/emqx/emqx/pull/9313)。
|
||||||
|
|
|
@ -2457,9 +2457,9 @@ broker.route_batch_clean = off
|
||||||
|
|
||||||
## Enable client disconnect event will be triggered by which reasons.
|
## Enable client disconnect event will be triggered by which reasons.
|
||||||
## Value: on | off
|
## Value: on | off
|
||||||
## `takeover`: session was takenover by another client with same client ID. (clean_session = false)
|
## `discarded`: session was discarded by another client with same client ID when new connection use `clean_session = true`.
|
||||||
## Default: off
|
## Default: off
|
||||||
## `discard`: session was takeover by another client with same client ID. (clean_session = true)
|
## `takeover`: session was takeovered by another client with same client ID when new connection use `clean_session = false`.
|
||||||
## Default: off
|
## Default: off
|
||||||
##
|
##
|
||||||
# broker.client_disconnect_discarded = off
|
# broker.client_disconnect_discarded = off
|
||||||
|
|
|
@ -2508,13 +2508,13 @@ end}.
|
||||||
]}.
|
]}.
|
||||||
|
|
||||||
%% @doc Configuration of disconnected event reason.
|
%% @doc Configuration of disconnected event reason.
|
||||||
%% `takeover`: session was takenover by another client with same client ID. (clean_session = false)
|
%% `discarded`: session was discarded by another client with same client ID when new connection use `clean_session = true`.
|
||||||
%% `discard`: session was takeover by another client with same client ID. (clean_session = true)
|
|
||||||
{mapping, "broker.client_disconnect_discarded", "emqx.client_disconnect_discarded", [
|
{mapping, "broker.client_disconnect_discarded", "emqx.client_disconnect_discarded", [
|
||||||
{default, off},
|
{default, off},
|
||||||
{datatype, flag}
|
{datatype, flag}
|
||||||
]}.
|
]}.
|
||||||
|
|
||||||
|
%% `takeovered`: session was takeovered by another client with same client ID when new connection use `clean_session = false`.
|
||||||
{mapping, "broker.client_disconnect_takeovered", "emqx.client_disconnect_takeovered", [
|
{mapping, "broker.client_disconnect_takeovered", "emqx.client_disconnect_takeovered", [
|
||||||
{default, off},
|
{default, off},
|
||||||
{datatype, flag}
|
{datatype, flag}
|
||||||
|
|
Loading…
Reference in New Issue