diff --git a/src/.vuepress/sidebar/V2.0.x/en-Tree.ts b/src/.vuepress/sidebar/V2.0.x/en-Tree.ts index e3d94ceb2..318ef1673 100644 --- a/src/.vuepress/sidebar/V2.0.x/en-Tree.ts +++ b/src/.vuepress/sidebar/V2.0.x/en-Tree.ts @@ -318,7 +318,7 @@ export const enSidebar = { { text: 'Common Config Manual', link: 'Common-Config-Manual' }, { text: 'ConfigNode Config Manual', - link: 'ConfigNode-Config-Manual', + link: 'ConfigNode-Config-Manual_apache', }, { text: 'DataNode Config Manual', link: 'DataNode-Config-Manual_apache' }, ], diff --git a/src/.vuepress/sidebar/V2.0.x/zh-Tree.ts b/src/.vuepress/sidebar/V2.0.x/zh-Tree.ts index 7d8631c8c..656572e3d 100644 --- a/src/.vuepress/sidebar/V2.0.x/zh-Tree.ts +++ b/src/.vuepress/sidebar/V2.0.x/zh-Tree.ts @@ -298,7 +298,7 @@ export const zhSidebar = { collapsible: true, children: [ { text: '配置参数', link: 'Common-Config-Manual' }, - { text: 'ConfigNode配置参数', link: 'ConfigNode-Config-Manual' }, + { text: 'ConfigNode配置参数', link: 'ConfigNode-Config-Manual_apache' }, { text: 'DataNode配置参数', link: 'DataNode-Config-Manual_apache' }, ], }, diff --git a/src/.vuepress/sidebar_timecho/V2.0.x/en-Tree.ts b/src/.vuepress/sidebar_timecho/V2.0.x/en-Tree.ts index df3e62784..b8c7d6f0b 100644 --- a/src/.vuepress/sidebar_timecho/V2.0.x/en-Tree.ts +++ b/src/.vuepress/sidebar_timecho/V2.0.x/en-Tree.ts @@ -346,7 +346,7 @@ export const enSidebar = { { text: 'Common Config Manual', link: 'Common-Config-Manual' }, { text: 'ConfigNode Config Manual', - link: 'ConfigNode-Config-Manual', + link: 'ConfigNode-Config-Manual_timecho', }, { text: 'DataNode Config Manual', link: 'DataNode-Config-Manual_timecho' }, ], diff --git a/src/.vuepress/sidebar_timecho/V2.0.x/zh-Tree.ts b/src/.vuepress/sidebar_timecho/V2.0.x/zh-Tree.ts index 87f027906..2d8f6d5fd 100644 --- a/src/.vuepress/sidebar_timecho/V2.0.x/zh-Tree.ts +++ b/src/.vuepress/sidebar_timecho/V2.0.x/zh-Tree.ts @@ -317,7 +317,7 @@ export const zhSidebar = { collapsible: true, children: [ { text: '配置参数', link: 'Common-Config-Manual' }, - { text: 'ConfigNode配置参数', link: 'ConfigNode-Config-Manual' }, + { text: 'ConfigNode配置参数', link: 'ConfigNode-Config-Manual_timecho' }, { text: 'DataNode配置参数', link: 'DataNode-Config-Manual_timecho' }, ], }, diff --git a/src/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md b/src/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md index d5a7bc7e4..0a3c7a1cb 100644 --- a/src/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md +++ b/src/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md @@ -590,12 +590,12 @@ The `iotdb-system.properties` file contains various configurations for managing - cn_selector_thread_nums_of_client_manager -| Name | cn_selector_thread_nums_of_client_manager | -| ----------- | ------------------------------------------------------------ | -| Description | Number of selector threads for client management in ConfigNode. | -| Type | int | -| Default | 1 | -| Effective | Restart required. | +| Name | cn_selector_thread_nums_of_client_manager | +| ----------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | Number of selector threads for client management in ConfigNode. | +| Type | int | +| Default | 1
The default value is changed to 0 starting from V2.0.10-beta. If the value is less than or equal to 0, it will be automatically calculated as `max(1, number of CPU cores / 4)`. | +| Effective | Restart required. | - cn_max_client_count_for_each_node_in_client_manager @@ -606,6 +606,16 @@ The `iotdb-system.properties` file contains various configurations for managing | Default | 300 | | Effective | Restart required. | +- cn_max_idle_client_count_for_each_node_in_client_manager + +| Name | cn_max_idle_client_count_for_each_node_in_client_manager | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10-beta. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + - dn_session_timeout_threshold | Name | dn_session_timeout_threshold | @@ -635,12 +645,12 @@ The `iotdb-system.properties` file contains various configurations for managing - dn_rpc_selector_thread_count -| Name | rpc_selector_thread_count | -| ----------- | -------------------------------------------- | -| Description | Number of selector threads for DataNode RPC. | -| Type | int | -| Default | 1 | -| Effective | Restart required.t required. | +| Name | rpc_selector_thread_count | +| ----------- |-------------------------------------------------------------------------------------------------------| +| Description | Number of selector threads for DataNode RPC. This parameter is deprecated starting from V2.0.10-beta. | +| Type | int | +| Default | 1 | +| Effective | Restart required.t required. | - dn_rpc_min_concurrent_client_num @@ -689,12 +699,12 @@ The `iotdb-system.properties` file contains various configurations for managing - dn_selector_thread_count_of_client_manager -| Name | dn_selector_thread_count_of_client_manager | -| ----------- | ------------------------------------------------------------ | -| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | -| Type | int | -| Default | 1 | -| Effective | Restart required.t required. | +| Name | dn_selector_thread_nums_of_client_manager
Prior to V2.0.10-beta, the parameter name was dn_selector_thread_count_of_client_manager. | +| ----------- |------------------------------------------------------------------------------------------------------------------------------------------| +| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | +| Type | int | +| Default | 1
The default value is changed to 0 starting from V2.0.10-beta. If the value is less than or equal to 0, it will be automatically calculated as `max(1, number of CPU cores / 4)`. | +| Effective | Restart required.t required. | - dn_max_client_count_for_each_node_in_client_manager @@ -705,6 +715,18 @@ The `iotdb-system.properties` file contains various configurations for managing | Default | 300 | | Effective | Restart required. | + +- dn_max_idle_client_count_for_each_node_in_client_manager + +| Name | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10-beta. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + + ### 4.9 Object storage management - remote_tsfile_cache_dirs diff --git a/src/UserGuide/Master/Table/Reference/System-Config-Manual_timecho.md b/src/UserGuide/Master/Table/Reference/System-Config-Manual_timecho.md index f96a33713..cf8a79090 100644 --- a/src/UserGuide/Master/Table/Reference/System-Config-Manual_timecho.md +++ b/src/UserGuide/Master/Table/Reference/System-Config-Manual_timecho.md @@ -591,12 +591,12 @@ The `iotdb-system.properties` file contains various configurations for managing - cn_selector_thread_nums_of_client_manager -| Name | cn_selector_thread_nums_of_client_manager | -| ----------- | ------------------------------------------------------------ | -| Description | Number of selector threads for client management in ConfigNode. | -| Type | int | -| Default | 1 | -| Effective | Restart required. | +| Name | cn_selector_thread_nums_of_client_manager | +| ----------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | Number of selector threads for client management in ConfigNode. | +| Type | int | +| Default | 1
The default value is changed to 0 starting from V2.0.10.1. If the value is less than or equal to 0, it will be automatically calculated as `max(1, number of CPU cores / 4)`. | +| Effective | Restart required. | - cn_max_client_count_for_each_node_in_client_manager @@ -607,6 +607,15 @@ The `iotdb-system.properties` file contains various configurations for managing | Default | 300 | | Effective | Restart required. | +- cn_max_idle_client_count_for_each_node_in_client_manager + +| Name | cn_max_idle_client_count_for_each_node_in_client_manager | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10.1. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + - dn_session_timeout_threshold | Name | dn_session_timeout_threshold | @@ -636,12 +645,12 @@ The `iotdb-system.properties` file contains various configurations for managing - dn_rpc_selector_thread_count -| Name | rpc_selector_thread_count | -| ----------- | -------------------------------------------- | -| Description | Number of selector threads for DataNode RPC. | -| Type | int | -| Default | 1 | -| Effective | Restart required.t required. | +| Name | rpc_selector_thread_count | +| ----------- |----------------------------------------------------------------------------------------------------| +| Description | Number of selector threads for DataNode RPC. This parameter is deprecated starting from V2.0.10.1. | +| Type | int | +| Default | 1 | +| Effective | Restart required.t required. | - dn_rpc_min_concurrent_client_num @@ -688,14 +697,14 @@ The `iotdb-system.properties` file contains various configurations for managing | Default | 60000 | | Effective | Restart required. | -- dn_selector_thread_count_of_client_manager +- dn_selector_thread_nums_of_client_manager -| Name | dn_selector_thread_count_of_client_manager | -| ----------- | ------------------------------------------------------------ | -| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | -| Type | int | -| Default | 1 | -| Effective | Restart required.t required. | +| Name | dn_selector_thread_nums_of_client_manager
Prior to V2.0.10.1, the parameter name was dn_selector_thread_count_of_client_manager. | +| ----------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | +| Type | int | +| Default | 1
The default value is changed to 0 starting from V2.0.10.1. If the value is less than or equal to 0, it will be automatically calculated as `max(1, number of CPU cores / 4)`. | +| Effective | Restart required.t required. | - dn_max_client_count_for_each_node_in_client_manager @@ -706,6 +715,17 @@ The `iotdb-system.properties` file contains various configurations for managing | Default | 300 | | Effective | Restart required. | + +- dn_max_idle_client_count_for_each_node_in_client_manager + +| Name | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10.1. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + ### 4.9 Object storage management - remote_tsfile_cache_dirs diff --git a/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md b/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md index 9f3559bc0..09efb16f6 100644 --- a/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md +++ b/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md @@ -1,3 +1,6 @@ +--- +redirectTo: ConfigNode-Config-Manual_apache.html +--- - -# ConfigNode Config Manual - -IoTDB ConfigNode files are under `conf`. - -* `confignode-env.sh/bat`：Environment configurations, in which we could set the memory allocation of ConfigNode. - -* `iotdb-system.properties`：IoTDB system configurations. - -## 1. Environment Configuration File（confignode-env.sh/bat） - -The environment configuration file is mainly used to configure the Java environment related parameters when ConfigNode is running, such as JVM related configuration. This part of the configuration is passed to the JVM when the ConfigNode starts. - -The details of each parameter are as follows: - -* MEMORY\_SIZE - -|Name|MEMORY\_SIZE| -|:---:|:---| -|Description|The memory size that IoTDB ConfigNode will use when startup | -|Type|String| -|Default|The default is three-tenths of the memory, with a maximum of 16G.| -|Effective|After restarting system| - -* ON\_HEAP\_MEMORY - -|Name|ON\_HEAP\_MEMORY| -|:---:|:---| -|Description|The heap memory size that IoTDB ConfigNode can use, Former Name: MAX\_HEAP\_SIZE | -|Type|String| -|Default| Calculate based on MEMORY\_SIZE.| -|Effective|After restarting system| - -* OFF\_HEAP\_MEMORY - -|Name|OFF\_HEAP\_MEMORY| -|:---:|:---| -|Description|The direct memory that IoTDB ConfigNode can use, Former Name: MAX\_DIRECT\_MEMORY\_SIZE | -|Type|String| -|Default| Calculate based on MEMORY\_SIZE.| -|Effective|After restarting system| - - -## 2. ConfigNode Configuration File (iotdb-system.properties) - -The global configuration of cluster is in ConfigNode. - -### 2.1 Config Node RPC Configuration - -* cn\_internal\_address - -| Name | cn\_internal\_address | -|:-----------:|:------------------------------------| -| Description | ConfigNode internal service address | -| Type | String | -| Default | 127.0.0.1 | -| Effective | Only allowed to be modified in first start up | - -* cn\_internal\_port - -|Name| cn\_internal\_port | -|:---:|:---| -|Description| ConfigNode internal service port| -|Type| Short Int : [0,65535] | -|Default| 10710 | -|Effective|Only allowed to be modified in first start up| - -### 2.2 Consensus - -* cn\_consensus\_port - -|Name| cn\_consensus\_port | -|:---:|:---| -|Description| ConfigNode data Consensus Port | -|Type| Short Int : [0,65535] | -|Default| 10720 | -|Effective|Only allowed to be modified in first start up| - -### 2.3 SeedConfigNode - -* cn\_seed\_config\_node - -|Name| cn\_seed\_config\_node | -|:---:|:----------------------------------------------------------------------| -|Description| Seed ConfigNode's address for current ConfigNode to join the cluster. This parameter is corresponding to cn\_target\_config\_node\_list before V1.2.2 | -|Type| String | -|Default| 127.0.0.1:10710 | -|Effective| Only allowed to be modified in first start up | - -### 2.4 Directory configuration - -* cn\_system\_dir - -|Name| cn\_system\_dir | -|:---:|:---| -|Description| ConfigNode system data dir | -|Type| String | -|Default| data/system（Windows：data\\system） | -|Effective|After restarting system| - -* cn\_consensus\_dir - -|Name| cn\_consensus\_dir | -|:---:|:---------------------------------------------------------------| -|Description| ConfigNode Consensus protocol data dir | -|Type| String | -|Default| data/confignode/consensus（Windows：data\\confignode\\consensus） | -|Effective| After restarting system | - -### 2.5 Thrift RPC configuration - -* cn\_rpc\_thrift\_compression\_enable - -|Name| cn\_rpc\_thrift\_compression\_enable | -|:---:|:---| -|Description| Whether enable thrift's compression (using GZIP).| -|Type|Boolean| -|Default| false | -|Effective|After restarting system| - -* cn\_rpc\_thrift\_compression\_enable - -|Name| cn\_rpc\_thrift\_compression\_enable | -|:---:|:---| -|Description| Whether enable thrift's compression (using GZIP).| -|Type|Boolean| -|Default| false | -|Effective|After restarting system| - -* cn\_rpc\_advanced\_compression\_enable - -|Name| cn\_rpc\_advanced\_compression\_enable | -|:---:|:---| -|Description| Whether enable thrift's advanced compression.| -|Type|Boolean| -|Default| false | -|Effective|After restarting system| - -* cn\_rpc\_max\_concurrent\_client\_num - -|Name| cn\_rpc\_max\_concurrent\_client\_num | -|:---:|:--------------------------------------| -|Description| Max concurrent rpc connections | -|Type| int | -|Description| 3000 | -|Effective| After restarting system | - -* cn\_thrift\_max\_frame\_size - -|Name| cn\_thrift\_max\_frame\_size | -|:---:|:---| -|Description| Max size of bytes of each thrift RPC request/response| -|Type| Long | -|Unit|Byte| -|Default| 536870912 | -|Effective|After restarting system| - -* cn\_thrift\_init\_buffer\_size - -|Name| cn\_thrift\_init\_buffer\_size | -|:---:|:---| -|Description| Initial size of bytes of buffer that thrift used | -|Type| long | -|Default| 1024 | -|Effective|After restarting system| - -* cn\_connection\_timeout\_ms - -| Name | cn\_connection\_timeout\_ms | -|:-----------:|:-------------------------------------------------------| -| Description | Thrift socket and connection timeout between nodes | -| Type | int | -| Default | 60000 | -| Effective | After restarting system | - -* cn\_selector\_thread\_nums\_of\_client\_manager - -| Name | cn\_selector\_thread\_nums\_of\_client\_manager | -|:-----------:|:-------------------------------------------------------------------------------| -| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | -| Type | int | -| Default | 1 | -| Effective | After restarting system | - -* cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager - -| Name | cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager | -|:------------:|:---------------------------------------------------------------| -| Description | Number of core clients routed to each node in a ClientManager | -| Type | int | -| Default | 200 | -| Effective | After restarting system | - -* cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager - -| Name | cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager | -|:--------------:|:-------------------------------------------------------------| -| Description | Number of max clients routed to each node in a ClientManager | -| Type | int | -| Default | 300 | -| Effective | After restarting system | - -### 2.6 Metric Configuration - -* cn\_metric\_reporter\_list - -| Name | cn\_metric\_reporter\_list | -|:-----------:|:--------------------------------------| -| Description | Systems for reporting ConfigNode metrics. | -| Type | String | -| Default | None | -| Effective | After restarting system | - -* cn\_metric\_level - -| Name | cn\_metric\_level | -|:-----------:|:------------------------------------| -| Description | Level of detail for ConfigNode metrics. | -| Type | String | -| Default | IMPORTANT | -| Effective | After restarting system | - -* cn\_metric\_async\_collect\_period - -| Name | cn\_metric\_async\_collect\_period | -|:-----------:|:------------------------------------------------------------| -| Description | Period for asynchronous metric collection in ConfigNode (in seconds). | -| Type | int | -| Default | 5 | -| Effective | After restarting system | - -* cn\_metric\_prometheus\_reporter\_port - -| Name | cn\_metric\_prometheus\_reporter\_port | -|:-----------:|:------------------------------------------| -| Description | Port for Prometheus metric reporting in ConfigNode. | -| Type | int | -| Default | 9091 | -| Effective | After restarting system | diff --git a/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual_apache.md b/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual_apache.md new file mode 100644 index 000000000..0c72cd78c --- /dev/null +++ b/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual_apache.md @@ -0,0 +1,269 @@ + + +# ConfigNode Config Manual + +IoTDB ConfigNode files are under `conf`. + +* `confignode-env.sh/bat`：Environment configurations, in which we could set the memory allocation of ConfigNode. + +* `iotdb-system.properties`：IoTDB system configurations. + +## 1. Environment Configuration File（confignode-env.sh/bat） + +The environment configuration file is mainly used to configure the Java environment related parameters when ConfigNode is running, such as JVM related configuration. This part of the configuration is passed to the JVM when the ConfigNode starts. + +The details of each parameter are as follows: + +* MEMORY\_SIZE + +|Name|MEMORY\_SIZE| +|:---:|:---| +|Description|The memory size that IoTDB ConfigNode will use when startup | +|Type|String| +|Default|The default is three-tenths of the memory, with a maximum of 16G.| +|Effective|After restarting system| + +* ON\_HEAP\_MEMORY + +|Name|ON\_HEAP\_MEMORY| +|:---:|:---| +|Description|The heap memory size that IoTDB ConfigNode can use, Former Name: MAX\_HEAP\_SIZE | +|Type|String| +|Default| Calculate based on MEMORY\_SIZE.| +|Effective|After restarting system| + +* OFF\_HEAP\_MEMORY + +|Name|OFF\_HEAP\_MEMORY| +|:---:|:---| +|Description|The direct memory that IoTDB ConfigNode can use, Former Name: MAX\_DIRECT\_MEMORY\_SIZE | +|Type|String| +|Default| Calculate based on MEMORY\_SIZE.| +|Effective|After restarting system| + + +## 2. ConfigNode Configuration File (iotdb-system.properties) + +The global configuration of cluster is in ConfigNode. + +### 2.1 Config Node RPC Configuration + +* cn\_internal\_address + +| Name | cn\_internal\_address | +|:-----------:|:------------------------------------| +| Description | ConfigNode internal service address | +| Type | String | +| Default | 127.0.0.1 | +| Effective | Only allowed to be modified in first start up | + +* cn\_internal\_port + +|Name| cn\_internal\_port | +|:---:|:---| +|Description| ConfigNode internal service port| +|Type| Short Int : [0,65535] | +|Default| 10710 | +|Effective|Only allowed to be modified in first start up| + +### 2.2 Consensus + +* cn\_consensus\_port + +|Name| cn\_consensus\_port | +|:---:|:---| +|Description| ConfigNode data Consensus Port | +|Type| Short Int : [0,65535] | +|Default| 10720 | +|Effective|Only allowed to be modified in first start up| + +### 2.3 SeedConfigNode + +* cn\_seed\_config\_node + +|Name| cn\_seed\_config\_node | +|:---:|:----------------------------------------------------------------------| +|Description| Seed ConfigNode's address for current ConfigNode to join the cluster. This parameter is corresponding to cn\_target\_config\_node\_list before V1.2.2 | +|Type| String | +|Default| 127.0.0.1:10710 | +|Effective| Only allowed to be modified in first start up | + +### 2.4 Directory configuration + +* cn\_system\_dir + +|Name| cn\_system\_dir | +|:---:|:---| +|Description| ConfigNode system data dir | +|Type| String | +|Default| data/system（Windows：data\\system） | +|Effective|After restarting system| + +* cn\_consensus\_dir + +|Name| cn\_consensus\_dir | +|:---:|:---------------------------------------------------------------| +|Description| ConfigNode Consensus protocol data dir | +|Type| String | +|Default| data/confignode/consensus（Windows：data\\confignode\\consensus） | +|Effective| After restarting system | + +### 2.5 Thrift RPC configuration + +* cn\_rpc\_thrift\_compression\_enable + +|Name| cn\_rpc\_thrift\_compression\_enable | +|:---:|:---| +|Description| Whether enable thrift's compression (using GZIP).| +|Type|Boolean| +|Default| false | +|Effective|After restarting system| + +* cn\_rpc\_thrift\_compression\_enable + +|Name| cn\_rpc\_thrift\_compression\_enable | +|:---:|:---| +|Description| Whether enable thrift's compression (using GZIP).| +|Type|Boolean| +|Default| false | +|Effective|After restarting system| + +* cn\_rpc\_advanced\_compression\_enable + +|Name| cn\_rpc\_advanced\_compression\_enable | +|:---:|:---| +|Description| Whether enable thrift's advanced compression.| +|Type|Boolean| +|Default| false | +|Effective|After restarting system| + +* cn\_rpc\_max\_concurrent\_client\_num + +|Name| cn\_rpc\_max\_concurrent\_client\_num | +|:---:|:--------------------------------------| +|Description| Max concurrent rpc connections | +|Type| int | +|Description| 3000 | +|Effective| After restarting system | + +* cn\_thrift\_max\_frame\_size + +|Name| cn\_thrift\_max\_frame\_size | +|:---:|:---| +|Description| Max size of bytes of each thrift RPC request/response| +|Type| Long | +|Unit|Byte| +|Default| 536870912 | +|Effective|After restarting system| + +* cn\_thrift\_init\_buffer\_size + +|Name| cn\_thrift\_init\_buffer\_size | +|:---:|:---| +|Description| Initial size of bytes of buffer that thrift used | +|Type| long | +|Default| 1024 | +|Effective|After restarting system| + +* cn\_connection\_timeout\_ms + +| Name | cn\_connection\_timeout\_ms | +|:-----------:|:-------------------------------------------------------| +| Description | Thrift socket and connection timeout between nodes | +| Type | int | +| Default | 60000 | +| Effective | After restarting system | + +* cn\_selector\_thread\_nums\_of\_client\_manager + +| Name | cn\_selector\_thread\_nums\_of\_client\_manager | +|:-----------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | +| Type | int | +| Default | 1
The default value is changed to 0 starting from V2.0.10-beta. If the value is less than or equal to 0, it will be automatically calculated as `max(1, number of CPU cores / 4)`. | +| Effective | After restarting system | + +* cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager + +| Name | cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager | +|:------------:|:---------------------------------------------------------------| +| Description | Number of core clients routed to each node in a ClientManager | +| Type | int | +| Default | 200 | +| Effective | After restarting system | + +* cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager + +| Name | cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager | +|:--------------:|:-------------------------------------------------------------| +| Description | Number of max clients routed to each node in a ClientManager | +| Type | int | +| Default | 300 | +| Effective | After restarting system | + +- cn_max_idle_client_count_for_each_node_in_client_manager + +| Name | cn_max_idle_client_count_for_each_node_in_client_manager | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10-beta. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + +### 2.6 Metric Configuration + +* cn\_metric\_reporter\_list + +| Name | cn\_metric\_reporter\_list | +|:-----------:|:--------------------------------------| +| Description | Systems for reporting ConfigNode metrics. | +| Type | String | +| Default | None | +| Effective | After restarting system | + +* cn\_metric\_level + +| Name | cn\_metric\_level | +|:-----------:|:------------------------------------| +| Description | Level of detail for ConfigNode metrics. | +| Type | String | +| Default | IMPORTANT | +| Effective | After restarting system | + +* cn\_metric\_async\_collect\_period + +| Name | cn\_metric\_async\_collect\_period | +|:-----------:|:------------------------------------------------------------| +| Description | Period for asynchronous metric collection in ConfigNode (in seconds). | +| Type | int | +| Default | 5 | +| Effective | After restarting system | + +* cn\_metric\_prometheus\_reporter\_port + +| Name | cn\_metric\_prometheus\_reporter\_port | +|:-----------:|:------------------------------------------| +| Description | Port for Prometheus metric reporting in ConfigNode. | +| Type | int | +| Default | 9091 | +| Effective | After restarting system | diff --git a/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual_timecho.md b/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual_timecho.md new file mode 100644 index 000000000..4294b2e34 --- /dev/null +++ b/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual_timecho.md @@ -0,0 +1,269 @@ + + +# ConfigNode Config Manual + +IoTDB ConfigNode files are under `conf`. + +* `confignode-env.sh/bat`：Environment configurations, in which we could set the memory allocation of ConfigNode. + +* `iotdb-system.properties`：IoTDB system configurations. + +## 1. Environment Configuration File（confignode-env.sh/bat） + +The environment configuration file is mainly used to configure the Java environment related parameters when ConfigNode is running, such as JVM related configuration. This part of the configuration is passed to the JVM when the ConfigNode starts. + +The details of each parameter are as follows: + +* MEMORY\_SIZE + +|Name|MEMORY\_SIZE| +|:---:|:---| +|Description|The memory size that IoTDB ConfigNode will use when startup | +|Type|String| +|Default|The default is three-tenths of the memory, with a maximum of 16G.| +|Effective|After restarting system| + +* ON\_HEAP\_MEMORY + +|Name|ON\_HEAP\_MEMORY| +|:---:|:---| +|Description|The heap memory size that IoTDB ConfigNode can use, Former Name: MAX\_HEAP\_SIZE | +|Type|String| +|Default| Calculate based on MEMORY\_SIZE.| +|Effective|After restarting system| + +* OFF\_HEAP\_MEMORY + +|Name|OFF\_HEAP\_MEMORY| +|:---:|:---| +|Description|The direct memory that IoTDB ConfigNode can use, Former Name: MAX\_DIRECT\_MEMORY\_SIZE | +|Type|String| +|Default| Calculate based on MEMORY\_SIZE.| +|Effective|After restarting system| + + +## 2. ConfigNode Configuration File (iotdb-system.properties) + +The global configuration of cluster is in ConfigNode. + +### 2.1 Config Node RPC Configuration + +* cn\_internal\_address + +| Name | cn\_internal\_address | +|:-----------:|:------------------------------------| +| Description | ConfigNode internal service address | +| Type | String | +| Default | 127.0.0.1 | +| Effective | Only allowed to be modified in first start up | + +* cn\_internal\_port + +|Name| cn\_internal\_port | +|:---:|:---| +|Description| ConfigNode internal service port| +|Type| Short Int : [0,65535] | +|Default| 10710 | +|Effective|Only allowed to be modified in first start up| + +### 2.2 Consensus + +* cn\_consensus\_port + +|Name| cn\_consensus\_port | +|:---:|:---| +|Description| ConfigNode data Consensus Port | +|Type| Short Int : [0,65535] | +|Default| 10720 | +|Effective|Only allowed to be modified in first start up| + +### 2.3 SeedConfigNode + +* cn\_seed\_config\_node + +|Name| cn\_seed\_config\_node | +|:---:|:----------------------------------------------------------------------| +|Description| Seed ConfigNode's address for current ConfigNode to join the cluster. This parameter is corresponding to cn\_target\_config\_node\_list before V1.2.2 | +|Type| String | +|Default| 127.0.0.1:10710 | +|Effective| Only allowed to be modified in first start up | + +### 2.4 Directory configuration + +* cn\_system\_dir + +|Name| cn\_system\_dir | +|:---:|:---| +|Description| ConfigNode system data dir | +|Type| String | +|Default| data/system（Windows：data\\system） | +|Effective|After restarting system| + +* cn\_consensus\_dir + +|Name| cn\_consensus\_dir | +|:---:|:---------------------------------------------------------------| +|Description| ConfigNode Consensus protocol data dir | +|Type| String | +|Default| data/confignode/consensus（Windows：data\\confignode\\consensus） | +|Effective| After restarting system | + +### 2.5 Thrift RPC configuration + +* cn\_rpc\_thrift\_compression\_enable + +|Name| cn\_rpc\_thrift\_compression\_enable | +|:---:|:---| +|Description| Whether enable thrift's compression (using GZIP).| +|Type|Boolean| +|Default| false | +|Effective|After restarting system| + +* cn\_rpc\_thrift\_compression\_enable + +|Name| cn\_rpc\_thrift\_compression\_enable | +|:---:|:---| +|Description| Whether enable thrift's compression (using GZIP).| +|Type|Boolean| +|Default| false | +|Effective|After restarting system| + +* cn\_rpc\_advanced\_compression\_enable + +|Name| cn\_rpc\_advanced\_compression\_enable | +|:---:|:---| +|Description| Whether enable thrift's advanced compression.| +|Type|Boolean| +|Default| false | +|Effective|After restarting system| + +* cn\_rpc\_max\_concurrent\_client\_num + +|Name| cn\_rpc\_max\_concurrent\_client\_num | +|:---:|:--------------------------------------| +|Description| Max concurrent rpc connections | +|Type| int | +|Description| 3000 | +|Effective| After restarting system | + +* cn\_thrift\_max\_frame\_size + +|Name| cn\_thrift\_max\_frame\_size | +|:---:|:---| +|Description| Max size of bytes of each thrift RPC request/response| +|Type| Long | +|Unit|Byte| +|Default| 536870912 | +|Effective|After restarting system| + +* cn\_thrift\_init\_buffer\_size + +|Name| cn\_thrift\_init\_buffer\_size | +|:---:|:---| +|Description| Initial size of bytes of buffer that thrift used | +|Type| long | +|Default| 1024 | +|Effective|After restarting system| + +* cn\_connection\_timeout\_ms + +| Name | cn\_connection\_timeout\_ms | +|:-----------:|:-------------------------------------------------------| +| Description | Thrift socket and connection timeout between nodes | +| Type | int | +| Default | 60000 | +| Effective | After restarting system | + +* cn\_selector\_thread\_nums\_of\_client\_manager + +| Name | cn\_selector\_thread\_nums\_of\_client\_manager | +|:-----------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | +| Type | int | +| Default | 1
The default value is changed to 0 starting from V2.0.10.1. If the value is less than or equal to 0, it will be automatically calculated as `max(1, number of CPU cores / 4)`. | +| Effective | After restarting system | + +* cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager + +| Name | cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager | +|:------------:|:---------------------------------------------------------------| +| Description | Number of core clients routed to each node in a ClientManager | +| Type | int | +| Default | 200 | +| Effective | After restarting system | + +* cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager + +| Name | cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager | +|:--------------:|:-------------------------------------------------------------| +| Description | Number of max clients routed to each node in a ClientManager | +| Type | int | +| Default | 300 | +| Effective | After restarting system | + +- cn_max_idle_client_count_for_each_node_in_client_manager + +| Name | cn_max_idle_client_count_for_each_node_in_client_manager | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10.1. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + +### 2.6 Metric Configuration + +* cn\_metric\_reporter\_list + +| Name | cn\_metric\_reporter\_list | +|:-----------:|:--------------------------------------| +| Description | Systems for reporting ConfigNode metrics. | +| Type | String | +| Default | None | +| Effective | After restarting system | + +* cn\_metric\_level + +| Name | cn\_metric\_level | +|:-----------:|:------------------------------------| +| Description | Level of detail for ConfigNode metrics. | +| Type | String | +| Default | IMPORTANT | +| Effective | After restarting system | + +* cn\_metric\_async\_collect\_period + +| Name | cn\_metric\_async\_collect\_period | +|:-----------:|:------------------------------------------------------------| +| Description | Period for asynchronous metric collection in ConfigNode (in seconds). | +| Type | int | +| Default | 5 | +| Effective | After restarting system | + +* cn\_metric\_prometheus\_reporter\_port + +| Name | cn\_metric\_prometheus\_reporter\_port | +|:-----------:|:------------------------------------------| +| Description | Port for Prometheus metric reporting in ConfigNode. | +| Type | int | +| Default | 9091 | +| Effective | After restarting system | diff --git a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md index fc65cf4d0..327ef7642 100644 --- a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md +++ b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md @@ -251,7 +251,7 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access. |Name| dn\_rpc\_selector\_thread\_count | |:---:|:-----------------------------------| -|Description| The number of rpc selector thread. | +|Description| The number of rpc selector thread. This parameter is deprecated starting from V2.0.10-beta.| |Type| int | |Default| false | |Effective| After restarting system | @@ -319,6 +319,17 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access. | Default | 300 | | Effective | After restarting system | + +- dn_max_idle_client_count_for_each_node_in_client_manager + +| Name | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10-beta. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + ### 4.5 Dictionary Configuration * dn\_system\_dir diff --git a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md index f3f5f4f75..680e11635 100644 --- a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md +++ b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md @@ -249,12 +249,12 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access. * dn\_rpc\_selector\_thread\_count -|Name| dn\_rpc\_selector\_thread\_count | -|:---:|:-----------------------------------| -|Description| The number of rpc selector thread. | -|Type| int | -|Default| false | -|Effective| After restarting system | +|Name| dn\_rpc\_selector\_thread\_count | +|:---:|:-----------------------------------------------------------------------------------------| +|Description| The number of rpc selector thread. This parameter is deprecated starting from V2.0.10.1. | +|Type| int | +|Default| false | +|Effective| After restarting system | * dn\_rpc\_min\_concurrent\_client\_num @@ -319,6 +319,17 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access. | Default | 300 | | Effective | After restarting system | + +- dn_max_idle_client_count_for_each_node_in_client_manager + +| Name | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10.1. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + ### 4.5 Dictionary Configuration * dn\_system\_dir diff --git a/src/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md b/src/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md index d5a7bc7e4..0a3c7a1cb 100644 --- a/src/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md +++ b/src/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md @@ -590,12 +590,12 @@ The `iotdb-system.properties` file contains various configurations for managing - cn_selector_thread_nums_of_client_manager -| Name | cn_selector_thread_nums_of_client_manager | -| ----------- | ------------------------------------------------------------ | -| Description | Number of selector threads for client management in ConfigNode. | -| Type | int | -| Default | 1 | -| Effective | Restart required. | +| Name | cn_selector_thread_nums_of_client_manager | +| ----------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | Number of selector threads for client management in ConfigNode. | +| Type | int | +| Default | 1
The default value is changed to 0 starting from V2.0.10-beta. If the value is less than or equal to 0, it will be automatically calculated as `max(1, number of CPU cores / 4)`. | +| Effective | Restart required. | - cn_max_client_count_for_each_node_in_client_manager @@ -606,6 +606,16 @@ The `iotdb-system.properties` file contains various configurations for managing | Default | 300 | | Effective | Restart required. | +- cn_max_idle_client_count_for_each_node_in_client_manager + +| Name | cn_max_idle_client_count_for_each_node_in_client_manager | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10-beta. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + - dn_session_timeout_threshold | Name | dn_session_timeout_threshold | @@ -635,12 +645,12 @@ The `iotdb-system.properties` file contains various configurations for managing - dn_rpc_selector_thread_count -| Name | rpc_selector_thread_count | -| ----------- | -------------------------------------------- | -| Description | Number of selector threads for DataNode RPC. | -| Type | int | -| Default | 1 | -| Effective | Restart required.t required. | +| Name | rpc_selector_thread_count | +| ----------- |-------------------------------------------------------------------------------------------------------| +| Description | Number of selector threads for DataNode RPC. This parameter is deprecated starting from V2.0.10-beta. | +| Type | int | +| Default | 1 | +| Effective | Restart required.t required. | - dn_rpc_min_concurrent_client_num @@ -689,12 +699,12 @@ The `iotdb-system.properties` file contains various configurations for managing - dn_selector_thread_count_of_client_manager -| Name | dn_selector_thread_count_of_client_manager | -| ----------- | ------------------------------------------------------------ | -| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | -| Type | int | -| Default | 1 | -| Effective | Restart required.t required. | +| Name | dn_selector_thread_nums_of_client_manager
Prior to V2.0.10-beta, the parameter name was dn_selector_thread_count_of_client_manager. | +| ----------- |------------------------------------------------------------------------------------------------------------------------------------------| +| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | +| Type | int | +| Default | 1
The default value is changed to 0 starting from V2.0.10-beta. If the value is less than or equal to 0, it will be automatically calculated as `max(1, number of CPU cores / 4)`. | +| Effective | Restart required.t required. | - dn_max_client_count_for_each_node_in_client_manager @@ -705,6 +715,18 @@ The `iotdb-system.properties` file contains various configurations for managing | Default | 300 | | Effective | Restart required. | + +- dn_max_idle_client_count_for_each_node_in_client_manager + +| Name | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10-beta. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + + ### 4.9 Object storage management - remote_tsfile_cache_dirs diff --git a/src/UserGuide/latest-Table/Reference/System-Config-Manual_timecho.md b/src/UserGuide/latest-Table/Reference/System-Config-Manual_timecho.md index f96a33713..cf8a79090 100644 --- a/src/UserGuide/latest-Table/Reference/System-Config-Manual_timecho.md +++ b/src/UserGuide/latest-Table/Reference/System-Config-Manual_timecho.md @@ -591,12 +591,12 @@ The `iotdb-system.properties` file contains various configurations for managing - cn_selector_thread_nums_of_client_manager -| Name | cn_selector_thread_nums_of_client_manager | -| ----------- | ------------------------------------------------------------ | -| Description | Number of selector threads for client management in ConfigNode. | -| Type | int | -| Default | 1 | -| Effective | Restart required. | +| Name | cn_selector_thread_nums_of_client_manager | +| ----------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | Number of selector threads for client management in ConfigNode. | +| Type | int | +| Default | 1
The default value is changed to 0 starting from V2.0.10.1. If the value is less than or equal to 0, it will be automatically calculated as `max(1, number of CPU cores / 4)`. | +| Effective | Restart required. | - cn_max_client_count_for_each_node_in_client_manager @@ -607,6 +607,15 @@ The `iotdb-system.properties` file contains various configurations for managing | Default | 300 | | Effective | Restart required. | +- cn_max_idle_client_count_for_each_node_in_client_manager + +| Name | cn_max_idle_client_count_for_each_node_in_client_manager | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10.1. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + - dn_session_timeout_threshold | Name | dn_session_timeout_threshold | @@ -636,12 +645,12 @@ The `iotdb-system.properties` file contains various configurations for managing - dn_rpc_selector_thread_count -| Name | rpc_selector_thread_count | -| ----------- | -------------------------------------------- | -| Description | Number of selector threads for DataNode RPC. | -| Type | int | -| Default | 1 | -| Effective | Restart required.t required. | +| Name | rpc_selector_thread_count | +| ----------- |----------------------------------------------------------------------------------------------------| +| Description | Number of selector threads for DataNode RPC. This parameter is deprecated starting from V2.0.10.1. | +| Type | int | +| Default | 1 | +| Effective | Restart required.t required. | - dn_rpc_min_concurrent_client_num @@ -688,14 +697,14 @@ The `iotdb-system.properties` file contains various configurations for managing | Default | 60000 | | Effective | Restart required. | -- dn_selector_thread_count_of_client_manager +- dn_selector_thread_nums_of_client_manager -| Name | dn_selector_thread_count_of_client_manager | -| ----------- | ------------------------------------------------------------ | -| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | -| Type | int | -| Default | 1 | -| Effective | Restart required.t required. | +| Name | dn_selector_thread_nums_of_client_manager
Prior to V2.0.10.1, the parameter name was dn_selector_thread_count_of_client_manager. | +| ----------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | +| Type | int | +| Default | 1
The default value is changed to 0 starting from V2.0.10.1. If the value is less than or equal to 0, it will be automatically calculated as `max(1, number of CPU cores / 4)`. | +| Effective | Restart required.t required. | - dn_max_client_count_for_each_node_in_client_manager @@ -706,6 +715,17 @@ The `iotdb-system.properties` file contains various configurations for managing | Default | 300 | | Effective | Restart required. | + +- dn_max_idle_client_count_for_each_node_in_client_manager + +| Name | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10.1. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + ### 4.9 Object storage management - remote_tsfile_cache_dirs diff --git a/src/UserGuide/latest/Reference/ConfigNode-Config-Manual.md b/src/UserGuide/latest/Reference/ConfigNode-Config-Manual.md index 9f3559bc0..09efb16f6 100644 --- a/src/UserGuide/latest/Reference/ConfigNode-Config-Manual.md +++ b/src/UserGuide/latest/Reference/ConfigNode-Config-Manual.md @@ -1,3 +1,6 @@ +--- +redirectTo: ConfigNode-Config-Manual_apache.html +--- - -# ConfigNode Config Manual - -IoTDB ConfigNode files are under `conf`. - -* `confignode-env.sh/bat`：Environment configurations, in which we could set the memory allocation of ConfigNode. - -* `iotdb-system.properties`：IoTDB system configurations. - -## 1. Environment Configuration File（confignode-env.sh/bat） - -The environment configuration file is mainly used to configure the Java environment related parameters when ConfigNode is running, such as JVM related configuration. This part of the configuration is passed to the JVM when the ConfigNode starts. - -The details of each parameter are as follows: - -* MEMORY\_SIZE - -|Name|MEMORY\_SIZE| -|:---:|:---| -|Description|The memory size that IoTDB ConfigNode will use when startup | -|Type|String| -|Default|The default is three-tenths of the memory, with a maximum of 16G.| -|Effective|After restarting system| - -* ON\_HEAP\_MEMORY - -|Name|ON\_HEAP\_MEMORY| -|:---:|:---| -|Description|The heap memory size that IoTDB ConfigNode can use, Former Name: MAX\_HEAP\_SIZE | -|Type|String| -|Default| Calculate based on MEMORY\_SIZE.| -|Effective|After restarting system| - -* OFF\_HEAP\_MEMORY - -|Name|OFF\_HEAP\_MEMORY| -|:---:|:---| -|Description|The direct memory that IoTDB ConfigNode can use, Former Name: MAX\_DIRECT\_MEMORY\_SIZE | -|Type|String| -|Default| Calculate based on MEMORY\_SIZE.| -|Effective|After restarting system| - - -## 2. ConfigNode Configuration File (iotdb-system.properties) - -The global configuration of cluster is in ConfigNode. - -### 2.1 Config Node RPC Configuration - -* cn\_internal\_address - -| Name | cn\_internal\_address | -|:-----------:|:------------------------------------| -| Description | ConfigNode internal service address | -| Type | String | -| Default | 127.0.0.1 | -| Effective | Only allowed to be modified in first start up | - -* cn\_internal\_port - -|Name| cn\_internal\_port | -|:---:|:---| -|Description| ConfigNode internal service port| -|Type| Short Int : [0,65535] | -|Default| 10710 | -|Effective|Only allowed to be modified in first start up| - -### 2.2 Consensus - -* cn\_consensus\_port - -|Name| cn\_consensus\_port | -|:---:|:---| -|Description| ConfigNode data Consensus Port | -|Type| Short Int : [0,65535] | -|Default| 10720 | -|Effective|Only allowed to be modified in first start up| - -### 2.3 SeedConfigNode - -* cn\_seed\_config\_node - -|Name| cn\_seed\_config\_node | -|:---:|:----------------------------------------------------------------------| -|Description| Seed ConfigNode's address for current ConfigNode to join the cluster. This parameter is corresponding to cn\_target\_config\_node\_list before V1.2.2 | -|Type| String | -|Default| 127.0.0.1:10710 | -|Effective| Only allowed to be modified in first start up | - -### 2.4 Directory configuration - -* cn\_system\_dir - -|Name| cn\_system\_dir | -|:---:|:---| -|Description| ConfigNode system data dir | -|Type| String | -|Default| data/system（Windows：data\\system） | -|Effective|After restarting system| - -* cn\_consensus\_dir - -|Name| cn\_consensus\_dir | -|:---:|:---------------------------------------------------------------| -|Description| ConfigNode Consensus protocol data dir | -|Type| String | -|Default| data/confignode/consensus（Windows：data\\confignode\\consensus） | -|Effective| After restarting system | - -### 2.5 Thrift RPC configuration - -* cn\_rpc\_thrift\_compression\_enable - -|Name| cn\_rpc\_thrift\_compression\_enable | -|:---:|:---| -|Description| Whether enable thrift's compression (using GZIP).| -|Type|Boolean| -|Default| false | -|Effective|After restarting system| - -* cn\_rpc\_thrift\_compression\_enable - -|Name| cn\_rpc\_thrift\_compression\_enable | -|:---:|:---| -|Description| Whether enable thrift's compression (using GZIP).| -|Type|Boolean| -|Default| false | -|Effective|After restarting system| - -* cn\_rpc\_advanced\_compression\_enable - -|Name| cn\_rpc\_advanced\_compression\_enable | -|:---:|:---| -|Description| Whether enable thrift's advanced compression.| -|Type|Boolean| -|Default| false | -|Effective|After restarting system| - -* cn\_rpc\_max\_concurrent\_client\_num - -|Name| cn\_rpc\_max\_concurrent\_client\_num | -|:---:|:--------------------------------------| -|Description| Max concurrent rpc connections | -|Type| int | -|Description| 3000 | -|Effective| After restarting system | - -* cn\_thrift\_max\_frame\_size - -|Name| cn\_thrift\_max\_frame\_size | -|:---:|:---| -|Description| Max size of bytes of each thrift RPC request/response| -|Type| Long | -|Unit|Byte| -|Default| 536870912 | -|Effective|After restarting system| - -* cn\_thrift\_init\_buffer\_size - -|Name| cn\_thrift\_init\_buffer\_size | -|:---:|:---| -|Description| Initial size of bytes of buffer that thrift used | -|Type| long | -|Default| 1024 | -|Effective|After restarting system| - -* cn\_connection\_timeout\_ms - -| Name | cn\_connection\_timeout\_ms | -|:-----------:|:-------------------------------------------------------| -| Description | Thrift socket and connection timeout between nodes | -| Type | int | -| Default | 60000 | -| Effective | After restarting system | - -* cn\_selector\_thread\_nums\_of\_client\_manager - -| Name | cn\_selector\_thread\_nums\_of\_client\_manager | -|:-----------:|:-------------------------------------------------------------------------------| -| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | -| Type | int | -| Default | 1 | -| Effective | After restarting system | - -* cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager - -| Name | cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager | -|:------------:|:---------------------------------------------------------------| -| Description | Number of core clients routed to each node in a ClientManager | -| Type | int | -| Default | 200 | -| Effective | After restarting system | - -* cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager - -| Name | cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager | -|:--------------:|:-------------------------------------------------------------| -| Description | Number of max clients routed to each node in a ClientManager | -| Type | int | -| Default | 300 | -| Effective | After restarting system | - -### 2.6 Metric Configuration - -* cn\_metric\_reporter\_list - -| Name | cn\_metric\_reporter\_list | -|:-----------:|:--------------------------------------| -| Description | Systems for reporting ConfigNode metrics. | -| Type | String | -| Default | None | -| Effective | After restarting system | - -* cn\_metric\_level - -| Name | cn\_metric\_level | -|:-----------:|:------------------------------------| -| Description | Level of detail for ConfigNode metrics. | -| Type | String | -| Default | IMPORTANT | -| Effective | After restarting system | - -* cn\_metric\_async\_collect\_period - -| Name | cn\_metric\_async\_collect\_period | -|:-----------:|:------------------------------------------------------------| -| Description | Period for asynchronous metric collection in ConfigNode (in seconds). | -| Type | int | -| Default | 5 | -| Effective | After restarting system | - -* cn\_metric\_prometheus\_reporter\_port - -| Name | cn\_metric\_prometheus\_reporter\_port | -|:-----------:|:------------------------------------------| -| Description | Port for Prometheus metric reporting in ConfigNode. | -| Type | int | -| Default | 9091 | -| Effective | After restarting system | diff --git a/src/UserGuide/latest/Reference/ConfigNode-Config-Manual_apache.md b/src/UserGuide/latest/Reference/ConfigNode-Config-Manual_apache.md new file mode 100644 index 000000000..0c72cd78c --- /dev/null +++ b/src/UserGuide/latest/Reference/ConfigNode-Config-Manual_apache.md @@ -0,0 +1,269 @@ + + +# ConfigNode Config Manual + +IoTDB ConfigNode files are under `conf`. + +* `confignode-env.sh/bat`：Environment configurations, in which we could set the memory allocation of ConfigNode. + +* `iotdb-system.properties`：IoTDB system configurations. + +## 1. Environment Configuration File（confignode-env.sh/bat） + +The environment configuration file is mainly used to configure the Java environment related parameters when ConfigNode is running, such as JVM related configuration. This part of the configuration is passed to the JVM when the ConfigNode starts. + +The details of each parameter are as follows: + +* MEMORY\_SIZE + +|Name|MEMORY\_SIZE| +|:---:|:---| +|Description|The memory size that IoTDB ConfigNode will use when startup | +|Type|String| +|Default|The default is three-tenths of the memory, with a maximum of 16G.| +|Effective|After restarting system| + +* ON\_HEAP\_MEMORY + +|Name|ON\_HEAP\_MEMORY| +|:---:|:---| +|Description|The heap memory size that IoTDB ConfigNode can use, Former Name: MAX\_HEAP\_SIZE | +|Type|String| +|Default| Calculate based on MEMORY\_SIZE.| +|Effective|After restarting system| + +* OFF\_HEAP\_MEMORY + +|Name|OFF\_HEAP\_MEMORY| +|:---:|:---| +|Description|The direct memory that IoTDB ConfigNode can use, Former Name: MAX\_DIRECT\_MEMORY\_SIZE | +|Type|String| +|Default| Calculate based on MEMORY\_SIZE.| +|Effective|After restarting system| + + +## 2. ConfigNode Configuration File (iotdb-system.properties) + +The global configuration of cluster is in ConfigNode. + +### 2.1 Config Node RPC Configuration + +* cn\_internal\_address + +| Name | cn\_internal\_address | +|:-----------:|:------------------------------------| +| Description | ConfigNode internal service address | +| Type | String | +| Default | 127.0.0.1 | +| Effective | Only allowed to be modified in first start up | + +* cn\_internal\_port + +|Name| cn\_internal\_port | +|:---:|:---| +|Description| ConfigNode internal service port| +|Type| Short Int : [0,65535] | +|Default| 10710 | +|Effective|Only allowed to be modified in first start up| + +### 2.2 Consensus + +* cn\_consensus\_port + +|Name| cn\_consensus\_port | +|:---:|:---| +|Description| ConfigNode data Consensus Port | +|Type| Short Int : [0,65535] | +|Default| 10720 | +|Effective|Only allowed to be modified in first start up| + +### 2.3 SeedConfigNode + +* cn\_seed\_config\_node + +|Name| cn\_seed\_config\_node | +|:---:|:----------------------------------------------------------------------| +|Description| Seed ConfigNode's address for current ConfigNode to join the cluster. This parameter is corresponding to cn\_target\_config\_node\_list before V1.2.2 | +|Type| String | +|Default| 127.0.0.1:10710 | +|Effective| Only allowed to be modified in first start up | + +### 2.4 Directory configuration + +* cn\_system\_dir + +|Name| cn\_system\_dir | +|:---:|:---| +|Description| ConfigNode system data dir | +|Type| String | +|Default| data/system（Windows：data\\system） | +|Effective|After restarting system| + +* cn\_consensus\_dir + +|Name| cn\_consensus\_dir | +|:---:|:---------------------------------------------------------------| +|Description| ConfigNode Consensus protocol data dir | +|Type| String | +|Default| data/confignode/consensus（Windows：data\\confignode\\consensus） | +|Effective| After restarting system | + +### 2.5 Thrift RPC configuration + +* cn\_rpc\_thrift\_compression\_enable + +|Name| cn\_rpc\_thrift\_compression\_enable | +|:---:|:---| +|Description| Whether enable thrift's compression (using GZIP).| +|Type|Boolean| +|Default| false | +|Effective|After restarting system| + +* cn\_rpc\_thrift\_compression\_enable + +|Name| cn\_rpc\_thrift\_compression\_enable | +|:---:|:---| +|Description| Whether enable thrift's compression (using GZIP).| +|Type|Boolean| +|Default| false | +|Effective|After restarting system| + +* cn\_rpc\_advanced\_compression\_enable + +|Name| cn\_rpc\_advanced\_compression\_enable | +|:---:|:---| +|Description| Whether enable thrift's advanced compression.| +|Type|Boolean| +|Default| false | +|Effective|After restarting system| + +* cn\_rpc\_max\_concurrent\_client\_num + +|Name| cn\_rpc\_max\_concurrent\_client\_num | +|:---:|:--------------------------------------| +|Description| Max concurrent rpc connections | +|Type| int | +|Description| 3000 | +|Effective| After restarting system | + +* cn\_thrift\_max\_frame\_size + +|Name| cn\_thrift\_max\_frame\_size | +|:---:|:---| +|Description| Max size of bytes of each thrift RPC request/response| +|Type| Long | +|Unit|Byte| +|Default| 536870912 | +|Effective|After restarting system| + +* cn\_thrift\_init\_buffer\_size + +|Name| cn\_thrift\_init\_buffer\_size | +|:---:|:---| +|Description| Initial size of bytes of buffer that thrift used | +|Type| long | +|Default| 1024 | +|Effective|After restarting system| + +* cn\_connection\_timeout\_ms + +| Name | cn\_connection\_timeout\_ms | +|:-----------:|:-------------------------------------------------------| +| Description | Thrift socket and connection timeout between nodes | +| Type | int | +| Default | 60000 | +| Effective | After restarting system | + +* cn\_selector\_thread\_nums\_of\_client\_manager + +| Name | cn\_selector\_thread\_nums\_of\_client\_manager | +|:-----------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | +| Type | int | +| Default | 1
The default value is changed to 0 starting from V2.0.10-beta. If the value is less than or equal to 0, it will be automatically calculated as `max(1, number of CPU cores / 4)`. | +| Effective | After restarting system | + +* cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager + +| Name | cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager | +|:------------:|:---------------------------------------------------------------| +| Description | Number of core clients routed to each node in a ClientManager | +| Type | int | +| Default | 200 | +| Effective | After restarting system | + +* cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager + +| Name | cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager | +|:--------------:|:-------------------------------------------------------------| +| Description | Number of max clients routed to each node in a ClientManager | +| Type | int | +| Default | 300 | +| Effective | After restarting system | + +- cn_max_idle_client_count_for_each_node_in_client_manager + +| Name | cn_max_idle_client_count_for_each_node_in_client_manager | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10-beta. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + +### 2.6 Metric Configuration + +* cn\_metric\_reporter\_list + +| Name | cn\_metric\_reporter\_list | +|:-----------:|:--------------------------------------| +| Description | Systems for reporting ConfigNode metrics. | +| Type | String | +| Default | None | +| Effective | After restarting system | + +* cn\_metric\_level + +| Name | cn\_metric\_level | +|:-----------:|:------------------------------------| +| Description | Level of detail for ConfigNode metrics. | +| Type | String | +| Default | IMPORTANT | +| Effective | After restarting system | + +* cn\_metric\_async\_collect\_period + +| Name | cn\_metric\_async\_collect\_period | +|:-----------:|:------------------------------------------------------------| +| Description | Period for asynchronous metric collection in ConfigNode (in seconds). | +| Type | int | +| Default | 5 | +| Effective | After restarting system | + +* cn\_metric\_prometheus\_reporter\_port + +| Name | cn\_metric\_prometheus\_reporter\_port | +|:-----------:|:------------------------------------------| +| Description | Port for Prometheus metric reporting in ConfigNode. | +| Type | int | +| Default | 9091 | +| Effective | After restarting system | diff --git a/src/UserGuide/latest/Reference/ConfigNode-Config-Manual_timecho.md b/src/UserGuide/latest/Reference/ConfigNode-Config-Manual_timecho.md new file mode 100644 index 000000000..4294b2e34 --- /dev/null +++ b/src/UserGuide/latest/Reference/ConfigNode-Config-Manual_timecho.md @@ -0,0 +1,269 @@ + + +# ConfigNode Config Manual + +IoTDB ConfigNode files are under `conf`. + +* `confignode-env.sh/bat`：Environment configurations, in which we could set the memory allocation of ConfigNode. + +* `iotdb-system.properties`：IoTDB system configurations. + +## 1. Environment Configuration File（confignode-env.sh/bat） + +The environment configuration file is mainly used to configure the Java environment related parameters when ConfigNode is running, such as JVM related configuration. This part of the configuration is passed to the JVM when the ConfigNode starts. + +The details of each parameter are as follows: + +* MEMORY\_SIZE + +|Name|MEMORY\_SIZE| +|:---:|:---| +|Description|The memory size that IoTDB ConfigNode will use when startup | +|Type|String| +|Default|The default is three-tenths of the memory, with a maximum of 16G.| +|Effective|After restarting system| + +* ON\_HEAP\_MEMORY + +|Name|ON\_HEAP\_MEMORY| +|:---:|:---| +|Description|The heap memory size that IoTDB ConfigNode can use, Former Name: MAX\_HEAP\_SIZE | +|Type|String| +|Default| Calculate based on MEMORY\_SIZE.| +|Effective|After restarting system| + +* OFF\_HEAP\_MEMORY + +|Name|OFF\_HEAP\_MEMORY| +|:---:|:---| +|Description|The direct memory that IoTDB ConfigNode can use, Former Name: MAX\_DIRECT\_MEMORY\_SIZE | +|Type|String| +|Default| Calculate based on MEMORY\_SIZE.| +|Effective|After restarting system| + + +## 2. ConfigNode Configuration File (iotdb-system.properties) + +The global configuration of cluster is in ConfigNode. + +### 2.1 Config Node RPC Configuration + +* cn\_internal\_address + +| Name | cn\_internal\_address | +|:-----------:|:------------------------------------| +| Description | ConfigNode internal service address | +| Type | String | +| Default | 127.0.0.1 | +| Effective | Only allowed to be modified in first start up | + +* cn\_internal\_port + +|Name| cn\_internal\_port | +|:---:|:---| +|Description| ConfigNode internal service port| +|Type| Short Int : [0,65535] | +|Default| 10710 | +|Effective|Only allowed to be modified in first start up| + +### 2.2 Consensus + +* cn\_consensus\_port + +|Name| cn\_consensus\_port | +|:---:|:---| +|Description| ConfigNode data Consensus Port | +|Type| Short Int : [0,65535] | +|Default| 10720 | +|Effective|Only allowed to be modified in first start up| + +### 2.3 SeedConfigNode + +* cn\_seed\_config\_node + +|Name| cn\_seed\_config\_node | +|:---:|:----------------------------------------------------------------------| +|Description| Seed ConfigNode's address for current ConfigNode to join the cluster. This parameter is corresponding to cn\_target\_config\_node\_list before V1.2.2 | +|Type| String | +|Default| 127.0.0.1:10710 | +|Effective| Only allowed to be modified in first start up | + +### 2.4 Directory configuration + +* cn\_system\_dir + +|Name| cn\_system\_dir | +|:---:|:---| +|Description| ConfigNode system data dir | +|Type| String | +|Default| data/system（Windows：data\\system） | +|Effective|After restarting system| + +* cn\_consensus\_dir + +|Name| cn\_consensus\_dir | +|:---:|:---------------------------------------------------------------| +|Description| ConfigNode Consensus protocol data dir | +|Type| String | +|Default| data/confignode/consensus（Windows：data\\confignode\\consensus） | +|Effective| After restarting system | + +### 2.5 Thrift RPC configuration + +* cn\_rpc\_thrift\_compression\_enable + +|Name| cn\_rpc\_thrift\_compression\_enable | +|:---:|:---| +|Description| Whether enable thrift's compression (using GZIP).| +|Type|Boolean| +|Default| false | +|Effective|After restarting system| + +* cn\_rpc\_thrift\_compression\_enable + +|Name| cn\_rpc\_thrift\_compression\_enable | +|:---:|:---| +|Description| Whether enable thrift's compression (using GZIP).| +|Type|Boolean| +|Default| false | +|Effective|After restarting system| + +* cn\_rpc\_advanced\_compression\_enable + +|Name| cn\_rpc\_advanced\_compression\_enable | +|:---:|:---| +|Description| Whether enable thrift's advanced compression.| +|Type|Boolean| +|Default| false | +|Effective|After restarting system| + +* cn\_rpc\_max\_concurrent\_client\_num + +|Name| cn\_rpc\_max\_concurrent\_client\_num | +|:---:|:--------------------------------------| +|Description| Max concurrent rpc connections | +|Type| int | +|Description| 3000 | +|Effective| After restarting system | + +* cn\_thrift\_max\_frame\_size + +|Name| cn\_thrift\_max\_frame\_size | +|:---:|:---| +|Description| Max size of bytes of each thrift RPC request/response| +|Type| Long | +|Unit|Byte| +|Default| 536870912 | +|Effective|After restarting system| + +* cn\_thrift\_init\_buffer\_size + +|Name| cn\_thrift\_init\_buffer\_size | +|:---:|:---| +|Description| Initial size of bytes of buffer that thrift used | +|Type| long | +|Default| 1024 | +|Effective|After restarting system| + +* cn\_connection\_timeout\_ms + +| Name | cn\_connection\_timeout\_ms | +|:-----------:|:-------------------------------------------------------| +| Description | Thrift socket and connection timeout between nodes | +| Type | int | +| Default | 60000 | +| Effective | After restarting system | + +* cn\_selector\_thread\_nums\_of\_client\_manager + +| Name | cn\_selector\_thread\_nums\_of\_client\_manager | +|:-----------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | selector thread (TAsyncClientManager) nums for async thread in a clientManager | +| Type | int | +| Default | 1
The default value is changed to 0 starting from V2.0.10.1. If the value is less than or equal to 0, it will be automatically calculated as `max(1, number of CPU cores / 4)`. | +| Effective | After restarting system | + +* cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager + +| Name | cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager | +|:------------:|:---------------------------------------------------------------| +| Description | Number of core clients routed to each node in a ClientManager | +| Type | int | +| Default | 200 | +| Effective | After restarting system | + +* cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager + +| Name | cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager | +|:--------------:|:-------------------------------------------------------------| +| Description | Number of max clients routed to each node in a ClientManager | +| Type | int | +| Default | 300 | +| Effective | After restarting system | + +- cn_max_idle_client_count_for_each_node_in_client_manager + +| Name | cn_max_idle_client_count_for_each_node_in_client_manager | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10.1. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + +### 2.6 Metric Configuration + +* cn\_metric\_reporter\_list + +| Name | cn\_metric\_reporter\_list | +|:-----------:|:--------------------------------------| +| Description | Systems for reporting ConfigNode metrics. | +| Type | String | +| Default | None | +| Effective | After restarting system | + +* cn\_metric\_level + +| Name | cn\_metric\_level | +|:-----------:|:------------------------------------| +| Description | Level of detail for ConfigNode metrics. | +| Type | String | +| Default | IMPORTANT | +| Effective | After restarting system | + +* cn\_metric\_async\_collect\_period + +| Name | cn\_metric\_async\_collect\_period | +|:-----------:|:------------------------------------------------------------| +| Description | Period for asynchronous metric collection in ConfigNode (in seconds). | +| Type | int | +| Default | 5 | +| Effective | After restarting system | + +* cn\_metric\_prometheus\_reporter\_port + +| Name | cn\_metric\_prometheus\_reporter\_port | +|:-----------:|:------------------------------------------| +| Description | Port for Prometheus metric reporting in ConfigNode. | +| Type | int | +| Default | 9091 | +| Effective | After restarting system | diff --git a/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md b/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md index fc65cf4d0..327ef7642 100644 --- a/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md +++ b/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md @@ -251,7 +251,7 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access. |Name| dn\_rpc\_selector\_thread\_count | |:---:|:-----------------------------------| -|Description| The number of rpc selector thread. | +|Description| The number of rpc selector thread. This parameter is deprecated starting from V2.0.10-beta.| |Type| int | |Default| false | |Effective| After restarting system | @@ -319,6 +319,17 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access. | Default | 300 | | Effective | After restarting system | + +- dn_max_idle_client_count_for_each_node_in_client_manager + +| Name | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10-beta. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + ### 4.5 Dictionary Configuration * dn\_system\_dir diff --git a/src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md b/src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md index f3f5f4f75..680e11635 100644 --- a/src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md +++ b/src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md @@ -249,12 +249,12 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access. * dn\_rpc\_selector\_thread\_count -|Name| dn\_rpc\_selector\_thread\_count | -|:---:|:-----------------------------------| -|Description| The number of rpc selector thread. | -|Type| int | -|Default| false | -|Effective| After restarting system | +|Name| dn\_rpc\_selector\_thread\_count | +|:---:|:-----------------------------------------------------------------------------------------| +|Description| The number of rpc selector thread. This parameter is deprecated starting from V2.0.10.1. | +|Type| int | +|Default| false | +|Effective| After restarting system | * dn\_rpc\_min\_concurrent\_client\_num @@ -319,6 +319,17 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access. | Default | 300 | | Effective | After restarting system | + +- dn_max_idle_client_count_for_each_node_in_client_manager + +| Name | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | The maximum number of idle clients that can be retained for a node in a clientManager. When the number of idle clients to a single node exceeds this number, excess idle clients will be evicted. Idle clients are determined by a time threshold (default 1 minute of inactivity). 0 means no idle clients will be retained, connections are destroyed immediately upon return. Supported from V2.0.10.1. | +| Type | int | +| Default | 1000 | +| Effective | Restart required. | + + ### 4.5 Dictionary Configuration * dn\_system\_dir diff --git a/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md b/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md index 0d3fb8866..e64c6a278 100644 --- a/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md +++ b/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md @@ -567,12 +567,12 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - cn_selector_thread_nums_of_client_manager -| 名字 | cn_selector_thread_nums_of_client_manager | -| ------------ | ----------------------------------------- | -| 描述 | 客户端异步线程管理的选择器线程数量 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 名字 | cn_selector_thread_nums_of_client_manager | +| ------------ |------------------------------------------------------------------| +| 描述 | 客户端异步线程管理的选择器线程数量 | +| 类型 | int | +| 默认值 | 1
V2.0.10-beta 版本起默认值为 0，当值 <= 0 时自动按 max(1, CPU 核数 / 4) 计算 | +| 改后生效方式 | 重启服务生效 | - cn_max_client_count_for_each_node_in_client_manager @@ -583,6 +583,17 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 默认值 | 300 | | 改后生效方式 | 重启服务生效 | + +- cn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | cn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |--------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10-beta 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + - dn_session_timeout_threshold | 名字 | dn_session_timeout_threshold | @@ -612,12 +623,12 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - dn_rpc_selector_thread_count -| 名字 | rpc_selector_thread_count | -| ------------ | ------------------------- | -| 描述 | rpc 选择器线程数量 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 名字 | rpc_selector_thread_count | +| ------------ |------------------------------------| +| 描述 | rpc 选择器线程数量，V2.0.10-beta 版本起该参数作废。 | +| 类型 | int | +| 默认值 | 1 | +| 改后生效方式 | 重启服务生效 | - dn_rpc_min_concurrent_client_num @@ -664,14 +675,14 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 默认值 | 60000 | | 改后生效方式 | 重启服务生效 | -- dn_selector_thread_count_of_client_manager +- dn_selector_thread_nums_of_client_manager -| 名字 | dn_selector_thread_count_of_client_manager | -| ------------ | ------------------------------------------------------------ | +| 名字 | dn_selector_thread_nums_of_client_manager
V2.0.10-beta 版本前参数名成为 dn_selector_thread_count_of_client_manager | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------| | 描述 | selector thread (TAsyncClientManager) nums for async thread in a clientManagerclientManager中异步线程的选择器线程（TAsyncClientManager）编号 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 类型 | int | +| 默认值 | 1
V2.0.10-beta 版本起默认值为 0，当值 <= 0 时自动按 max(1, CPU 核数 / 4) 计算 | +| 改后生效方式 | 重启服务生效 | - dn_max_client_count_for_each_node_in_client_manager @@ -682,6 +693,18 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 默认值 | 300 | | 改后生效方式 | 重启服务生效 | + +- dn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |----------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10-beta 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + + ### 3.9 对象存储管理 - remote_tsfile_cache_dirs diff --git a/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual_timecho.md b/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual_timecho.md index a7bffe3a7..204892fda 100644 --- a/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual_timecho.md +++ b/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual_timecho.md @@ -567,12 +567,12 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - cn_selector_thread_nums_of_client_manager -| 名字 | cn_selector_thread_nums_of_client_manager | -| ------------ | ----------------------------------------- | -| 描述 | 客户端异步线程管理的选择器线程数量 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 名字 | cn_selector_thread_nums_of_client_manager | +| ------------ |---------------------------------------------------------------| +| 描述 | 客户端异步线程管理的选择器线程数量 | +| 类型 | int | +| 默认值 | 1
V2.0.10.1 版本起默认值为 0，当值 <= 0 时自动按 max(1, CPU 核数 / 4) 计算 | +| 改后生效方式 | 重启服务生效 | - cn_max_client_count_for_each_node_in_client_manager @@ -583,6 +583,16 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 默认值 | 300 | | 改后生效方式 | 重启服务生效 | + +- cn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | cn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10.1 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + - dn_session_timeout_threshold | 名字 | dn_session_timeout_threshold | @@ -612,12 +622,12 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - dn_rpc_selector_thread_count -| 名字 | rpc_selector_thread_count | -| ------------ | ------------------------- | -| 描述 | rpc 选择器线程数量 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 名字 | rpc_selector_thread_count | +| ------------ |---------------------------------| +| 描述 | rpc 选择器线程数量，V2.0.10.1 版本起该参数作废。 | +| 类型 | int | +| 默认值 | 1 | +| 改后生效方式 | 重启服务生效 | - dn_rpc_min_concurrent_client_num @@ -664,14 +674,14 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 默认值 | 60000 | | 改后生效方式 | 重启服务生效 | -- dn_selector_thread_count_of_client_manager +- dn_selector_thread_nums_of_client_manager -| 名字 | dn_selector_thread_count_of_client_manager | -| ------------ | ------------------------------------------------------------ | +| 名字 | dn_selector_thread_nums_of_client_manager
V2.0.10.1 版本前参数名成为 dn_selector_thread_count_of_client_manager | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------| | 描述 | selector thread (TAsyncClientManager) nums for async thread in a clientManagerclientManager中异步线程的选择器线程（TAsyncClientManager）编号 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 类型 | int | +| 默认值 | 1
V2.0.10.1 版本起默认值为 0，当值 <= 0 时自动按 max(1, CPU 核数 / 4) 计算 | +| 改后生效方式 | 重启服务生效 | - dn_max_client_count_for_each_node_in_client_manager @@ -682,6 +692,17 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 默认值 | 300 | | 改后生效方式 | 重启服务生效 | + +- dn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |---------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10.1 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + ### 3.9 对象存储管理 - remote_tsfile_cache_dirs diff --git a/src/zh/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md b/src/zh/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md index cfd61c626..09efb16f6 100644 --- a/src/zh/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md +++ b/src/zh/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md @@ -1,3 +1,6 @@ +--- +redirectTo: ConfigNode-Config-Manual_apache.html +--- - -# ConfigNode 配置参数 - -IoTDB ConfigNode 配置文件均位于 IoTDB 安装目录：`conf`文件夹下。 - -* `confignode-env.sh/bat`：环境配置项的配置文件，可以配置 ConfigNode 的内存大小。 - -* `iotdb-system.properties`：IoTDB 的配置文件。 - -## 1. 环境配置项（confignode-env.sh/bat） - -环境配置项主要用于对 ConfigNode 运行的 Java 环境相关参数进行配置，如 JVM 相关配置。ConfigNode 启动时，此部分配置会被传给 JVM，详细配置项说明如下： - -* MEMORY\_SIZE - -|名字|MEMORY\_SIZE| -|:---:|:---| -|描述|IoTDB ConfigNode 启动时分配的内存大小 | -|类型|String| -|默认值|取决于操作系统和机器配置。默认为机器内存的十分之三，最多会被设置为 16G。| -|改后生效方式|重启服务生效| - -* ON\_HEAP\_MEMORY - -|名字|ON\_HEAP\_MEMORY| -|:---:|:---| -|描述|IoTDB ConfigNode 能使用的堆内内存大小, 曾用名: MAX\_HEAP\_SIZE | -|类型|String| -|默认值|取决于MEMORY\_SIZE的配置。| -|改后生效方式|重启服务生效| - -* OFF\_HEAP\_MEMORY - -|名字|OFF\_HEAP\_MEMORY| -|:---:|:---| -|描述|IoTDB ConfigNode 能使用的堆外内存大小, 曾用名: MAX\_DIRECT\_MEMORY\_SIZE | -|类型|String| -|默认值|取决于MEMORY\_SIZE的配置。| -|改后生效方式|重启服务生效| - -## 2. 系统配置项（iotdb-system.properties） - -IoTDB 集群的全局配置通过 ConfigNode 配置。 - -### 2.1 Config Node RPC 配置 - -* cn\_internal\_address - -| 名字 | cn\_internal\_address | -|:------:|:----------------------| -| 描述 | ConfigNode 集群内部地址 | -| 类型 | String | -| 默认值 | 127.0.0.1 | -| 改后生效方式 | 仅允许在第一次启动服务前修改 | - -* cn\_internal\_port - -| 名字 | cn\_internal\_port | -|:------:|:----------------------| -| 描述 | ConfigNode 集群服务监听端口 | -| 类型 | Short Int : [0,65535] | -| 默认值 | 10710 | -| 改后生效方式 | 仅允许在第一次启动服务前修改 | - -### 2.2 共识协议 - -* cn\_consensus\_port - -| 名字 | cn\_consensus\_port | -|:------:|:----------------------| -| 描述 | ConfigNode 的共识协议通信端口 | -| 类型 | Short Int : [0,65535] | -| 默认值 | 10720 | -| 改后生效方式 | 仅允许在第一次启动服务前修改 | - -### 2.3 SeedConfigNode 配置 - -* cn\_seed\_config\_node - -| 名字 | cn\_seed\_config\_node | -|:------:|:--------------------------------------| -| 描述 | 目标 ConfigNode 地址，ConfigNode 通过此地址加入集群，推荐使用 SeedConfigNode。V1.2.2 及以前曾用名是 cn\_target\_config\_node\_list | -| 类型 | String | -| 默认值 | 127.0.0.1:10710 | -| 改后生效方式 | 仅允许在第一次启动服务前修改 | - -### 2.4 数据目录 - -* cn\_system\_dir - -|名字| cn\_system\_dir | -|:---:|:---------------------------------------------------------| -|描述| ConfigNode 系统数据存储路径 | -|类型| String | -|默认值| data/confignode/system（Windows：data\\configndoe\\system） | -|改后生效方式| 重启服务生效 | - -* cn\_consensus\_dir - -|名字| cn\_consensus\_dir | -|:---:|:---------------------------------------------------| -|描述| ConfigNode 共识协议数据存储路径 | -|类型| String | -|默认值| data/confignode/consensus（Windows：data\\configndoe\\consensus） | -|改后生效方式| 重启服务生效 | - -### 2.5 Thrift RPC 配置 - -* cn\_rpc\_thrift\_compression\_enable - -| 名字 | cn\_rpc\_thrift\_compression\_enable | -|:------:|:-------------------------------------| -| 描述 | 是否启用 thrift 的压缩机制。 | -| 类型 | Boolean | -| 默认值 | false | -| 改后生效方式 | 重启服务生效 | - -* cn\_rpc\_advanced\_compression\_enable - -| 名字 | cn\_rpc\_advanced\_compression\_enable | -|:------:|:---------------------------------------| -| 描述 | 是否启用 thrift 的自定制压缩机制。 | -| 类型 | Boolean | -| 默认值 | false | -| 改后生效方式 | 重启服务生效 | - -* cn\_rpc\_max\_concurrent\_client\_num - -| 名字 | cn\_rpc\_max\_concurrent\_client\_num | -|:------:|:--------------------------------------| -| 描述 | 最大连接数。 | -| 类型 | int | -| 默认值 | 3000 | -| 改后生效方式 | 重启服务生效 | - -* cn\_thrift\_max\_frame\_size - -| 名字 | cn\_thrift\_max\_frame\_size | -|:------:|:---------------------------------------------| -| 描述 | RPC 请求/响应的最大字节数 | -| 类型 | long | -| 默认值 | 536870912 （默认值512MB，应大于等于 512 * 1024 * 1024) | -| 改后生效方式 | 重启服务生效 | - -* cn\_thrift\_init\_buffer\_size - -| 名字 | cn\_thrift\_init\_buffer\_size | -|:------:|:-------------------------------| -| 描述 | 字节数 | -| 类型 | Long | -| 默认值 | 1024 | -| 改后生效方式 | 重启服务生效 | - -* cn\_connection\_timeout\_ms - -| 名字 | cn\_connection\_timeout\_ms | -|:------:|:----------------------------| -| 描述 | 节点连接超时时间 | -| 类型 | int | -| 默认值 | 60000 | -| 改后生效方式 | 重启服务生效 | - -* cn\_selector\_thread\_nums\_of\_client\_manager - -| 名字 | cn\_selector\_thread\_nums\_of\_client\_manager | -|:------:|:------------------------------------------------| -| 描述 | 客户端异步线程管理的选择器线程数量 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | - -* cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager - -| 名字 | cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager | -|:------:|:--------------------------------------------------------------| -| 描述 | 单 ClientManager 中路由到每个节点的核心 Client 个数 | -| 类型 | int | -| 默认值 | 200 | -| 改后生效方式 | 重启服务生效 | - -* cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager - -| 名字 | cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager | -|:------:|:-------------------------------------------------------------| -| 描述 | 单 ClientManager 中路由到每个节点的最大 Client 个数 | -| 类型 | int | -| 默认值 | 300 | -| 改后生效方式 | 重启服务生效 | - -### 2.6 Metric 监控配置 - -* cn\_metric\_reporter\_list - -| 名字 | cn\_metric\_reporter\_list | -|:------:|:--------------------------------------------| -| 描述 | confignode 中用于配置监控模块的数据需要报告的系统。 | -| 类型 | String | -| 默认值 | 无 | -| 改后生效方式 | 重启服务生效 | - -* cn\_metric\_level - -| 名字 | cn\_metric\_level | -|:------:|:-----------------------------------| -| 描述 | confignode 中控制监控模块收集数据的详细程度 | -| 类型 | String | -| 默认值 | IMPORTANT | -| 改后生效方式 | 重启服务生效 | - -* cn\_metric\_async\_collect\_period - -| 名字 | cn\_metric\_async\_collect\_period | -|:------:|:-----------------------------------------| -| 描述 | confignode 中某些监控数据异步收集的周期，单位是秒。 | -| 类型 | int | -| 默认值 | 5 | -| 改后生效方式 | 重启服务生效 | - -* cn\_metric\_prometheus\_reporter\_port - -| 名字 | cn\_metric\_prometheus\_reporter\_port | -|:------:|:---------------------------------------------| -| 描述 | confignode 中 Prometheus 报告者用于监控数据报告的端口号。 | -| 类型 | int | -| 默认值 | 9091 | -| 改后生效方式 | 重启服务生效 | diff --git a/src/zh/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual_apache.md b/src/zh/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual_apache.md new file mode 100644 index 000000000..8914791b6 --- /dev/null +++ b/src/zh/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual_apache.md @@ -0,0 +1,256 @@ + + +# ConfigNode 配置参数 + +IoTDB ConfigNode 配置文件均位于 IoTDB 安装目录：`conf`文件夹下。 + +* `confignode-env.sh/bat`：环境配置项的配置文件，可以配置 ConfigNode 的内存大小。 + +* `iotdb-system.properties`：IoTDB 的配置文件。 + +## 1. 环境配置项（confignode-env.sh/bat） + +环境配置项主要用于对 ConfigNode 运行的 Java 环境相关参数进行配置，如 JVM 相关配置。ConfigNode 启动时，此部分配置会被传给 JVM，详细配置项说明如下： + +* MEMORY\_SIZE + +|名字|MEMORY\_SIZE| +|:---:|:---| +|描述|IoTDB ConfigNode 启动时分配的内存大小 | +|类型|String| +|默认值|取决于操作系统和机器配置。默认为机器内存的十分之三，最多会被设置为 16G。| +|改后生效方式|重启服务生效| + +* ON\_HEAP\_MEMORY + +|名字|ON\_HEAP\_MEMORY| +|:---:|:---| +|描述|IoTDB ConfigNode 能使用的堆内内存大小, 曾用名: MAX\_HEAP\_SIZE | +|类型|String| +|默认值|取决于MEMORY\_SIZE的配置。| +|改后生效方式|重启服务生效| + +* OFF\_HEAP\_MEMORY + +|名字|OFF\_HEAP\_MEMORY| +|:---:|:---| +|描述|IoTDB ConfigNode 能使用的堆外内存大小, 曾用名: MAX\_DIRECT\_MEMORY\_SIZE | +|类型|String| +|默认值|取决于MEMORY\_SIZE的配置。| +|改后生效方式|重启服务生效| + +## 2. 系统配置项（iotdb-system.properties） + +IoTDB 集群的全局配置通过 ConfigNode 配置。 + +### 2.1 Config Node RPC 配置 + +* cn\_internal\_address + +| 名字 | cn\_internal\_address | +|:------:|:----------------------| +| 描述 | ConfigNode 集群内部地址 | +| 类型 | String | +| 默认值 | 127.0.0.1 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +* cn\_internal\_port + +| 名字 | cn\_internal\_port | +|:------:|:----------------------| +| 描述 | ConfigNode 集群服务监听端口 | +| 类型 | Short Int : [0,65535] | +| 默认值 | 10710 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +### 2.2 共识协议 + +* cn\_consensus\_port + +| 名字 | cn\_consensus\_port | +|:------:|:----------------------| +| 描述 | ConfigNode 的共识协议通信端口 | +| 类型 | Short Int : [0,65535] | +| 默认值 | 10720 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +### 2.3 SeedConfigNode 配置 + +* cn\_seed\_config\_node + +| 名字 | cn\_seed\_config\_node | +|:------:|:--------------------------------------| +| 描述 | 目标 ConfigNode 地址，ConfigNode 通过此地址加入集群，推荐使用 SeedConfigNode。V1.2.2 及以前曾用名是 cn\_target\_config\_node\_list | +| 类型 | String | +| 默认值 | 127.0.0.1:10710 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +### 2.4 数据目录 + +* cn\_system\_dir + +|名字| cn\_system\_dir | +|:---:|:---------------------------------------------------------| +|描述| ConfigNode 系统数据存储路径 | +|类型| String | +|默认值| data/confignode/system（Windows：data\\configndoe\\system） | +|改后生效方式| 重启服务生效 | + +* cn\_consensus\_dir + +|名字| cn\_consensus\_dir | +|:---:|:---------------------------------------------------| +|描述| ConfigNode 共识协议数据存储路径 | +|类型| String | +|默认值| data/confignode/consensus（Windows：data\\configndoe\\consensus） | +|改后生效方式| 重启服务生效 | + +### 2.5 Thrift RPC 配置 + +* cn\_rpc\_thrift\_compression\_enable + +| 名字 | cn\_rpc\_thrift\_compression\_enable | +|:------:|:-------------------------------------| +| 描述 | 是否启用 thrift 的压缩机制。 | +| 类型 | Boolean | +| 默认值 | false | +| 改后生效方式 | 重启服务生效 | + +* cn\_rpc\_advanced\_compression\_enable + +| 名字 | cn\_rpc\_advanced\_compression\_enable | +|:------:|:---------------------------------------| +| 描述 | 是否启用 thrift 的自定制压缩机制。 | +| 类型 | Boolean | +| 默认值 | false | +| 改后生效方式 | 重启服务生效 | + +* cn\_rpc\_max\_concurrent\_client\_num + +| 名字 | cn\_rpc\_max\_concurrent\_client\_num | +|:------:|:--------------------------------------| +| 描述 | 最大连接数。 | +| 类型 | int | +| 默认值 | 3000 | +| 改后生效方式 | 重启服务生效 | + +* cn\_thrift\_max\_frame\_size + +| 名字 | cn\_thrift\_max\_frame\_size | +|:------:|:---------------------------------------------| +| 描述 | RPC 请求/响应的最大字节数 | +| 类型 | long | +| 默认值 | 536870912 （默认值512MB，应大于等于 512 * 1024 * 1024) | +| 改后生效方式 | 重启服务生效 | + +* cn\_thrift\_init\_buffer\_size + +| 名字 | cn\_thrift\_init\_buffer\_size | +|:------:|:-------------------------------| +| 描述 | 字节数 | +| 类型 | Long | +| 默认值 | 1024 | +| 改后生效方式 | 重启服务生效 | + +* cn\_connection\_timeout\_ms + +| 名字 | cn\_connection\_timeout\_ms | +|:------:|:----------------------------| +| 描述 | 节点连接超时时间 | +| 类型 | int | +| 默认值 | 60000 | +| 改后生效方式 | 重启服务生效 | + +* cn\_selector\_thread\_nums\_of\_client\_manager + +| 名字 | cn\_selector\_thread\_nums\_of\_client\_manager | +|:------:|:-----------------------------------------------------------------| +| 描述 | 客户端异步线程管理的选择器线程数量 | +| 类型 | int | +| 默认值 | 1
V2.0.10-beta 版本起默认值为 0，当值 <= 0 时自动按 max(1, CPU 核数 / 4) 计算 | +| 改后生效方式 | 重启服务生效 | + +* cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager + +| 名字 | cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager | +|:------:|:--------------------------------------------------------------| +| 描述 | 单 ClientManager 中路由到每个节点的核心 Client 个数 | +| 类型 | int | +| 默认值 | 200 | +| 改后生效方式 | 重启服务生效 | + +* cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager + +| 名字 | cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager | +|:------:|:-------------------------------------------------------------| +| 描述 | 单 ClientManager 中路由到每个节点的最大 Client 个数 | +| 类型 | int | +| 默认值 | 300 | +| 改后生效方式 | 重启服务生效 | + +- cn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | cn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |----------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10-beta 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + +### 2.6 Metric 监控配置 + +* cn\_metric\_reporter\_list + +| 名字 | cn\_metric\_reporter\_list | +|:------:|:--------------------------------------------| +| 描述 | confignode 中用于配置监控模块的数据需要报告的系统。 | +| 类型 | String | +| 默认值 | 无 | +| 改后生效方式 | 重启服务生效 | + +* cn\_metric\_level + +| 名字 | cn\_metric\_level | +|:------:|:-----------------------------------| +| 描述 | confignode 中控制监控模块收集数据的详细程度 | +| 类型 | String | +| 默认值 | IMPORTANT | +| 改后生效方式 | 重启服务生效 | + +* cn\_metric\_async\_collect\_period + +| 名字 | cn\_metric\_async\_collect\_period | +|:------:|:-----------------------------------------| +| 描述 | confignode 中某些监控数据异步收集的周期，单位是秒。 | +| 类型 | int | +| 默认值 | 5 | +| 改后生效方式 | 重启服务生效 | + +* cn\_metric\_prometheus\_reporter\_port + +| 名字 | cn\_metric\_prometheus\_reporter\_port | +|:------:|:---------------------------------------------| +| 描述 | confignode 中 Prometheus 报告者用于监控数据报告的端口号。 | +| 类型 | int | +| 默认值 | 9091 | +| 改后生效方式 | 重启服务生效 | diff --git a/src/zh/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual_timecho.md b/src/zh/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual_timecho.md new file mode 100644 index 000000000..18a3bcf9f --- /dev/null +++ b/src/zh/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual_timecho.md @@ -0,0 +1,256 @@ + + +# ConfigNode 配置参数 + +IoTDB ConfigNode 配置文件均位于 IoTDB 安装目录：`conf`文件夹下。 + +* `confignode-env.sh/bat`：环境配置项的配置文件，可以配置 ConfigNode 的内存大小。 + +* `iotdb-system.properties`：IoTDB 的配置文件。 + +## 1. 环境配置项（confignode-env.sh/bat） + +环境配置项主要用于对 ConfigNode 运行的 Java 环境相关参数进行配置，如 JVM 相关配置。ConfigNode 启动时，此部分配置会被传给 JVM，详细配置项说明如下： + +* MEMORY\_SIZE + +|名字|MEMORY\_SIZE| +|:---:|:---| +|描述|IoTDB ConfigNode 启动时分配的内存大小 | +|类型|String| +|默认值|取决于操作系统和机器配置。默认为机器内存的十分之三，最多会被设置为 16G。| +|改后生效方式|重启服务生效| + +* ON\_HEAP\_MEMORY + +|名字|ON\_HEAP\_MEMORY| +|:---:|:---| +|描述|IoTDB ConfigNode 能使用的堆内内存大小, 曾用名: MAX\_HEAP\_SIZE | +|类型|String| +|默认值|取决于MEMORY\_SIZE的配置。| +|改后生效方式|重启服务生效| + +* OFF\_HEAP\_MEMORY + +|名字|OFF\_HEAP\_MEMORY| +|:---:|:---| +|描述|IoTDB ConfigNode 能使用的堆外内存大小, 曾用名: MAX\_DIRECT\_MEMORY\_SIZE | +|类型|String| +|默认值|取决于MEMORY\_SIZE的配置。| +|改后生效方式|重启服务生效| + +## 2. 系统配置项（iotdb-system.properties） + +IoTDB 集群的全局配置通过 ConfigNode 配置。 + +### 2.1 Config Node RPC 配置 + +* cn\_internal\_address + +| 名字 | cn\_internal\_address | +|:------:|:----------------------| +| 描述 | ConfigNode 集群内部地址 | +| 类型 | String | +| 默认值 | 127.0.0.1 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +* cn\_internal\_port + +| 名字 | cn\_internal\_port | +|:------:|:----------------------| +| 描述 | ConfigNode 集群服务监听端口 | +| 类型 | Short Int : [0,65535] | +| 默认值 | 10710 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +### 2.2 共识协议 + +* cn\_consensus\_port + +| 名字 | cn\_consensus\_port | +|:------:|:----------------------| +| 描述 | ConfigNode 的共识协议通信端口 | +| 类型 | Short Int : [0,65535] | +| 默认值 | 10720 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +### 2.3 SeedConfigNode 配置 + +* cn\_seed\_config\_node + +| 名字 | cn\_seed\_config\_node | +|:------:|:--------------------------------------| +| 描述 | 目标 ConfigNode 地址，ConfigNode 通过此地址加入集群，推荐使用 SeedConfigNode。V1.2.2 及以前曾用名是 cn\_target\_config\_node\_list | +| 类型 | String | +| 默认值 | 127.0.0.1:10710 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +### 2.4 数据目录 + +* cn\_system\_dir + +|名字| cn\_system\_dir | +|:---:|:---------------------------------------------------------| +|描述| ConfigNode 系统数据存储路径 | +|类型| String | +|默认值| data/confignode/system（Windows：data\\configndoe\\system） | +|改后生效方式| 重启服务生效 | + +* cn\_consensus\_dir + +|名字| cn\_consensus\_dir | +|:---:|:---------------------------------------------------| +|描述| ConfigNode 共识协议数据存储路径 | +|类型| String | +|默认值| data/confignode/consensus（Windows：data\\configndoe\\consensus） | +|改后生效方式| 重启服务生效 | + +### 2.5 Thrift RPC 配置 + +* cn\_rpc\_thrift\_compression\_enable + +| 名字 | cn\_rpc\_thrift\_compression\_enable | +|:------:|:-------------------------------------| +| 描述 | 是否启用 thrift 的压缩机制。 | +| 类型 | Boolean | +| 默认值 | false | +| 改后生效方式 | 重启服务生效 | + +* cn\_rpc\_advanced\_compression\_enable + +| 名字 | cn\_rpc\_advanced\_compression\_enable | +|:------:|:---------------------------------------| +| 描述 | 是否启用 thrift 的自定制压缩机制。 | +| 类型 | Boolean | +| 默认值 | false | +| 改后生效方式 | 重启服务生效 | + +* cn\_rpc\_max\_concurrent\_client\_num + +| 名字 | cn\_rpc\_max\_concurrent\_client\_num | +|:------:|:--------------------------------------| +| 描述 | 最大连接数。 | +| 类型 | int | +| 默认值 | 3000 | +| 改后生效方式 | 重启服务生效 | + +* cn\_thrift\_max\_frame\_size + +| 名字 | cn\_thrift\_max\_frame\_size | +|:------:|:---------------------------------------------| +| 描述 | RPC 请求/响应的最大字节数 | +| 类型 | long | +| 默认值 | 536870912 （默认值512MB，应大于等于 512 * 1024 * 1024) | +| 改后生效方式 | 重启服务生效 | + +* cn\_thrift\_init\_buffer\_size + +| 名字 | cn\_thrift\_init\_buffer\_size | +|:------:|:-------------------------------| +| 描述 | 字节数 | +| 类型 | Long | +| 默认值 | 1024 | +| 改后生效方式 | 重启服务生效 | + +* cn\_connection\_timeout\_ms + +| 名字 | cn\_connection\_timeout\_ms | +|:------:|:----------------------------| +| 描述 | 节点连接超时时间 | +| 类型 | int | +| 默认值 | 60000 | +| 改后生效方式 | 重启服务生效 | + +* cn\_selector\_thread\_nums\_of\_client\_manager + +| 名字 | cn\_selector\_thread\_nums\_of\_client\_manager | +|:------:|:--------------------------------------------------------------| +| 描述 | 客户端异步线程管理的选择器线程数量 | +| 类型 | int | +| 默认值 | 1
V2.0.10.1 版本起默认值为 0，当值 <= 0 时自动按 max(1, CPU 核数 / 4) 计算 | +| 改后生效方式 | 重启服务生效 | + +* cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager + +| 名字 | cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager | +|:------:|:--------------------------------------------------------------| +| 描述 | 单 ClientManager 中路由到每个节点的核心 Client 个数 | +| 类型 | int | +| 默认值 | 200 | +| 改后生效方式 | 重启服务生效 | + +* cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager + +| 名字 | cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager | +|:------:|:-------------------------------------------------------------| +| 描述 | 单 ClientManager 中路由到每个节点的最大 Client 个数 | +| 类型 | int | +| 默认值 | 300 | +| 改后生效方式 | 重启服务生效 | + +- cn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | cn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10.1 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + +### 2.6 Metric 监控配置 + +* cn\_metric\_reporter\_list + +| 名字 | cn\_metric\_reporter\_list | +|:------:|:--------------------------------------------| +| 描述 | confignode 中用于配置监控模块的数据需要报告的系统。 | +| 类型 | String | +| 默认值 | 无 | +| 改后生效方式 | 重启服务生效 | + +* cn\_metric\_level + +| 名字 | cn\_metric\_level | +|:------:|:-----------------------------------| +| 描述 | confignode 中控制监控模块收集数据的详细程度 | +| 类型 | String | +| 默认值 | IMPORTANT | +| 改后生效方式 | 重启服务生效 | + +* cn\_metric\_async\_collect\_period + +| 名字 | cn\_metric\_async\_collect\_period | +|:------:|:-----------------------------------------| +| 描述 | confignode 中某些监控数据异步收集的周期，单位是秒。 | +| 类型 | int | +| 默认值 | 5 | +| 改后生效方式 | 重启服务生效 | + +* cn\_metric\_prometheus\_reporter\_port + +| 名字 | cn\_metric\_prometheus\_reporter\_port | +|:------:|:---------------------------------------------| +| 描述 | confignode 中 Prometheus 报告者用于监控数据报告的端口号。 | +| 类型 | int | +| 默认值 | 9091 | +| 改后生效方式 | 重启服务生效 | diff --git a/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md b/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md index 8ba413281..32223ef54 100644 --- a/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md +++ b/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md @@ -244,12 +244,12 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB * dn\_rpc\_selector\_thread\_count -| 名字 | rpc\_selector\_thread\_count | -|:------:|:-----------------------------| -| 描述 | rpc 选择器线程数量 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 名字 | rpc\_selector\_thread\_count | +|:------:|:-----------------------------------| +| 描述 | rpc 选择器线程数量，V2.0.10-beta 版本起该参数作废。 | +| 类型 | int | +| 默认值 | 1 | +| 改后生效方式 | 重启服务生效 | * dn\_rpc\_min\_concurrent\_client\_num @@ -314,6 +314,16 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB | 默认值 | 300 | | 改后生效方式 | 重启服务生效 | +- dn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |----------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10-beta 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + ### 3.5 目录配置 * dn\_system\_dir diff --git a/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md b/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md index 8f0a3fc61..f503f0957 100644 --- a/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md +++ b/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md @@ -246,7 +246,7 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB | 名字 | rpc\_selector\_thread\_count | |:------:|:-----------------------------| -| 描述 | rpc 选择器线程数量 | +| 描述 | rpc 选择器线程数量，V2.0.10.1 版本起该参数作废。 | | 类型 | int | | 默认值 | 1 | | 改后生效方式 | 重启服务生效 | @@ -314,6 +314,16 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB | 默认值 | 300 | | 改后生效方式 | 重启服务生效 | +- dn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10.1 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + ### 3.5 目录配置 * dn\_system\_dir diff --git a/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md b/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md index 0d3fb8866..e64c6a278 100644 --- a/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md +++ b/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md @@ -567,12 +567,12 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - cn_selector_thread_nums_of_client_manager -| 名字 | cn_selector_thread_nums_of_client_manager | -| ------------ | ----------------------------------------- | -| 描述 | 客户端异步线程管理的选择器线程数量 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 名字 | cn_selector_thread_nums_of_client_manager | +| ------------ |------------------------------------------------------------------| +| 描述 | 客户端异步线程管理的选择器线程数量 | +| 类型 | int | +| 默认值 | 1
V2.0.10-beta 版本起默认值为 0，当值 <= 0 时自动按 max(1, CPU 核数 / 4) 计算 | +| 改后生效方式 | 重启服务生效 | - cn_max_client_count_for_each_node_in_client_manager @@ -583,6 +583,17 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 默认值 | 300 | | 改后生效方式 | 重启服务生效 | + +- cn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | cn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |--------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10-beta 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + - dn_session_timeout_threshold | 名字 | dn_session_timeout_threshold | @@ -612,12 +623,12 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - dn_rpc_selector_thread_count -| 名字 | rpc_selector_thread_count | -| ------------ | ------------------------- | -| 描述 | rpc 选择器线程数量 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 名字 | rpc_selector_thread_count | +| ------------ |------------------------------------| +| 描述 | rpc 选择器线程数量，V2.0.10-beta 版本起该参数作废。 | +| 类型 | int | +| 默认值 | 1 | +| 改后生效方式 | 重启服务生效 | - dn_rpc_min_concurrent_client_num @@ -664,14 +675,14 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 默认值 | 60000 | | 改后生效方式 | 重启服务生效 | -- dn_selector_thread_count_of_client_manager +- dn_selector_thread_nums_of_client_manager -| 名字 | dn_selector_thread_count_of_client_manager | -| ------------ | ------------------------------------------------------------ | +| 名字 | dn_selector_thread_nums_of_client_manager
V2.0.10-beta 版本前参数名成为 dn_selector_thread_count_of_client_manager | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------| | 描述 | selector thread (TAsyncClientManager) nums for async thread in a clientManagerclientManager中异步线程的选择器线程（TAsyncClientManager）编号 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 类型 | int | +| 默认值 | 1
V2.0.10-beta 版本起默认值为 0，当值 <= 0 时自动按 max(1, CPU 核数 / 4) 计算 | +| 改后生效方式 | 重启服务生效 | - dn_max_client_count_for_each_node_in_client_manager @@ -682,6 +693,18 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 默认值 | 300 | | 改后生效方式 | 重启服务生效 | + +- dn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |----------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10-beta 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + + ### 3.9 对象存储管理 - remote_tsfile_cache_dirs diff --git a/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual_timecho.md b/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual_timecho.md index a7bffe3a7..204892fda 100644 --- a/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual_timecho.md +++ b/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual_timecho.md @@ -567,12 +567,12 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - cn_selector_thread_nums_of_client_manager -| 名字 | cn_selector_thread_nums_of_client_manager | -| ------------ | ----------------------------------------- | -| 描述 | 客户端异步线程管理的选择器线程数量 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 名字 | cn_selector_thread_nums_of_client_manager | +| ------------ |---------------------------------------------------------------| +| 描述 | 客户端异步线程管理的选择器线程数量 | +| 类型 | int | +| 默认值 | 1
V2.0.10.1 版本起默认值为 0，当值 <= 0 时自动按 max(1, CPU 核数 / 4) 计算 | +| 改后生效方式 | 重启服务生效 | - cn_max_client_count_for_each_node_in_client_manager @@ -583,6 +583,16 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 默认值 | 300 | | 改后生效方式 | 重启服务生效 | + +- cn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | cn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10.1 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + - dn_session_timeout_threshold | 名字 | dn_session_timeout_threshold | @@ -612,12 +622,12 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - dn_rpc_selector_thread_count -| 名字 | rpc_selector_thread_count | -| ------------ | ------------------------- | -| 描述 | rpc 选择器线程数量 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 名字 | rpc_selector_thread_count | +| ------------ |---------------------------------| +| 描述 | rpc 选择器线程数量，V2.0.10.1 版本起该参数作废。 | +| 类型 | int | +| 默认值 | 1 | +| 改后生效方式 | 重启服务生效 | - dn_rpc_min_concurrent_client_num @@ -664,14 +674,14 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 默认值 | 60000 | | 改后生效方式 | 重启服务生效 | -- dn_selector_thread_count_of_client_manager +- dn_selector_thread_nums_of_client_manager -| 名字 | dn_selector_thread_count_of_client_manager | -| ------------ | ------------------------------------------------------------ | +| 名字 | dn_selector_thread_nums_of_client_manager
V2.0.10.1 版本前参数名成为 dn_selector_thread_count_of_client_manager | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------| | 描述 | selector thread (TAsyncClientManager) nums for async thread in a clientManagerclientManager中异步线程的选择器线程（TAsyncClientManager）编号 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 类型 | int | +| 默认值 | 1
V2.0.10.1 版本起默认值为 0，当值 <= 0 时自动按 max(1, CPU 核数 / 4) 计算 | +| 改后生效方式 | 重启服务生效 | - dn_max_client_count_for_each_node_in_client_manager @@ -682,6 +692,17 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 默认值 | 300 | | 改后生效方式 | 重启服务生效 | + +- dn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |---------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10.1 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + ### 3.9 对象存储管理 - remote_tsfile_cache_dirs diff --git a/src/zh/UserGuide/latest/Reference/ConfigNode-Config-Manual.md b/src/zh/UserGuide/latest/Reference/ConfigNode-Config-Manual.md index cfd61c626..09efb16f6 100644 --- a/src/zh/UserGuide/latest/Reference/ConfigNode-Config-Manual.md +++ b/src/zh/UserGuide/latest/Reference/ConfigNode-Config-Manual.md @@ -1,3 +1,6 @@ +--- +redirectTo: ConfigNode-Config-Manual_apache.html +--- - -# ConfigNode 配置参数 - -IoTDB ConfigNode 配置文件均位于 IoTDB 安装目录：`conf`文件夹下。 - -* `confignode-env.sh/bat`：环境配置项的配置文件，可以配置 ConfigNode 的内存大小。 - -* `iotdb-system.properties`：IoTDB 的配置文件。 - -## 1. 环境配置项（confignode-env.sh/bat） - -环境配置项主要用于对 ConfigNode 运行的 Java 环境相关参数进行配置，如 JVM 相关配置。ConfigNode 启动时，此部分配置会被传给 JVM，详细配置项说明如下： - -* MEMORY\_SIZE - -|名字|MEMORY\_SIZE| -|:---:|:---| -|描述|IoTDB ConfigNode 启动时分配的内存大小 | -|类型|String| -|默认值|取决于操作系统和机器配置。默认为机器内存的十分之三，最多会被设置为 16G。| -|改后生效方式|重启服务生效| - -* ON\_HEAP\_MEMORY - -|名字|ON\_HEAP\_MEMORY| -|:---:|:---| -|描述|IoTDB ConfigNode 能使用的堆内内存大小, 曾用名: MAX\_HEAP\_SIZE | -|类型|String| -|默认值|取决于MEMORY\_SIZE的配置。| -|改后生效方式|重启服务生效| - -* OFF\_HEAP\_MEMORY - -|名字|OFF\_HEAP\_MEMORY| -|:---:|:---| -|描述|IoTDB ConfigNode 能使用的堆外内存大小, 曾用名: MAX\_DIRECT\_MEMORY\_SIZE | -|类型|String| -|默认值|取决于MEMORY\_SIZE的配置。| -|改后生效方式|重启服务生效| - -## 2. 系统配置项（iotdb-system.properties） - -IoTDB 集群的全局配置通过 ConfigNode 配置。 - -### 2.1 Config Node RPC 配置 - -* cn\_internal\_address - -| 名字 | cn\_internal\_address | -|:------:|:----------------------| -| 描述 | ConfigNode 集群内部地址 | -| 类型 | String | -| 默认值 | 127.0.0.1 | -| 改后生效方式 | 仅允许在第一次启动服务前修改 | - -* cn\_internal\_port - -| 名字 | cn\_internal\_port | -|:------:|:----------------------| -| 描述 | ConfigNode 集群服务监听端口 | -| 类型 | Short Int : [0,65535] | -| 默认值 | 10710 | -| 改后生效方式 | 仅允许在第一次启动服务前修改 | - -### 2.2 共识协议 - -* cn\_consensus\_port - -| 名字 | cn\_consensus\_port | -|:------:|:----------------------| -| 描述 | ConfigNode 的共识协议通信端口 | -| 类型 | Short Int : [0,65535] | -| 默认值 | 10720 | -| 改后生效方式 | 仅允许在第一次启动服务前修改 | - -### 2.3 SeedConfigNode 配置 - -* cn\_seed\_config\_node - -| 名字 | cn\_seed\_config\_node | -|:------:|:--------------------------------------| -| 描述 | 目标 ConfigNode 地址，ConfigNode 通过此地址加入集群，推荐使用 SeedConfigNode。V1.2.2 及以前曾用名是 cn\_target\_config\_node\_list | -| 类型 | String | -| 默认值 | 127.0.0.1:10710 | -| 改后生效方式 | 仅允许在第一次启动服务前修改 | - -### 2.4 数据目录 - -* cn\_system\_dir - -|名字| cn\_system\_dir | -|:---:|:---------------------------------------------------------| -|描述| ConfigNode 系统数据存储路径 | -|类型| String | -|默认值| data/confignode/system（Windows：data\\configndoe\\system） | -|改后生效方式| 重启服务生效 | - -* cn\_consensus\_dir - -|名字| cn\_consensus\_dir | -|:---:|:---------------------------------------------------| -|描述| ConfigNode 共识协议数据存储路径 | -|类型| String | -|默认值| data/confignode/consensus（Windows：data\\configndoe\\consensus） | -|改后生效方式| 重启服务生效 | - -### 2.5 Thrift RPC 配置 - -* cn\_rpc\_thrift\_compression\_enable - -| 名字 | cn\_rpc\_thrift\_compression\_enable | -|:------:|:-------------------------------------| -| 描述 | 是否启用 thrift 的压缩机制。 | -| 类型 | Boolean | -| 默认值 | false | -| 改后生效方式 | 重启服务生效 | - -* cn\_rpc\_advanced\_compression\_enable - -| 名字 | cn\_rpc\_advanced\_compression\_enable | -|:------:|:---------------------------------------| -| 描述 | 是否启用 thrift 的自定制压缩机制。 | -| 类型 | Boolean | -| 默认值 | false | -| 改后生效方式 | 重启服务生效 | - -* cn\_rpc\_max\_concurrent\_client\_num - -| 名字 | cn\_rpc\_max\_concurrent\_client\_num | -|:------:|:--------------------------------------| -| 描述 | 最大连接数。 | -| 类型 | int | -| 默认值 | 3000 | -| 改后生效方式 | 重启服务生效 | - -* cn\_thrift\_max\_frame\_size - -| 名字 | cn\_thrift\_max\_frame\_size | -|:------:|:---------------------------------------------| -| 描述 | RPC 请求/响应的最大字节数 | -| 类型 | long | -| 默认值 | 536870912 （默认值512MB，应大于等于 512 * 1024 * 1024) | -| 改后生效方式 | 重启服务生效 | - -* cn\_thrift\_init\_buffer\_size - -| 名字 | cn\_thrift\_init\_buffer\_size | -|:------:|:-------------------------------| -| 描述 | 字节数 | -| 类型 | Long | -| 默认值 | 1024 | -| 改后生效方式 | 重启服务生效 | - -* cn\_connection\_timeout\_ms - -| 名字 | cn\_connection\_timeout\_ms | -|:------:|:----------------------------| -| 描述 | 节点连接超时时间 | -| 类型 | int | -| 默认值 | 60000 | -| 改后生效方式 | 重启服务生效 | - -* cn\_selector\_thread\_nums\_of\_client\_manager - -| 名字 | cn\_selector\_thread\_nums\_of\_client\_manager | -|:------:|:------------------------------------------------| -| 描述 | 客户端异步线程管理的选择器线程数量 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | - -* cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager - -| 名字 | cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager | -|:------:|:--------------------------------------------------------------| -| 描述 | 单 ClientManager 中路由到每个节点的核心 Client 个数 | -| 类型 | int | -| 默认值 | 200 | -| 改后生效方式 | 重启服务生效 | - -* cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager - -| 名字 | cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager | -|:------:|:-------------------------------------------------------------| -| 描述 | 单 ClientManager 中路由到每个节点的最大 Client 个数 | -| 类型 | int | -| 默认值 | 300 | -| 改后生效方式 | 重启服务生效 | - -### 2.6 Metric 监控配置 - -* cn\_metric\_reporter\_list - -| 名字 | cn\_metric\_reporter\_list | -|:------:|:--------------------------------------------| -| 描述 | confignode 中用于配置监控模块的数据需要报告的系统。 | -| 类型 | String | -| 默认值 | 无 | -| 改后生效方式 | 重启服务生效 | - -* cn\_metric\_level - -| 名字 | cn\_metric\_level | -|:------:|:-----------------------------------| -| 描述 | confignode 中控制监控模块收集数据的详细程度 | -| 类型 | String | -| 默认值 | IMPORTANT | -| 改后生效方式 | 重启服务生效 | - -* cn\_metric\_async\_collect\_period - -| 名字 | cn\_metric\_async\_collect\_period | -|:------:|:-----------------------------------------| -| 描述 | confignode 中某些监控数据异步收集的周期，单位是秒。 | -| 类型 | int | -| 默认值 | 5 | -| 改后生效方式 | 重启服务生效 | - -* cn\_metric\_prometheus\_reporter\_port - -| 名字 | cn\_metric\_prometheus\_reporter\_port | -|:------:|:---------------------------------------------| -| 描述 | confignode 中 Prometheus 报告者用于监控数据报告的端口号。 | -| 类型 | int | -| 默认值 | 9091 | -| 改后生效方式 | 重启服务生效 | diff --git a/src/zh/UserGuide/latest/Reference/ConfigNode-Config-Manual_apache.md b/src/zh/UserGuide/latest/Reference/ConfigNode-Config-Manual_apache.md new file mode 100644 index 000000000..8914791b6 --- /dev/null +++ b/src/zh/UserGuide/latest/Reference/ConfigNode-Config-Manual_apache.md @@ -0,0 +1,256 @@ + + +# ConfigNode 配置参数 + +IoTDB ConfigNode 配置文件均位于 IoTDB 安装目录：`conf`文件夹下。 + +* `confignode-env.sh/bat`：环境配置项的配置文件，可以配置 ConfigNode 的内存大小。 + +* `iotdb-system.properties`：IoTDB 的配置文件。 + +## 1. 环境配置项（confignode-env.sh/bat） + +环境配置项主要用于对 ConfigNode 运行的 Java 环境相关参数进行配置，如 JVM 相关配置。ConfigNode 启动时，此部分配置会被传给 JVM，详细配置项说明如下： + +* MEMORY\_SIZE + +|名字|MEMORY\_SIZE| +|:---:|:---| +|描述|IoTDB ConfigNode 启动时分配的内存大小 | +|类型|String| +|默认值|取决于操作系统和机器配置。默认为机器内存的十分之三，最多会被设置为 16G。| +|改后生效方式|重启服务生效| + +* ON\_HEAP\_MEMORY + +|名字|ON\_HEAP\_MEMORY| +|:---:|:---| +|描述|IoTDB ConfigNode 能使用的堆内内存大小, 曾用名: MAX\_HEAP\_SIZE | +|类型|String| +|默认值|取决于MEMORY\_SIZE的配置。| +|改后生效方式|重启服务生效| + +* OFF\_HEAP\_MEMORY + +|名字|OFF\_HEAP\_MEMORY| +|:---:|:---| +|描述|IoTDB ConfigNode 能使用的堆外内存大小, 曾用名: MAX\_DIRECT\_MEMORY\_SIZE | +|类型|String| +|默认值|取决于MEMORY\_SIZE的配置。| +|改后生效方式|重启服务生效| + +## 2. 系统配置项（iotdb-system.properties） + +IoTDB 集群的全局配置通过 ConfigNode 配置。 + +### 2.1 Config Node RPC 配置 + +* cn\_internal\_address + +| 名字 | cn\_internal\_address | +|:------:|:----------------------| +| 描述 | ConfigNode 集群内部地址 | +| 类型 | String | +| 默认值 | 127.0.0.1 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +* cn\_internal\_port + +| 名字 | cn\_internal\_port | +|:------:|:----------------------| +| 描述 | ConfigNode 集群服务监听端口 | +| 类型 | Short Int : [0,65535] | +| 默认值 | 10710 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +### 2.2 共识协议 + +* cn\_consensus\_port + +| 名字 | cn\_consensus\_port | +|:------:|:----------------------| +| 描述 | ConfigNode 的共识协议通信端口 | +| 类型 | Short Int : [0,65535] | +| 默认值 | 10720 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +### 2.3 SeedConfigNode 配置 + +* cn\_seed\_config\_node + +| 名字 | cn\_seed\_config\_node | +|:------:|:--------------------------------------| +| 描述 | 目标 ConfigNode 地址，ConfigNode 通过此地址加入集群，推荐使用 SeedConfigNode。V1.2.2 及以前曾用名是 cn\_target\_config\_node\_list | +| 类型 | String | +| 默认值 | 127.0.0.1:10710 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +### 2.4 数据目录 + +* cn\_system\_dir + +|名字| cn\_system\_dir | +|:---:|:---------------------------------------------------------| +|描述| ConfigNode 系统数据存储路径 | +|类型| String | +|默认值| data/confignode/system（Windows：data\\configndoe\\system） | +|改后生效方式| 重启服务生效 | + +* cn\_consensus\_dir + +|名字| cn\_consensus\_dir | +|:---:|:---------------------------------------------------| +|描述| ConfigNode 共识协议数据存储路径 | +|类型| String | +|默认值| data/confignode/consensus（Windows：data\\configndoe\\consensus） | +|改后生效方式| 重启服务生效 | + +### 2.5 Thrift RPC 配置 + +* cn\_rpc\_thrift\_compression\_enable + +| 名字 | cn\_rpc\_thrift\_compression\_enable | +|:------:|:-------------------------------------| +| 描述 | 是否启用 thrift 的压缩机制。 | +| 类型 | Boolean | +| 默认值 | false | +| 改后生效方式 | 重启服务生效 | + +* cn\_rpc\_advanced\_compression\_enable + +| 名字 | cn\_rpc\_advanced\_compression\_enable | +|:------:|:---------------------------------------| +| 描述 | 是否启用 thrift 的自定制压缩机制。 | +| 类型 | Boolean | +| 默认值 | false | +| 改后生效方式 | 重启服务生效 | + +* cn\_rpc\_max\_concurrent\_client\_num + +| 名字 | cn\_rpc\_max\_concurrent\_client\_num | +|:------:|:--------------------------------------| +| 描述 | 最大连接数。 | +| 类型 | int | +| 默认值 | 3000 | +| 改后生效方式 | 重启服务生效 | + +* cn\_thrift\_max\_frame\_size + +| 名字 | cn\_thrift\_max\_frame\_size | +|:------:|:---------------------------------------------| +| 描述 | RPC 请求/响应的最大字节数 | +| 类型 | long | +| 默认值 | 536870912 （默认值512MB，应大于等于 512 * 1024 * 1024) | +| 改后生效方式 | 重启服务生效 | + +* cn\_thrift\_init\_buffer\_size + +| 名字 | cn\_thrift\_init\_buffer\_size | +|:------:|:-------------------------------| +| 描述 | 字节数 | +| 类型 | Long | +| 默认值 | 1024 | +| 改后生效方式 | 重启服务生效 | + +* cn\_connection\_timeout\_ms + +| 名字 | cn\_connection\_timeout\_ms | +|:------:|:----------------------------| +| 描述 | 节点连接超时时间 | +| 类型 | int | +| 默认值 | 60000 | +| 改后生效方式 | 重启服务生效 | + +* cn\_selector\_thread\_nums\_of\_client\_manager + +| 名字 | cn\_selector\_thread\_nums\_of\_client\_manager | +|:------:|:-----------------------------------------------------------------| +| 描述 | 客户端异步线程管理的选择器线程数量 | +| 类型 | int | +| 默认值 | 1
V2.0.10-beta 版本起默认值为 0，当值 <= 0 时自动按 max(1, CPU 核数 / 4) 计算 | +| 改后生效方式 | 重启服务生效 | + +* cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager + +| 名字 | cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager | +|:------:|:--------------------------------------------------------------| +| 描述 | 单 ClientManager 中路由到每个节点的核心 Client 个数 | +| 类型 | int | +| 默认值 | 200 | +| 改后生效方式 | 重启服务生效 | + +* cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager + +| 名字 | cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager | +|:------:|:-------------------------------------------------------------| +| 描述 | 单 ClientManager 中路由到每个节点的最大 Client 个数 | +| 类型 | int | +| 默认值 | 300 | +| 改后生效方式 | 重启服务生效 | + +- cn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | cn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |----------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10-beta 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + +### 2.6 Metric 监控配置 + +* cn\_metric\_reporter\_list + +| 名字 | cn\_metric\_reporter\_list | +|:------:|:--------------------------------------------| +| 描述 | confignode 中用于配置监控模块的数据需要报告的系统。 | +| 类型 | String | +| 默认值 | 无 | +| 改后生效方式 | 重启服务生效 | + +* cn\_metric\_level + +| 名字 | cn\_metric\_level | +|:------:|:-----------------------------------| +| 描述 | confignode 中控制监控模块收集数据的详细程度 | +| 类型 | String | +| 默认值 | IMPORTANT | +| 改后生效方式 | 重启服务生效 | + +* cn\_metric\_async\_collect\_period + +| 名字 | cn\_metric\_async\_collect\_period | +|:------:|:-----------------------------------------| +| 描述 | confignode 中某些监控数据异步收集的周期，单位是秒。 | +| 类型 | int | +| 默认值 | 5 | +| 改后生效方式 | 重启服务生效 | + +* cn\_metric\_prometheus\_reporter\_port + +| 名字 | cn\_metric\_prometheus\_reporter\_port | +|:------:|:---------------------------------------------| +| 描述 | confignode 中 Prometheus 报告者用于监控数据报告的端口号。 | +| 类型 | int | +| 默认值 | 9091 | +| 改后生效方式 | 重启服务生效 | diff --git a/src/zh/UserGuide/latest/Reference/ConfigNode-Config-Manual_timecho.md b/src/zh/UserGuide/latest/Reference/ConfigNode-Config-Manual_timecho.md new file mode 100644 index 000000000..18a3bcf9f --- /dev/null +++ b/src/zh/UserGuide/latest/Reference/ConfigNode-Config-Manual_timecho.md @@ -0,0 +1,256 @@ + + +# ConfigNode 配置参数 + +IoTDB ConfigNode 配置文件均位于 IoTDB 安装目录：`conf`文件夹下。 + +* `confignode-env.sh/bat`：环境配置项的配置文件，可以配置 ConfigNode 的内存大小。 + +* `iotdb-system.properties`：IoTDB 的配置文件。 + +## 1. 环境配置项（confignode-env.sh/bat） + +环境配置项主要用于对 ConfigNode 运行的 Java 环境相关参数进行配置，如 JVM 相关配置。ConfigNode 启动时，此部分配置会被传给 JVM，详细配置项说明如下： + +* MEMORY\_SIZE + +|名字|MEMORY\_SIZE| +|:---:|:---| +|描述|IoTDB ConfigNode 启动时分配的内存大小 | +|类型|String| +|默认值|取决于操作系统和机器配置。默认为机器内存的十分之三，最多会被设置为 16G。| +|改后生效方式|重启服务生效| + +* ON\_HEAP\_MEMORY + +|名字|ON\_HEAP\_MEMORY| +|:---:|:---| +|描述|IoTDB ConfigNode 能使用的堆内内存大小, 曾用名: MAX\_HEAP\_SIZE | +|类型|String| +|默认值|取决于MEMORY\_SIZE的配置。| +|改后生效方式|重启服务生效| + +* OFF\_HEAP\_MEMORY + +|名字|OFF\_HEAP\_MEMORY| +|:---:|:---| +|描述|IoTDB ConfigNode 能使用的堆外内存大小, 曾用名: MAX\_DIRECT\_MEMORY\_SIZE | +|类型|String| +|默认值|取决于MEMORY\_SIZE的配置。| +|改后生效方式|重启服务生效| + +## 2. 系统配置项（iotdb-system.properties） + +IoTDB 集群的全局配置通过 ConfigNode 配置。 + +### 2.1 Config Node RPC 配置 + +* cn\_internal\_address + +| 名字 | cn\_internal\_address | +|:------:|:----------------------| +| 描述 | ConfigNode 集群内部地址 | +| 类型 | String | +| 默认值 | 127.0.0.1 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +* cn\_internal\_port + +| 名字 | cn\_internal\_port | +|:------:|:----------------------| +| 描述 | ConfigNode 集群服务监听端口 | +| 类型 | Short Int : [0,65535] | +| 默认值 | 10710 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +### 2.2 共识协议 + +* cn\_consensus\_port + +| 名字 | cn\_consensus\_port | +|:------:|:----------------------| +| 描述 | ConfigNode 的共识协议通信端口 | +| 类型 | Short Int : [0,65535] | +| 默认值 | 10720 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +### 2.3 SeedConfigNode 配置 + +* cn\_seed\_config\_node + +| 名字 | cn\_seed\_config\_node | +|:------:|:--------------------------------------| +| 描述 | 目标 ConfigNode 地址，ConfigNode 通过此地址加入集群，推荐使用 SeedConfigNode。V1.2.2 及以前曾用名是 cn\_target\_config\_node\_list | +| 类型 | String | +| 默认值 | 127.0.0.1:10710 | +| 改后生效方式 | 仅允许在第一次启动服务前修改 | + +### 2.4 数据目录 + +* cn\_system\_dir + +|名字| cn\_system\_dir | +|:---:|:---------------------------------------------------------| +|描述| ConfigNode 系统数据存储路径 | +|类型| String | +|默认值| data/confignode/system（Windows：data\\configndoe\\system） | +|改后生效方式| 重启服务生效 | + +* cn\_consensus\_dir + +|名字| cn\_consensus\_dir | +|:---:|:---------------------------------------------------| +|描述| ConfigNode 共识协议数据存储路径 | +|类型| String | +|默认值| data/confignode/consensus（Windows：data\\configndoe\\consensus） | +|改后生效方式| 重启服务生效 | + +### 2.5 Thrift RPC 配置 + +* cn\_rpc\_thrift\_compression\_enable + +| 名字 | cn\_rpc\_thrift\_compression\_enable | +|:------:|:-------------------------------------| +| 描述 | 是否启用 thrift 的压缩机制。 | +| 类型 | Boolean | +| 默认值 | false | +| 改后生效方式 | 重启服务生效 | + +* cn\_rpc\_advanced\_compression\_enable + +| 名字 | cn\_rpc\_advanced\_compression\_enable | +|:------:|:---------------------------------------| +| 描述 | 是否启用 thrift 的自定制压缩机制。 | +| 类型 | Boolean | +| 默认值 | false | +| 改后生效方式 | 重启服务生效 | + +* cn\_rpc\_max\_concurrent\_client\_num + +| 名字 | cn\_rpc\_max\_concurrent\_client\_num | +|:------:|:--------------------------------------| +| 描述 | 最大连接数。 | +| 类型 | int | +| 默认值 | 3000 | +| 改后生效方式 | 重启服务生效 | + +* cn\_thrift\_max\_frame\_size + +| 名字 | cn\_thrift\_max\_frame\_size | +|:------:|:---------------------------------------------| +| 描述 | RPC 请求/响应的最大字节数 | +| 类型 | long | +| 默认值 | 536870912 （默认值512MB，应大于等于 512 * 1024 * 1024) | +| 改后生效方式 | 重启服务生效 | + +* cn\_thrift\_init\_buffer\_size + +| 名字 | cn\_thrift\_init\_buffer\_size | +|:------:|:-------------------------------| +| 描述 | 字节数 | +| 类型 | Long | +| 默认值 | 1024 | +| 改后生效方式 | 重启服务生效 | + +* cn\_connection\_timeout\_ms + +| 名字 | cn\_connection\_timeout\_ms | +|:------:|:----------------------------| +| 描述 | 节点连接超时时间 | +| 类型 | int | +| 默认值 | 60000 | +| 改后生效方式 | 重启服务生效 | + +* cn\_selector\_thread\_nums\_of\_client\_manager + +| 名字 | cn\_selector\_thread\_nums\_of\_client\_manager | +|:------:|:--------------------------------------------------------------| +| 描述 | 客户端异步线程管理的选择器线程数量 | +| 类型 | int | +| 默认值 | 1
V2.0.10.1 版本起默认值为 0，当值 <= 0 时自动按 max(1, CPU 核数 / 4) 计算 | +| 改后生效方式 | 重启服务生效 | + +* cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager + +| 名字 | cn\_core\_client\_count\_for\_each\_node\_in\_client\_manager | +|:------:|:--------------------------------------------------------------| +| 描述 | 单 ClientManager 中路由到每个节点的核心 Client 个数 | +| 类型 | int | +| 默认值 | 200 | +| 改后生效方式 | 重启服务生效 | + +* cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager + +| 名字 | cn\_max\_client\_count\_for\_each\_node\_in\_client\_manager | +|:------:|:-------------------------------------------------------------| +| 描述 | 单 ClientManager 中路由到每个节点的最大 Client 个数 | +| 类型 | int | +| 默认值 | 300 | +| 改后生效方式 | 重启服务生效 | + +- cn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | cn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10.1 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + +### 2.6 Metric 监控配置 + +* cn\_metric\_reporter\_list + +| 名字 | cn\_metric\_reporter\_list | +|:------:|:--------------------------------------------| +| 描述 | confignode 中用于配置监控模块的数据需要报告的系统。 | +| 类型 | String | +| 默认值 | 无 | +| 改后生效方式 | 重启服务生效 | + +* cn\_metric\_level + +| 名字 | cn\_metric\_level | +|:------:|:-----------------------------------| +| 描述 | confignode 中控制监控模块收集数据的详细程度 | +| 类型 | String | +| 默认值 | IMPORTANT | +| 改后生效方式 | 重启服务生效 | + +* cn\_metric\_async\_collect\_period + +| 名字 | cn\_metric\_async\_collect\_period | +|:------:|:-----------------------------------------| +| 描述 | confignode 中某些监控数据异步收集的周期，单位是秒。 | +| 类型 | int | +| 默认值 | 5 | +| 改后生效方式 | 重启服务生效 | + +* cn\_metric\_prometheus\_reporter\_port + +| 名字 | cn\_metric\_prometheus\_reporter\_port | +|:------:|:---------------------------------------------| +| 描述 | confignode 中 Prometheus 报告者用于监控数据报告的端口号。 | +| 类型 | int | +| 默认值 | 9091 | +| 改后生效方式 | 重启服务生效 | diff --git a/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md b/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md index 8ba413281..32223ef54 100644 --- a/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md +++ b/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md @@ -244,12 +244,12 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB * dn\_rpc\_selector\_thread\_count -| 名字 | rpc\_selector\_thread\_count | -|:------:|:-----------------------------| -| 描述 | rpc 选择器线程数量 | -| 类型 | int | -| 默认值 | 1 | -| 改后生效方式 | 重启服务生效 | +| 名字 | rpc\_selector\_thread\_count | +|:------:|:-----------------------------------| +| 描述 | rpc 选择器线程数量，V2.0.10-beta 版本起该参数作废。 | +| 类型 | int | +| 默认值 | 1 | +| 改后生效方式 | 重启服务生效 | * dn\_rpc\_min\_concurrent\_client\_num @@ -314,6 +314,16 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB | 默认值 | 300 | | 改后生效方式 | 重启服务生效 | +- dn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |----------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10-beta 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + ### 3.5 目录配置 * dn\_system\_dir diff --git a/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md b/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md index 8f0a3fc61..f503f0957 100644 --- a/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md +++ b/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md @@ -246,7 +246,7 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB | 名字 | rpc\_selector\_thread\_count | |:------:|:-----------------------------| -| 描述 | rpc 选择器线程数量 | +| 描述 | rpc 选择器线程数量，V2.0.10.1 版本起该参数作废。 | | 类型 | int | | 默认值 | 1 | | 改后生效方式 | 重启服务生效 | @@ -314,6 +314,16 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB | 默认值 | 300 | | 改后生效方式 | 重启服务生效 | +- dn_max_idle_client_count_for_each_node_in_client_manager + +| 名字 | dn_max_idle_client_count_for_each_node_in_client_manager | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 客户端管理器中，单个节点可保留的空闲客户端最大数量。当单节点空闲客户端超出该数值时，多余的空闲客户端将被清除。空闲客户端判定依据超时阈值（默认空闲时长1分钟）。设为 0 表示不保留任何空闲客户端，连接归还后会立即销毁。V2.0.10.1 版本起支持。 | +| 类型 | int | +| 默认值 | 1000 | +| 改后生效方式 | 重启服务生效 | + + ### 3.5 目录配置 * dn\_system\_dir