refactor(ds_schema): builtin_local_buffer -> builtin_buffer

This commit is contained in:
ieQu1 2024-06-14 10:46:36 +02:00
parent ecb172b07e
commit abe41de19b
No known key found for this signature in database
GPG Key ID: 488654DF3FED6FDE
2 changed files with 13 additions and 13 deletions

View File

@ -160,10 +160,10 @@ fields(builtin) ->
)}, )},
{local_write_buffer, {local_write_buffer,
sc( sc(
ref(builtin_local_write_buffer), ref(builtin_write_buffer),
#{ #{
importance => ?IMPORTANCE_HIDDEN, importance => ?IMPORTANCE_HIDDEN,
desc => ?DESC(builtin_local_write_buffer) desc => ?DESC(builtin_write_buffer)
} }
)}, )},
{layout, {layout,
@ -179,7 +179,7 @@ fields(builtin) ->
} }
)} )}
]; ];
fields(builtin_local_write_buffer) -> fields(builtin_write_buffer) ->
[ [
{max_items, {max_items,
sc( sc(
@ -188,7 +188,7 @@ fields(builtin_local_write_buffer) ->
default => 1000, default => 1000,
mapping => "emqx_durable_storage.egress_batch_size", mapping => "emqx_durable_storage.egress_batch_size",
importance => ?IMPORTANCE_HIDDEN, importance => ?IMPORTANCE_HIDDEN,
desc => ?DESC(builtin_local_write_buffer_max_items) desc => ?DESC(builtin_write_buffer_max_items)
} }
)}, )},
{flush_interval, {flush_interval,
@ -198,7 +198,7 @@ fields(builtin_local_write_buffer) ->
default => 100, default => 100,
mapping => "emqx_durable_storage.egress_flush_interval", mapping => "emqx_durable_storage.egress_flush_interval",
importance => ?IMPORTANCE_HIDDEN, importance => ?IMPORTANCE_HIDDEN,
desc => ?DESC(builtin_local_write_buffer_flush_interval) desc => ?DESC(builtin_write_buffer_flush_interval)
} }
)} )}
]; ];
@ -254,8 +254,8 @@ fields(layout_builtin_reference) ->
desc(builtin) -> desc(builtin) ->
?DESC(builtin); ?DESC(builtin);
desc(builtin_local_write_buffer) -> desc(builtin_write_buffer) ->
?DESC(builtin_local_write_buffer); ?DESC(builtin_write_buffer);
desc(layout_builtin_wildcard_optimized) -> desc(layout_builtin_wildcard_optimized) ->
?DESC(layout_builtin_wildcard_optimized); ?DESC(layout_builtin_wildcard_optimized);
desc(layout_builtin_reference) -> desc(layout_builtin_reference) ->

View File

@ -39,21 +39,21 @@ builtin_n_sites.desc:
During this phase at least that many sites should come online to distribute shards between them, otherwise message storage will be unavailable until then. During this phase at least that many sites should come online to distribute shards between them, otherwise message storage will be unavailable until then.
After the initialization is complete, sites may be offline, which will affect availability depending on the number of offline sites and replication factor.~""" After the initialization is complete, sites may be offline, which will affect availability depending on the number of offline sites and replication factor.~"""
builtin_local_write_buffer.label: "Local write buffer" builtin_write_buffer.label: "Local write buffer"
builtin_local_write_buffer.desc: builtin_write_buffer.desc:
"""~ """~
Configuration related to the buffering of messages sent from the local node to the shard leader. Configuration related to the buffering of messages sent from the local node to the shard leader.
EMQX accumulates PUBLISH messages from the local clients in a write buffer before committing them to the durable storage. EMQX accumulates PUBLISH messages from the local clients in a write buffer before committing them to the durable storage.
This helps to hide network latency between EMQX nodes and improves write throughput.~""" This helps to hide network latency between EMQX nodes and improves write throughput.~"""
builtin_local_write_buffer_max_items.label: "Max items" builtin_write_buffer_max_items.label: "Max items"
builtin_local_write_buffer_max_items.desc: builtin_write_buffer_max_items.desc:
"""~ """~
This configuration parameter defines maximum number of messages stored in the local write buffer.~""" This configuration parameter defines maximum number of messages stored in the local write buffer.~"""
builtin_local_write_buffer_flush_interval.label: "Flush interval" builtin_write_buffer_flush_interval.label: "Flush interval"
builtin_local_write_buffer_flush_interval.desc: builtin_write_buffer_flush_interval.desc:
"""~ """~
Maximum linger time for the buffered messages. Maximum linger time for the buffered messages.
Local write buffer will be flushed _at least_ as often as `flush_interval`. Local write buffer will be flushed _at least_ as often as `flush_interval`.