From def95aa22bf44ffc2b1292ca7c1d472bddfd4dca Mon Sep 17 00:00:00 2001 From: Kjell Winblad Date: Mon, 19 Feb 2024 11:33:37 +0100 Subject: [PATCH] docs(HStreamDB bridge): make pool size descriptions better --- apps/emqx_bridge_hstreamdb/src/emqx_bridge_hstreamdb.erl | 2 +- rel/i18n/emqx_bridge_hstreamdb.hocon | 4 ++-- rel/i18n/emqx_bridge_hstreamdb_connector.hocon | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/apps/emqx_bridge_hstreamdb/src/emqx_bridge_hstreamdb.erl b/apps/emqx_bridge_hstreamdb/src/emqx_bridge_hstreamdb.erl index 0556a731d..694f459e0 100644 --- a/apps/emqx_bridge_hstreamdb/src/emqx_bridge_hstreamdb.erl +++ b/apps/emqx_bridge_hstreamdb/src/emqx_bridge_hstreamdb.erl @@ -110,10 +110,10 @@ bridge_v2_examples(Method) -> action_values() -> #{ <<"parameters">> => #{ - <<"aggregation_pool_size">> => 8, <<"partition_key">> => <<"hej">>, <<"record_template">> => <<"${payload}">>, <<"stream">> => <<"mqtt_message">>, + <<"aggregation_pool_size">> => 8, <<"writer_pool_size">> => 8 } }. diff --git a/rel/i18n/emqx_bridge_hstreamdb.hocon b/rel/i18n/emqx_bridge_hstreamdb.hocon index af2768c4b..d9eb6cc22 100644 --- a/rel/i18n/emqx_bridge_hstreamdb.hocon +++ b/rel/i18n/emqx_bridge_hstreamdb.hocon @@ -60,7 +60,7 @@ grpc_flush_timeout.label: """gRPC Flush Interval""" aggregation_pool_size.desc: -"""Size of record aggregation pool.""" +"""The size of the record aggregation pool. A larger aggregation pool size can lead to enhanced parallelization but may also result in reduced efficiency due to smaller batch sizes.""" aggregation_pool_size.label: """Aggregation Pool Size""" @@ -72,7 +72,7 @@ max_batches.label: """Max Batches""" writer_pool_size.desc: -"""The size of the writer pool.""" +"""The size of the writer pool. A larger pool may increase parallelization and concurrent write operations, potentially boosting throughput. Trade-offs include greater memory consumption and possible resource contention.""" writer_pool_size.label: """Writer Pool Size""" diff --git a/rel/i18n/emqx_bridge_hstreamdb_connector.hocon b/rel/i18n/emqx_bridge_hstreamdb_connector.hocon index 8f7ac2edb..3122d59da 100644 --- a/rel/i18n/emqx_bridge_hstreamdb_connector.hocon +++ b/rel/i18n/emqx_bridge_hstreamdb_connector.hocon @@ -19,7 +19,7 @@ name.label: """Connector Name""" url.desc: -"""HStreamDB Server URL. Using gRPC http server address.""" +"""HStreamDB Server URL. This URL will be used as the gRPC HTTP server address.""" url.label: """HStreamDB Server URL""" @@ -37,13 +37,13 @@ partition_key.label: """HStreamDB Partition Key""" pool_size.desc: -"""HStreamDB Pool Size.""" +"""The size of the aggregation pool and the writer pool (see the description of the HStreamDB action for more information about these pools). Larger pool sizes can enhance parallelization but may also reduce efficiency due to smaller batch sizes.""" pool_size.label: """HStreamDB Pool Size""" grpc_timeout.desc: -"""HStreamDB gRPC Timeout.""" +"""The timeout for HStreamDB gRPC requests.""" grpc_timeout.label: """HStreamDB gRPC Timeout"""