Skip to content

ConfigNode-Config-Manual.md

Latest commit

 

History

History
223 lines (165 loc) · 8.09 KB

ConfigNode-Config-Manual.md

File metadata and controls

223 lines (165 loc) · 8.09 KB
Raw

ConfigNode Configuration

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.

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

ConfigNode Configuration File (iotdb-system.properties)

The global configuration of cluster is in ConfigNode.

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

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

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

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

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

Metric Configuration