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

docs(ds): Add descriptions for the builtin's egress config

This commit is contained in:
ieQu1 2024-02-23 12:36:09 +01:00
parent 786e30056b
commit 94b0ab983d
No known key found for this signature in database
GPG Key ID: 488654DF3FED6FDE
3 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
apps/emqx/src/emqx_ds_schema.erl
View File

@ -77,7 +77,7 @@ schema() ->
{messages, {messages,
ds_schema(#{ ds_schema(#{
desc => ?DESC(messages), desc => ?DESC(messages),
importance => ?IMPORTANCE_HIDDEN, importance => ?IMPORTANCE_MEDIUM,
default => default =>
#{ #{
<<"backend">> => builtin <<"backend">> => builtin
@ -165,7 +165,8 @@ fields(builtin_egress) ->
#{ #{
default => 1000, default => 1000,
mapping => "emqx_durable_storage.egress_batch_size", mapping => "emqx_durable_storage.egress_batch_size",
importance => ?IMPORTANCE_HIDDEN importance => ?IMPORTANCE_MEDIUM,
desc => ?DESC(egress_max_items)
} }
)}, )},
{flush_interval, {flush_interval,
@ -174,7 +175,8 @@ fields(builtin_egress) ->
#{ #{
default => 100, default => 100,
mapping => "emqx_durable_storage.egress_flush_interval", mapping => "emqx_durable_storage.egress_flush_interval",
importance => ?IMPORTANCE_HIDDEN importance => ?IMPORTANCE_MEDIUM,
desc => ?DESC(egress_flush_interval)
} }
)} )}
]; ];

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

@ -258,7 +258,7 @@ roots(medium) ->
{"durable_storage", {"durable_storage",
sc( sc(
ref("durable_storage"), ref("durable_storage"),
#{importance => ?IMPORTANCE_HIDDEN} #{importance => ?IMPORTANCE_MEDIUM}
)} )}
]; ];
roots(low) -> roots(low) ->

11
rel/i18n/emqx_ds_schema.hocon
View File

@ -47,4 +47,15 @@ wildcard_optimized_epoch_bits.desc:
Each epoch can be consumed by the subscribers as a batch. Each epoch can be consumed by the subscribers as a batch.
Generally, larger epochs lead to higher throughput of subscribers, however currently they may increase latency.~""" Generally, larger epochs lead to higher throughput of subscribers, however currently they may increase latency.~"""
egress_max_items.label: "Max items"
egress_max_items.desc:
"""~
This configuration parameter defines maximum number of buffered messages stored in the egress buffer.~"""
egress_flush_interval.label: "Flush interval"
egress_flush_interval.desc:
"""~
Maximum linger time for the buffered messages.
Egress buffer will be flushed _at least_ as often as `flush_interval`.~"""
} }