From 77fcfe4666ef5fee4737c0cc77a33334ad95432e Mon Sep 17 00:00:00 2001 From: gccgdb1234 Date: Fri, 28 Oct 2022 14:04:43 +0800 Subject: [PATCH 1/3] docs: refine taos.cfg format --- packaging/cfg/taos.cfg | 43 +++++++++++++++++++++++++++--------------- 1 file changed, 28 insertions(+), 15 deletions(-) diff --git a/packaging/cfg/taos.cfg b/packaging/cfg/taos.cfg index 87f465fdb9..e4014c7f9d 100644 --- a/packaging/cfg/taos.cfg +++ b/packaging/cfg/taos.cfg @@ -5,12 +5,23 @@ # # ######################################################## +######### 0. Client only configurations ############# + +# The interval for TDengine CLI to send heartbeat to mnode +# shellActivityTimer 3 + + +############### 1. Cluster End point ############################ + # The end point of the first dnode in the cluster to be connected to when `taosd` or `taos` is started # firstEp hostname:6030 # The end point of the second dnode to be connected to if the firstEp is not available when `taosd` or `taos` is started # secondEp + +############### 2. Configuration Parameters of current dndoe ##### + # The FQDN of the host where `taosd` will be started. It can be IP address # fqdn hostname @@ -20,27 +31,24 @@ # The maximum number of connections a dnode can accept # maxShellConns 5000 -# The directory for writing log files +# The directory for writing log files, if you are using Windows platform please change to Windows path # logDir /var/log/taos -# All data files are stored in this directory +# All data files are stored in this directory, if you are using Windows platform please change to Windows path # dataDir /var/lib/taos -# temporary file's directory +# temporary file's directory, if you are using Windows platform please change to Windows path # tempDir /tmp/ # Switch for allowing TDengine to collect and report service usage information # telemetryReporting 1 -# The maximum number of vnodes supported by dnode +# The maximum number of vnodes supported by this dnode # supportVnodes 0 -# The interval of dnode reporting status to mnode +# The interval of this dnode reporting status to mnode, [1..10] seconds # statusInterval 1 -# The interval for TDengine CLI to send heartbeat to mnode -# shellActivityTimer 3 - # The minimum sliding window time, milli-second # minSlidingTime 10 @@ -66,13 +74,14 @@ # system time zone # timezone Asia/Shanghai (CST, +0800) + # system time zone (for windows 10) # timezone UTC-8 # system locale # locale en_US.UTF-8 -# default system charset +# system charset # charset UTF-8 # stop writing logs when the disk size of the log folder is less than this value @@ -81,7 +90,7 @@ # stop writing temporary files when the disk size of the tmp folder is less than this value # minimalTmpDirGB 1.0 -# if disk free space is less than this value, taosd service exit directly within startup process +# if free disk space is less than this value, taosd service exit directly within startup process # minimalDataDirGB 2.0 # enable/disable system monitor @@ -91,14 +100,18 @@ # max number of lines per log filters # numOfLogLines 10000000 -# enable/disable async log +# write log in async way: 1 - async, 0 - sync # asyncLog 1 -# time of keeping log files, days +# time period of keeping log files, in days # logKeepDays 0 -# The following parameters are used for debug purpose only. -# debugFlag 8 bits mask: FILE-SCREEN-UNUSED-HeartBeat-DUMP-TRACE_WARN-ERROR + +############ 3. Debug Flag and levels ############################################# + +# The following parameters are used for debug purpose only by this dnode. +# debugFlag is a 8 bits mask: FILE-SCREEN-UNUSED-HeartBeat-DUMP-TRACE_WARN-ERROR +# Available debug levels are: # 131: output warning and error # 135: output debug, warning and error # 143: output trace, debug, warning and error to log @@ -166,4 +179,4 @@ # metaDebugFlag 131 # generate core file when service crash -# enableCoreFile 1 +# enableCoreFile 1 \ No newline at end of file From f0ef8b3ec7f593f132bc0d3de429264449d150dc Mon Sep 17 00:00:00 2001 From: gccgdb1234 Date: Fri, 28 Oct 2022 14:16:08 +0800 Subject: [PATCH 2/3] doc: refine taos.cfg --- packaging/cfg/taos.cfg | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/packaging/cfg/taos.cfg b/packaging/cfg/taos.cfg index e4014c7f9d..ba9dfeaaff 100644 --- a/packaging/cfg/taos.cfg +++ b/packaging/cfg/taos.cfg @@ -13,19 +13,19 @@ ############### 1. Cluster End point ############################ -# The end point of the first dnode in the cluster to be connected to when `taosd` or `taos` is started +# The end point of the first dnode in the cluster to be connected to when this dnode or a TDengine CLI `taos` is started # firstEp hostname:6030 -# The end point of the second dnode to be connected to if the firstEp is not available when `taosd` or `taos` is started +# The end point of the second dnode to be connected to if the firstEp is not available # secondEp ############### 2. Configuration Parameters of current dndoe ##### -# The FQDN of the host where `taosd` will be started. It can be IP address +# The FQDN of the host on which this dndoe will be started. It can be IP address # fqdn hostname -# The port for external access after `taosd` is started +# The port for external access after this dnode is started # serverPort 6030 # The maximum number of connections a dnode can accept @@ -90,7 +90,7 @@ # stop writing temporary files when the disk size of the tmp folder is less than this value # minimalTmpDirGB 1.0 -# if free disk space is less than this value, taosd service exit directly within startup process +# if free disk space is less than this value, this dnode will fail to start # minimalDataDirGB 2.0 # enable/disable system monitor From 7d0897ab6a601fce477cdff6437b057e10471fdd Mon Sep 17 00:00:00 2001 From: Shengliang Guan Date: Fri, 28 Oct 2022 14:23:15 +0800 Subject: [PATCH 3/3] docs: fix misspellings --- packaging/cfg/taos.cfg | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packaging/cfg/taos.cfg b/packaging/cfg/taos.cfg index ba9dfeaaff..eeb089d1ab 100644 --- a/packaging/cfg/taos.cfg +++ b/packaging/cfg/taos.cfg @@ -20,16 +20,16 @@ # secondEp -############### 2. Configuration Parameters of current dndoe ##### +############### 2. Configuration Parameters of current dnode ##### -# The FQDN of the host on which this dndoe will be started. It can be IP address +# The FQDN of the host on which this dnode will be started. It can be IP address # fqdn hostname # The port for external access after this dnode is started # serverPort 6030 # The maximum number of connections a dnode can accept -# maxShellConns 5000 +# maxShellConns 5000 # The directory for writing log files, if you are using Windows platform please change to Windows path # logDir /var/log/taos