docs:update debug configs

This commit is contained in:
xiao-77 2025-01-24 11:30:25 +08:00
parent 93377ecd45
commit cabda6c860
1 changed files with 106 additions and 20 deletions

View File

@ -1310,26 +1310,112 @@ charset 的有效值是 UTF-8。
### 调试相关
|参数名称|支持版本|动态修改|参数含义|
|--------------------|-------------------------|----------|-|
|enableCoreFile | |支持动态修改 立即生效 |crash 时是否生成 core 文件0不生成1生成默认值 1|
|configDir | |不支持动态修改 |配置文件所在目录|
|forceReadConfig | |不支持动态修改 |强制使用配置文件中的参数0:使用持久化的配置参数1:使用配置文件中的配置参数;默认值 0|
|scriptDir | |不支持动态修改 |内部测试工具的脚本目录|
|assert | |不支持动态修改 |断言控制开关,默认值 0|
|randErrorChance | |支持动态修改 立即生效 |内部参数,用于随机失败测试|
|randErrorDivisor | |支持动态修改 立即生效 |内部参数,用于随机失败测试|
|randErrorScope | |支持动态修改 立即生效 |内部参数,用于随机失败测试|
|safetyCheckLevel | |支持动态修改 立即生效 |内部参数,用于随机失败测试|
|experimental | |支持动态修改 立即生效 |内部参数,用于一些实验特性|
|simdEnable |3.3.4.3 后|不支持动态修改 |内部参数,用于测试 SIMD 加速|
|AVX512Enable |3.3.4.3 后|不支持动态修改 |内部参数,用于测试 AVX512 加速|
|rsyncPort | |不支持动态修改 |内部参数,用于调试流计算|
|snodeAddress | |支持动态修改 重启生效 |内部参数,用于调试流计算|
|checkpointBackupDir | |支持动态修改 重启生效 |内部参数,用于恢复 snode 数据|
|enableAuditDelete | |不支持动态修改 |内部参数,用于测试审计功能|
|slowLogThresholdTest| |不支持动态修改 |内部参数,用于测试慢日志|
|bypassFlag |3.3.4.5 后|支持动态修改 立即生效 |内部参数用于短路测试0正常写入1写入消息在 taos 客户端发送 RPC 消息前返回2写入消息在 taosd 服务端收到 RPC 消息后返回4写入消息在 taosd 服务端写入内存缓存前返回8写入消息在 taosd 服务端数据落盘前返回;默认值 0|
#### enableCoreFile
- 说明crash 时是否生成 core 文件
- 类型整数0不生成1生成
- 取值范围:同上
- 默认值131
- 动态修改:支持通过 SQL 修改,立即生效
- 支持版本:从 v3.1.0.0 版本开始引入
#### configDir
- 说明:配置文件所在目录
- 类型:字符串
- 动态修改:不支持
- 支持版本:从 v3.1.0.0 版本开始引入
#### forceReadConfig
- 说明:配置文件所在目录
- 类型整数0:使用持久化的配置参数1:使用配置文件中的配置参数;
- 默认值0
- 最小值0
- 最大值1
- 动态修改:不支持
- 支持版本:从 v3.3.5.0 版本开始引入
#### scriptDir
- 说明:测试工具的脚本目录 `内部参数`
- 类型:字符串
- 动态修改:不支持
- 支持版本:从 v3.1.0.0 版本开始引入
#### assert
- 说明:断言控制开关
- 类型整数0:关闭1开启
- 默认值0
- 最小值0
- 最大值1
- 动态修改:不支持
- 支持版本:从 v3.1.0.0 版本开始引入
#### randErrorChance
- 说明:用于随机失败测试 `内部参数`
- 动态修改:支持通过 SQL 修改,立即生效
- 支持版本:从 v3.1.0.0 版本开始引入
#### randErrorDivisor
- 说明:用于随机失败测试 `内部参数`
- 动态修改:支持通过 SQL 修改,立即生效
- 支持版本:从 v3.1.0.0 版本开始引入
#### randErrorScope
- 说明:用于随机失败测试 `内部参数`
- 动态修改:支持通过 SQL 修改,立即生效
- 支持版本:从 v3.1.0.0 版本开始引入
#### safetyCheckLevel
- 说明:用于随机失败测试 `内部参数`
- 动态修改:支持通过 SQL 修改,立即生效
- 支持版本:从 v3.1.0.0 版本开始引入
#### experimental
- 说明:用于一些实验特性 `内部参数`
- 动态修改:支持通过 SQL 修改,立即生效
- 支持版本:从 v3.1.0.0 版本开始引入
#### simdEnable
- 说明:用于测试 SIMD 加速 `内部参数`
- 动态修改:不支持
- 支持版本:从 v3.3.4.3 版本开始引入
#### AVX512Enable
- 说明:用于测试 AVX512 加速 `内部参数`
- 动态修改:不支持
- 支持版本:从 v3.3.4.3 版本开始引入
#### rsyncPort
- 说明:用于调试流计算 `内部参数`
- 动态修改:不支持
- 支持版本:从 v3.1.0.0 版本开始引入
#### snodeAddress
- 说明:用于调试流计算 `内部参数`
- 动态修改:支持通过 SQL 修改,重启生效
- 支持版本:从 v3.1.0.0 版本开始引入
#### checkpointBackupDir
- 说明:用于恢复 snode 数据 `内部参数`
- 动态修改:支持通过 SQL 修改,重启生效
- 支持版本:从 v3.1.0.0 版本开始引入
#### enableAuditDelete
- 说明:用于测试审计功能 `内部参数`
- 动态修改:不支持
- 支持版本:从 v3.1.0.0 版本开始引入
#### slowLogThresholdTest
- 说明:用于测试慢日志 `内部参数`
- 动态修改:不支持
- 支持版本:从 v3.1.0.0 版本开始引入
#### forceReadConfig
- 说明:配置文件所在目录
- 类型:整数;
- 取值范围0正常写入1写入消息在 taos 客户端发送 RPC 消息前返回2写入消息在 taosd 服务端收到 RPC 消息后返回4写入消息在 taosd 服务端写入内存缓存前返回8写入消息在 taosd 服务端数据落盘前返回
- 默认值0
- 动态修改:支持通过 SQL 修改,立即生效
- 支持版本:从 v3.3.4.5 版本开始引入
### 压缩参数
|参数名称|支持版本|动态修改|参数含义|