yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(schema): Add description for clientinfo_override

This commit is contained in:
ieQu1 2022-03-29 15:40:22 +02:00
parent abb4d42406
commit c0e5139e9f
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
apps/emqx/etc/emqx.conf
View File

@ -894,7 +894,7 @@ conn_congestion {
## Whether to alarm the congested connections. ## Whether to alarm the congested connections.
## ##
## Sometimes the mqtt connection (usually an MQTT subscriber) may ## Sometimes the mqtt connection (usually an MQTT subscriber) may
## get "congested", because there're too many packets to be sent. ## get "congested", because there's too many packets to sent.
## The socket tries to buffer the packets until the buffer is ## The socket tries to buffer the packets until the buffer is
## full. If more packets come after that, the packets will be ## full. If more packets come after that, the packets will be
## "pending" in a queue and we consider the connection is ## "pending" in a queue and we consider the connection is
@ -914,7 +914,7 @@ conn_congestion {
enable_alarm = true enable_alarm = true
## Won't clear the congested alarm in how long time. ## Won't clear the congested alarm in how long time.
## The alarm is cleared only when there're no pending bytes in ## The alarm is cleared only when there's no pending bytes in
## the queue, and also it has been `min_alarm_sustain_duration` ## the queue, and also it has been `min_alarm_sustain_duration`
## time since the last time we considered the connection is "congested". ## time since the last time we considered the connection is "congested".
## ##

4
apps/emqx/src/emqx_schema.erl
View File

@ -304,7 +304,7 @@ fields("stats") ->
boolean(), boolean(),
#{ #{
default => true, default => true,
desc => "Enable/disable statistic data collection" desc => "Enable/disable statistic data collection."
} }
)} )}
]; ];
@ -774,7 +774,7 @@ fields("conn_congestion") ->
default => "1m", default => "1m",
desc => desc =>
"Minimal time before clearing the alarm.\n\n" "Minimal time before clearing the alarm.\n\n"
"The alarm is cleared only when there're no pending data in\n" "The alarm is cleared only when there's no pending data in\n"
"the queue, and at least `min_alarm_sustain_duration`\n" "the queue, and at least `min_alarm_sustain_duration`\n"
"milliseconds passed since the last time we considered the connection \"congested\".\n\n" "milliseconds passed since the last time we considered the connection \"congested\".\n\n"
"This is to avoid clearing and raising the alarm again too often." "This is to avoid clearing and raising the alarm again too often."

4
apps/emqx_exhook/src/emqx_exhook_schema.erl
View File

@ -41,7 +41,9 @@ roots() -> [exhook].
fields(exhook) -> fields(exhook) ->
[{servers, [{servers,
sc(hoconsc:array(ref(server)), sc(hoconsc:array(ref(server)),
#{default => []})} #{ default => []
, desc => "List of exhook servers."
})}
]; ];
fields(server) -> fields(server) ->

10
apps/emqx_gateway/src/emqx_gateway_schema.erl
View File

@ -318,9 +318,9 @@ fields(ssl_server_opts) ->
}, true); }, true);
fields(clientinfo_override) -> fields(clientinfo_override) ->
[ {username, sc(binary())} [ {username, sc(binary(), #{desc => "Template for overriding username."})}
, {password, sc(binary())} , {password, sc(binary(), #{desc => "Template for overriding password."})}
, {clientid, sc(binary())} , {clientid, sc(binary(), #{desc => "Template for overriding clientid."})}
]; ];
fields(lwm2m_translators) -> fields(lwm2m_translators) ->
@ -524,9 +524,7 @@ It has two purposes:
, desc => "" , desc => ""
})} })}
, {clientinfo_override, , {clientinfo_override,
sc(ref(clientinfo_override), sc(ref(clientinfo_override), #{})}
#{ desc => "ClientInfo override"
})}
, {?EMQX_AUTHENTICATION_CONFIG_ROOT_NAME_ATOM, authentication_schema()} , {?EMQX_AUTHENTICATION_CONFIG_ROOT_NAME_ATOM, authentication_schema()}
]. ].