From f0bf6094859c3104298c6ea8b1c98ce029c5a678 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Mon, 8 Jan 2024 15:41:43 +0800 Subject: [PATCH] configuration files updates (#2420) Co-authored-by: Chris Chen --- .../1.configurations/2.meta-config.md | 3 +- .../1.configurations/3.graph-config.md | 9 ++--- .../1.configurations/4.storage-config.md | 36 +++++++++---------- .../1.configurations/2.meta-config.md | 4 ++- .../1.configurations/3.graph-config.md | 9 ++--- .../1.configurations/4.storage-config.md | 36 +++++++++---------- 6 files changed, 44 insertions(+), 53 deletions(-) diff --git a/docs-2.0-en/5.configurations-and-logs/1.configurations/2.meta-config.md b/docs-2.0-en/5.configurations-and-logs/1.configurations/2.meta-config.md index ecc00481f33..2c4527bbde8 100644 --- a/docs-2.0-en/5.configurations-and-logs/1.configurations/2.meta-config.md +++ b/docs-2.0-en/5.configurations-and-logs/1.configurations/2.meta-config.md @@ -58,7 +58,6 @@ For all parameters and their current values, see [Configurations](1.configuratio | `ws_ip` | `0.0.0.0` | Specifies the IP address for the HTTP service. | No| | `ws_http_port` | `19559` | Specifies the port for the HTTP service. | No| |`ws_storage_http_port`|`19779`| Specifies the Storage service listening port used by the HTTP protocol. It must be consistent with the `ws_http_port` in the Storage service configuration file. This parameter only applies to standalone NebulaGraph.| No| -|`heartbeat_interval_secs` | `10` | Specifies the default heartbeat interval. Make sure the `heartbeat_interval_secs` values for all services are the same, otherwise NebulaGraph **CANNOT** work normally. This configuration is measured in seconds. | Yes| !!! caution @@ -76,6 +75,8 @@ For all parameters and their current values, see [Configurations](1.configuratio | :------------------------- | :-------------------- | :---------------------------------------------------------------------------- |:----------------- | |`default_parts_num` | `10` | Specifies the default partition number when creating a new graph space. | No| |`default_replica_factor` | `1` | Specifies the default replica number when creating a new graph space. | No| +|`heartbeat_interval_secs` | `10` | Specifies the default heartbeat interval. Make sure the `heartbeat_interval_secs` values for all services are the same, otherwise NebulaGraph **CANNOT** work normally. This configuration is measured in seconds. | Yes| +|`agent_heartbeat_interval_secs`| `60` | Specifies the default heartbeat interval for the Agent service. This configuration influences the time it takes for the system to determine that the Agent service is offline. This configuration is measured in seconds. | No| ## RocksDB options configurations diff --git a/docs-2.0-en/5.configurations-and-logs/1.configurations/3.graph-config.md b/docs-2.0-en/5.configurations-and-logs/1.configurations/3.graph-config.md index 5b696dd8d2c..ff65c3a425a 100644 --- a/docs-2.0-en/5.configurations-and-logs/1.configurations/3.graph-config.md +++ b/docs-2.0-en/5.configurations-and-logs/1.configurations/3.graph-config.md @@ -29,6 +29,8 @@ For all parameters and their current values, see [Configurations](1.configuratio | `pid_file` | `pids/nebula-graphd.pid`| The file that records the process ID. | No| |`enable_optimizer` |`true` | When set to `true`, the optimizer is enabled. | No| | `timezone_name` | - | Specifies the NebulaGraph time zone. This parameter is not predefined in the initial configuration files. The system default value is `UTC+00:00:00`. For the format of the parameter value, see [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual"). For example, `--timezone_name=UTC+08:00` represents the GMT+8 time zone. | No| +|`default_charset`|`utf8`|Specifies the default charset when creating a new graph space. | No| +|`default_collate`|`utf8_bin`|Specifies the default collate when creating a new graph space. | No| | `local_config` | `true` | When set to `true`, the process gets configurations from the configuration files. | No| !!! note @@ -85,13 +87,6 @@ For all parameters and their current values, see [Configurations](1.configuratio It is recommended to use a real IP when using IP address. Otherwise, `127.0.0.1/0.0.0.0` cannot be parsed correctly in some cases. -## Charset and collate configurations - -| Name | Predefined value | Description |Whether supports runtime dynamic modifications| -| ---------------- | ------------------ | -------------------------------------------------------------- |------------------| -|`default_charset` | `utf8` | Specifies the default charset when creating a new graph space. | No| -|`default_collate` | `utf8_bin` | Specifies the default collate when creating a new graph space. | No| - ## Authorization configurations | Name | Predefined value | Description |Whether supports runtime dynamic modifications| diff --git a/docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md index 1c0e30e7cff..8cd2b82da7c 100644 --- a/docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md +++ b/docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md @@ -105,25 +105,6 @@ For all parameters and their current values, see [Configurations](1.configuratio | `rocksdb_blob_compression` | `lz4` | Compression algorithm for BlobDB. Optional values are `no`, `snappy`, `lz4`, `lz4hc`, `zlib`, `bzip2`, and `zstd`. | | `rocksdb_enable_blob_garbage_collection` | `true` | Whether to perform BlobDB garbage collection during compaction. | --> -## Misc configurations - -!!! caution - - The configuration `snapshot` in the following table is different from the snapshot in NebulaGraph. The `snapshot` here refers to the stock data on the leader when synchronizing Raft. - -| Name | Predefined value | Description |Whether supports runtime dynamic modifications| -| :-- | :----- | :--- |:------------------| -| `query_concurrently` |`true`| Whether to turn on multi-threaded queries. Enabling it can improve the latency performance of individual queries, but it will reduce the overall throughput under high pressure. | Yes| -| `auto_remove_invalid_space` | `true` |After executing `DROP SPACE`, the specified graph space will be deleted. This parameter sets whether to delete all the data in the specified graph space at the same time. When the value is `true`, all the data in the specified graph space will be deleted at the same time.| Yes| -| `num_io_threads` | `16` | The number of network I/O threads used to send RPC requests and receive responses. | No| -|`num_max_connections` |`0` |Max active connections for all networking threads. 0 means no limit.
Max connections for each networking thread = num_max_connections / num_netio_threads|No| -| `num_worker_threads` | `32` | The number of worker threads for one RPC-based Storage service. | No| -| `max_concurrent_subtasks` | `10` | The maximum number of concurrent subtasks to be executed by the task manager. | No| -| `snapshot_part_rate_limit` | `10485760` | The rate limit when the Raft leader synchronizes the stock data with other members of the Raft group. Unit: bytes/s. | Yes| -| `snapshot_batch_size` | `1048576` | The amount of data sent in each batch when the Raft leader synchronizes the stock data with other members of the Raft group. Unit: bytes. | Yes| -| `rebuild_index_part_rate_limit` | `4194304` | The rate limit when the Raft leader synchronizes the index data rate with other members of the Raft group during the index rebuilding process. Unit: bytes/s. | Yes| -| `rebuild_index_batch_size` | `1048576` | The amount of data sent in each batch when the Raft leader synchronizes the index data with other members of the Raft group during the index rebuilding process. Unit: bytes. | Yes| - ## RocksDB options | Name | Predefined value | Description |Whether supports runtime dynamic modifications| @@ -177,7 +158,24 @@ Supported options of `rocksdb_db_options` and `rocksdb_column_family_options` ar For more information, see [RocksDB official documentation](https://rocksdb.org/). +## Misc configurations +!!! caution + + The configuration `snapshot` in the following table is different from the snapshot in NebulaGraph. The `snapshot` here refers to the stock data on the leader when synchronizing Raft. + +| Name | Predefined value | Description |Whether supports runtime dynamic modifications| +| :-- | :----- | :--- |:------------------| +| `query_concurrently` |`true`| Whether to turn on multi-threaded queries. Enabling it can improve the latency performance of individual queries, but it will reduce the overall throughput under high pressure. | Yes| +| `auto_remove_invalid_space` | `true` |After executing `DROP SPACE`, the specified graph space will be deleted. This parameter sets whether to delete all the data in the specified graph space at the same time. When the value is `true`, all the data in the specified graph space will be deleted at the same time.| Yes| +| `num_io_threads` | `16` | The number of network I/O threads used to send RPC requests and receive responses. | No| +|`num_max_connections` |`0` |Max active connections for all networking threads. 0 means no limit.
Max connections for each networking thread = num_max_connections / num_netio_threads|No| +| `num_worker_threads` | `32` | The number of worker threads for one RPC-based Storage service. | No| +| `max_concurrent_subtasks` | `10` | The maximum number of concurrent subtasks to be executed by the task manager. | No| +| `snapshot_part_rate_limit` | `10485760` | The rate limit when the Raft leader synchronizes the stock data with other members of the Raft group. Unit: bytes/s. | Yes| +| `snapshot_batch_size` | `1048576` | The amount of data sent in each batch when the Raft leader synchronizes the stock data with other members of the Raft group. Unit: bytes. | Yes| +| `rebuild_index_part_rate_limit` | `4194304` | The rate limit when the Raft leader synchronizes the index data rate with other members of the Raft group during the index rebuilding process. Unit: bytes/s. | Yes| +| `rebuild_index_batch_size` | `1048576` | The amount of data sent in each batch when the Raft leader synchronizes the index data with other members of the Raft group during the index rebuilding process. Unit: bytes. | Yes| ## Memory Tracker configurations diff --git a/docs-2.0-zh/5.configurations-and-logs/1.configurations/2.meta-config.md b/docs-2.0-zh/5.configurations-and-logs/1.configurations/2.meta-config.md index ebb92ad201e..f7e338b0365 100644 --- a/docs-2.0-zh/5.configurations-and-logs/1.configurations/2.meta-config.md +++ b/docs-2.0-zh/5.configurations-and-logs/1.configurations/2.meta-config.md @@ -60,7 +60,7 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul | `ws_ip` | `0.0.0.0` | HTTP 服务的 IP 地址。 |不支持| | `ws_http_port` | `19559` | HTTP 服务的端口。 |不支持| |`ws_storage_http_port`|`19779`| HTTP 协议监听 Storage 服务的端口，需要和 Storage 服务配置文件中的`ws_http_port`保持一致。仅存算合并版 {{nebula.name}} 需要设置本参数。|不支持| -|`heartbeat_interval_secs` | `10` | 默认心跳间隔。请确保所有服务的`heartbeat_interval_secs`取值相同，否则会导致系统无法正常工作。单位：秒。 |支持| + !!! caution @@ -78,6 +78,8 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul | :------------------------- | :-------- | :------------------------ |:------------------| |`default_parts_num` | `10` | 创建图空间时的默认分片数量。 |不支持| |`default_replica_factor` | `1` | 创建图空间时的默认副本数量。 |不支持| +|`heartbeat_interval_secs` | `10` | 默认心跳间隔。请确保所有服务的`heartbeat_interval_secs`取值相同，否则会导致系统无法正常工作。单位：秒。 |支持| +|`agent_heartbeat_interval_secs`| `60` | Agent 服务发送心跳的时间间隔。该值影响系统确定 Agent 服务离线状态的时间。|不支持| ## rocksdb options 配置 diff --git a/docs-2.0-zh/5.configurations-and-logs/1.configurations/3.graph-config.md b/docs-2.0-zh/5.configurations-and-logs/1.configurations/3.graph-config.md index 7cecd82c9d2..74caf4118ee 100644 --- a/docs-2.0-zh/5.configurations-and-logs/1.configurations/3.graph-config.md +++ b/docs-2.0-zh/5.configurations-and-logs/1.configurations/3.graph-config.md @@ -28,6 +28,8 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb | `pid_file` | `pids/nebula-graphd.pid`| 记录进程 ID 的文件。 |不支持| |`enable_optimizer` |`true` | 是否启用优化器。|不支持| | `timezone_name` | - | 指定 {{nebula.name}} 的时区。初始配置文件中未设置该参数，使用需手动添加。系统默认值为`UTC+00:00:00`。格式请参见 [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual")。例如，东八区的设置方式为`--timezone_name=UTC+08:00`。 |不支持| +|`default_charset`|`utf8`|创建图空间时的默认字符集。|不支持| +|`default_collate`|`utf8_bin`|创建图空间时的默认排序规则。|不支持| | `local_config` | `true` | 是否从配置文件获取配置信息。 |不支持| !!! note @@ -83,13 +85,6 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb !!! caution 使用 IP 时建议使用真实的 IP。否则某些情况下`127.0.0.1/0.0.0.0`无法正确解析。 - -## charset and collate 配置 - -| 名称 | 预设值 | 说明 |是否支持运行时动态修改| -| ------------------- | ---------------- | ------------------------------------------ |---------------------| -| `default_charset` | `utf8` | 创建图空间时的默认字符集。 |不支持| -| `default_collate` | `utf8_bin` | 创建图空间时的默认排序规则。 |不支持| ## authorization 配置 diff --git a/docs-2.0-zh/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0-zh/5.configurations-and-logs/1.configurations/4.storage-config.md index beb4d794b32..ffd93165f56 100644 --- a/docs-2.0-zh/5.configurations-and-logs/1.configurations/4.storage-config.md +++ b/docs-2.0-zh/5.configurations-and-logs/1.configurations/4.storage-config.md @@ -105,24 +105,6 @@ Storage 服务提供了两份初始配置文件`nebula-storaged.conf.default`和 | `rocksdb_blob_compression` | `lz4` | BlobDB 的压缩算法，可选值：`no`、`snappy`、`lz4`、`lz4hc`、`zlib`、`bzip2`、`zstd`。 | | `rocksdb_enable_blob_garbage_collection` | `true` | 在 compaction 过程中是否对 BlobDB 进行垃圾收集。 | --> -## misc 配置 - -!!! caution - - 下表中的`snapshot`与 {{nebula.name}} 快照是不同的概念，这里的`snapshot`指 Raft 同步过程中 leader 上的存量数据。 - -| 名称 | 预设值 | 说明 |是否支持运行时动态修改| -| :-- | :----- | :--- | :--- | -| `query_concurrently` | `true` | 是否开启多线程查询。开启后可以提高单个查询的时延性能，但大压力下会降低整体的吞吐量。 |支持| -| `auto_remove_invalid_space` | `true` | 在执行`DROP SPACE`后，会删除指定图空间，该参数设置是否同时删除指定图空间内的所有数据。当值为`true`时，同时删除指定图空间内的所有数据。 |支持| -| `num_io_threads` | `16` | 网络 I/O 线程的数量，用于发送 RPC 请求和接收响应。 |不支持| -|`num_max_connections` |`0` |所有网络线程的最大活动连接数，`0`表示没有限制。
每个网络线程的最大连接数=`num_max_connections`/`num_netio_threads`。|不支持| -| `num_worker_threads` | `32` | Storage 的 RPC 服务的工作线程数量。 |不支持| -| `max_concurrent_subtasks` | `10` | TaskManager 并发执行子任务的最大个数。 |不支持| -| `snapshot_part_rate_limit` | `10485760` | Raft leader 向 Raft group 中其它成员同步存量数据时的限速。单位：字节/秒。 |支持| -| `snapshot_batch_size` | `1048576` | Raft leader 向 Raft group 中其它成员同步存量数据时每批发送的数据量。单位：字节。 |支持| -| `rebuild_index_part_rate_limit` | `4194304` | 重建索引过程中，Raft leader 向 Raft group 中其它成员同步索引数据时的限速。单位：字节/秒。 |支持| -| `rebuild_index_batch_size` | `1048576` | 重建索引过程中，Raft leader 向 Raft group 中其它成员同步索引数据时每批发送的数据量。单位：字节。 |支持| ## rocksdb options 配置 @@ -178,6 +160,24 @@ rocksdb options 配置的格式为`{"":""}`，多个 参数的详细说明请参见 [RocksDB 官方文档](https://rocksdb.org/)。 +## misc 配置 + +!!! caution + + 下表中的`snapshot`与 {{nebula.name}} 快照是不同的概念，这里的`snapshot`指 Raft 同步过程中 leader 上的存量数据。 + +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :-- | :----- | :--- | :--- | +| `query_concurrently` | `true` | 是否开启多线程查询。开启后可以提高单个查询的时延性能，但大压力下会降低整体的吞吐量。 |支持| +| `auto_remove_invalid_space` | `true` | 在执行`DROP SPACE`后，会删除指定图空间，该参数设置是否同时删除指定图空间内的所有数据。当值为`true`时，同时删除指定图空间内的所有数据。 |支持| +| `num_io_threads` | `16` | 网络 I/O 线程的数量，用于发送 RPC 请求和接收响应。 |不支持| +|`num_max_connections` |`0` |所有网络线程的最大活动连接数，`0`表示没有限制。
每个网络线程的最大连接数=`num_max_connections`/`num_netio_threads`。|不支持| +| `num_worker_threads` | `32` | Storage 的 RPC 服务的工作线程数量。 |不支持| +| `max_concurrent_subtasks` | `10` | TaskManager 并发执行子任务的最大个数。 |不支持| +| `snapshot_part_rate_limit` | `10485760` | Raft leader 向 Raft group 中其它成员同步存量数据时的限速。单位：字节/秒。 |支持| +| `snapshot_batch_size` | `1048576` | Raft leader 向 Raft group 中其它成员同步存量数据时每批发送的数据量。单位：字节。 |支持| +| `rebuild_index_part_rate_limit` | `4194304` | 重建索引过程中，Raft leader 向 Raft group 中其它成员同步索引数据时的限速。单位：字节/秒。 |支持| +| `rebuild_index_batch_size` | `1048576` | 重建索引过程中，Raft leader 向 Raft group 中其它成员同步索引数据时每批发送的数据量。单位：字节。 |支持| ## memory tracker 配置