跳到主要内容
未列出页
此页面未列出。搜索引擎不会对其索引，只有拥有直接链接的用户才能访问。
版本：Latest-3.3

FE/BE 参数和变量模板

如果您新增或修改了代码文件中的 FE/BE 参数以及变量，务必更新文档 FE configuration, BE configuration, System variables。

参数和变量描述需要包含以下字段：

  • 默认值：参数默认值。如果不同版本中默认值不同，需要说明。
  • 类型：允许的数据类型。
  • 单位：单位。
  • 取值范围：如果参数有取值范围，需要添加。
  • 是否动态：参数是否支持动态修改
  • 描述：包括含义，有效值，依赖和互斥关系，风险，调优方式，弃用/删除说明。
  • 引入版本：参数的引入版本，需精确到三位数版本，比如 3.2.1。

参数描述​

含义​

  • 这个参数是用来干什么的，适用什么场景。
  • 如果该参数和已有参数相似，两者的区别是什么。

依赖和互斥关系​

  • 该参数是否依赖其他参数（只有其他参数设置之后，该参数才能生效）。
  • 其他参数是否依赖该参数。
  • 该参数是否与其他参数互斥。

有效值​

如果参数有多个取值，需要罗列所有取值，解释每个取值的含义。

风险或注意事项​

  • 使用该参数是否会带来风险。
  • 如果参数有取值范围，超过上限或者下限，会引发哪些风险？
  • 如果参数值设置过大，或者过小，会引发哪些问题？

调优方式​

如果某个场景有报错，如何调整该参数。

弃用/删除说明​

如果参数弃用：

  • 弃用的原因。
  • 是否被其他参数替代。
  • 相关的特性是否也随之下线。

默认值/单位变更​

说明默认值或单位变更的背景和原因。

参数名变更​

  • 更名的原因。
  • 更名是否会引发兼容性问题，系统怎么处理。