docs:update taosc's debug config
This commit is contained in:
xiao-77
parent
9180cb8ecc
commit
ca6fcc5e06
|
|
@ -1126,7 +1126,7 @@ charset 的有效值是 UTF-8。
|
|||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.3.0.0 版本开始引入
|
||||
|
||||
#### slowLogThreshold
|
||||
#### slowLogMaxLen
|
||||
- 说明：慢查询日志最大长度
|
||||
- 类型：整数
|
||||
- 默认值：4096
|
||||
|
|
@ -1314,8 +1314,9 @@ charset 的有效值是 UTF-8。
|
|||
#### enableCoreFile
|
||||
- 说明：crash 时是否生成 core 文件
|
||||
- 类型：整数；0：不生成，1：生成；
|
||||
- 取值范围：同上
|
||||
- 默认值：131
|
||||
- 默认值：1
|
||||
- 最小值：0
|
||||
- 最大值：1
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
|
|
@ -1409,7 +1410,7 @@ charset 的有效值是 UTF-8。
|
|||
- 动态修改：不支持
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### forceReadConfig
|
||||
#### bypassFlag
|
||||
- 说明：配置文件所在目录
|
||||
- 类型：整数；
|
||||
- 取值范围：0：正常写入，1：写入消息在 taos 客户端发送 RPC 消息前返回，2：写入消息在 taosd 服务端收到 RPC 消息后返回，4：写入消息在 taosd 服务端写入内存缓存前返回，8：写入消息在 taosd 服务端数据落盘前返回
|
||||
|
|
|
|||
|
|
@ -300,43 +300,213 @@ TDengine 客户端驱动提供了应用编程所需要的全部 API，并且在
|
|||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
### 日志相关
|
||||
|参数名称|支持版本|动态修改|参数含义|
|
||||
|----------------------|----------|-------------------------|-------------|
|
||||
|logDir | |不支持动态修改 |日志文件目录，运行日志将写入该目录，缺省值：/var/log/taos|
|
||||
|minimalLogDirGB | |支持动态修改 立即生效 |日志文件夹所在磁盘可用空间大小小于该值时，停止写日志，单位 GB，缺省值：1|
|
||||
|numOfLogLines | |支持动态修改 立即生效 |单个日志文件允许的最大行数，缺省值：10,000,000|
|
||||
|asyncLog | |支持动态修改 立即生效 |日志写入模式，0：同步，1：异步，缺省值：1|
|
||||
|logKeepDays | |支持动态修改 立即生效 |日志文件的最长保存时间，单位：天，缺省值：0，意味着无限保存，日志文件不会被重命名，也不会有新的日志文件滚动产生，但日志文件的内容有可能会不断滚动，取决于日志文件大小的设置；当设置为大于 0 的值时，当日志文件大小达到设置的上限时会被重命名为 taoslogx.yyy，其中 yyy 为日志文件最后修改的时间戳，并滚动产生新的日志文件|
|
||||
|debugFlag | |支持动态修改 立即生效 |运行日志开关，131（输出错误和警告日志），135（输出错误、警告和调试日志），143（输出错误、警告、调试和跟踪日志）；默认值 131 或 135 （取决于不同模块）|
|
||||
|tmrDebugFlag | |支持动态修改 立即生效 |定时器模块的日志开关，取值范围同上|
|
||||
|uDebugFlag | |支持动态修改 立即生效 |共用功能模块的日志开关，取值范围同上|
|
||||
|rpcDebugFlag | |支持动态修改 立即生效 |rpc 模块的日志开关，取值范围同上|
|
||||
|jniDebugFlag | |支持动态修改 立即生效 |jni 模块的日志开关，取值范围同上|
|
||||
|qDebugFlag | |支持动态修改 立即生效 |query 模块的日志开关，取值范围同上|
|
||||
|cDebugFlag | |支持动态修改 立即生效 |客户端模块的日志开关，取值范围同上|
|
||||
|simDebugFlag | |支持动态修改 立即生效 |内部参数，测试工具的日志开关，取值范围同上|
|
||||
|tqClientDebugFlag|3.3.4.3 后|支持动态修改 立即生效 |客户端模块的日志开关，取值范围同上|
|
||||
|
||||
#### logDir
|
||||
- 说明：日志文件目录，运行日志将写入该目录
|
||||
- 类型：字符串
|
||||
- 默认值：/var/log/taos
|
||||
- 动态修改：不支持
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### minimalLogDirGB
|
||||
- 说明：日志文件夹所在磁盘可用空间大小小于该值时，停止写日志
|
||||
- 类型：浮点数
|
||||
- 单位：GB
|
||||
- 默认值：1
|
||||
- 最小值：0.001f
|
||||
- 最大值：10000000
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### numOfLogLines
|
||||
- 说明：单个日志文件允许的最大行数
|
||||
- 类型：整数
|
||||
- 默认值：10,000,000
|
||||
- 最小值：1000
|
||||
- 最大值：2000000000
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### asyncLog
|
||||
- 说明：日志写入模式
|
||||
- 类型：整数；0：同步，1：异步
|
||||
- 默认值：1
|
||||
- 最小值：0
|
||||
- 最大值：1
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### logKeepDays
|
||||
- 说明：日志文件的最长保存时间，小于等于0意味着只有两个日志文件相互切换保存日志，超过两个文件保存数量的日志会被删除；当设置为大于 0 的值时，当日志文件大小达到设置的上限时会被重命名为 taosdlog.yyy，其中 yyy 为日志文件最后修改的时间戳，并滚动产生新的日志文件
|
||||
- 类型：整数；0
|
||||
- 单位：天
|
||||
- 默认值：0
|
||||
- 最小值：-365000
|
||||
- 最大值：365000
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### debugFlag
|
||||
- 说明：运行日志开关，该参数的设置会影响所有模块的开关，后设置的参数起效
|
||||
- 类型：整数
|
||||
- 取值范围：131（输出错误和警告日志），135（输出错误、警告和调试日志），143（输出错误、警告、调试和跟踪日志）
|
||||
- 默认值：131 或 135 （取决于不同模块）
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### tmrDebugFlag
|
||||
- 说明：定时器模块的日志开关
|
||||
- 类型：整数
|
||||
- 取值范围：同上
|
||||
- 默认值：131
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### uDebugFlag
|
||||
- 说明：共用功能模块的日志开关
|
||||
- 类型：整数
|
||||
- 取值范围：同上
|
||||
- 默认值：131
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### rpcDebugFlag
|
||||
- 说明：rpc 模块的日志开关
|
||||
- 类型：整数
|
||||
- 取值范围：同上
|
||||
- 默认值：131
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### jniDebugFlag
|
||||
- 说明：jni 模块的日志开关
|
||||
- 类型：整数
|
||||
- 取值范围：同上
|
||||
- 默认值：131
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### qDebugFlag
|
||||
- 说明：query 模块的日志开关
|
||||
- 类型：整数
|
||||
- 取值范围：同上
|
||||
- 默认值：131
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### cDebugFlag
|
||||
- 说明：客户端模块的日志开关
|
||||
- 类型：整数
|
||||
- 取值范围：同上
|
||||
- 默认值：131
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### simDebugFlag
|
||||
- 说明：测试工具的日志开关 `内部参数`
|
||||
- 类型：整数
|
||||
- 取值范围：同上
|
||||
- 默认值：131
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### tqClientDebugFlag
|
||||
- 说明：测试工具的日志开关 `内部参数`
|
||||
- 类型：整数
|
||||
- 取值范围：同上
|
||||
- 默认值：131
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
### 调试相关
|
||||
|参数名称|支持版本|动态修改|参数含义|
|
||||
|----------------------|----------|-------------------------|-------------|
|
||||
|crashReporting | |支持动态修改 立即生效 |是否上传 crash 到 telemetry，0：不上传，1：上传；缺省值：1|
|
||||
|enableCoreFile | |支持动态修改 立即生效 |crash 时是否生成 core 文件，0：不生成，1：生成；缺省值：1|
|
||||
|assert | |不支持动态修改 |断言控制开关，缺省值：0|
|
||||
|configDir | |不支持动态修改 |配置文件所在目录|
|
||||
|scriptDir | |不支持动态修改 |内部参数，测试用例的目录|
|
||||
|randErrorChance |3.3.3.0 后|不支持动态修改 |内部参数，用于随机失败测试|
|
||||
|randErrorDivisor |3.3.3.0 后|不支持动态修改 |内部参数，用于随机失败测试|
|
||||
|randErrorScope |3.3.3.0 后|不支持动态修改 |内部参数，用于随机失败测试|
|
||||
|safetyCheckLevel |3.3.3.0 后|不支持动态修改 |内部参数，用于随机失败测试|
|
||||
|simdEnable |3.3.4.3 后|不支持动态修改 |内部参数，用于测试 SIMD 加速|
|
||||
|AVX512Enable |3.3.4.3 后|不支持动态修改 |内部参数，用于测试 AVX512 加速|
|
||||
|bypassFlag |3.3.4.5 后|支持动态修改 立即生效 |内部参数，用于短路测试，0：正常写入，1：写入消息在 taos 客户端发送 RPC 消息前返回，2：写入消息在 taosd 服务端收到 RPC 消息后返回，4：写入消息在 taosd 服务端写入内存缓存前返回，8：写入消息在 taosd 服务端数据落盘前返回；缺省值：0|
|
||||
|
||||
#### crashReporting
|
||||
- 说明：是否上传 crash 到 telemetry
|
||||
- 类型：整数；0：不上传，1：上传；
|
||||
- 默认值：1
|
||||
- 最小值：0
|
||||
- 最大值：1
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### enableCoreFile
|
||||
- 说明：crash 时是否生成 core 文件
|
||||
- 类型：整数；0：不生成，1：生成；
|
||||
- 默认值：1
|
||||
- 最小值：0
|
||||
- 最大值：1
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### assert
|
||||
- 说明：断言控制开关
|
||||
- 类型：整数；0:关闭，1：开启
|
||||
- 默认值：0
|
||||
- 最小值：0
|
||||
- 最大值：1
|
||||
- 动态修改：不支持
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### configDir
|
||||
- 说明：配置文件所在目录
|
||||
- 类型：字符串
|
||||
- 动态修改：不支持
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
#### scriptDir
|
||||
- 说明：测试工具的脚本目录 `内部参数`
|
||||
- 类型：字符串
|
||||
- 动态修改：不支持
|
||||
- 支持版本：从 v3.3.3.0 版本开始引入
|
||||
|
||||
#### randErrorChance
|
||||
- 说明：用于随机失败测试 `内部参数`
|
||||
- 动态修改：不支持
|
||||
- 支持版本：从 v3.3.3.0 版本开始引入
|
||||
|
||||
#### randErrorDivisor
|
||||
- 说明：用于随机失败测试 `内部参数`
|
||||
- 动态修改：不支持
|
||||
- 支持版本：从 v3.3.3.0 版本开始引入
|
||||
|
||||
#### randErrorScope
|
||||
- 说明：用于随机失败测试 `内部参数`
|
||||
- 动态修改：不支持
|
||||
- 支持版本：从 v3.3.3.0 版本开始引入
|
||||
|
||||
#### safetyCheckLevel
|
||||
- 说明：用于随机失败测试 `内部参数`
|
||||
- 动态修改：不支持
|
||||
- 支持版本：从 v3.3.3.0 版本开始引入
|
||||
|
||||
#### simdEnable
|
||||
- 说明：用于测试 SIMD 加速 `内部参数`
|
||||
- 动态修改：不支持
|
||||
- 支持版本：从 v3.3.4.3 版本开始引入
|
||||
|
||||
#### AVX512Enable
|
||||
- 说明：用于测试 AVX512 加速 `内部参数`
|
||||
- 动态修改：不支持
|
||||
- 支持版本：从 v3.3.4.3 版本开始引入
|
||||
|
||||
#### bypassFlag
|
||||
- 说明：配置文件所在目录
|
||||
- 类型：整数；
|
||||
- 取值范围：0：正常写入，1：写入消息在 taos 客户端发送 RPC 消息前返回，2：写入消息在 taosd 服务端收到 RPC 消息后返回，4：写入消息在 taosd 服务端写入内存缓存前返回，8：写入消息在 taosd 服务端数据落盘前返回
|
||||
- 默认值：0
|
||||
- 动态修改：支持通过 SQL 修改，立即生效
|
||||
- 支持版本：从 v3.3.4.5 版本开始引入
|
||||
|
||||
### SHELL 相关
|
||||
|参数名称|支持版本|动态修改|参数含义|
|
||||
|----------------------|----------|-------------------------|-------------|
|
||||
|enableScience | |不支持动态修改 |是否开启科学计数法显示浮点数；0：不开始，1：开启；缺省值：1|
|
||||
|
||||
#### enableScience
|
||||
- 说明：是否开启科学计数法显示浮点数
|
||||
- 类型：整数；0：不开始，1：开启；
|
||||
- 默认值：1
|
||||
- 最小值：0
|
||||
- 最大值：1
|
||||
- 动态修改：不支持
|
||||
- 支持版本：从 v3.1.0.0 版本开始引入
|
||||
|
||||
## API
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue