This is an automated email from the ASF dual-hosted git repository. jimin pushed a commit to branch docusaurus in repository https://gitbox.apache.org/repos/asf/incubator-seata-website.git
The following commit(s) were added to refs/heads/docusaurus by this push:
new f5bdf1985ba doc: optimize configuration docs (#1002)
f5bdf1985ba is described below
commit f5bdf1985ba664492d95ac109fb1a5cdf9ced82c
Author: xiaoyu <93440108+yvce...@users.noreply.github.com>
AuthorDate: Tue Aug 5 10:50:29 2025 +0800
doc: optimize configuration docs (#1002)
---
.../current/user/configurations.md | 4 +-
.../version-v2.4/user/configurations.md | 4 +-
.../current/user/configurations.md | 2 +-
.../version-v2.4/user/configurations.md | 78 +++++++++++-----------
4 files changed, 44 insertions(+), 44 deletions(-)
diff --git
a/i18n/en/docusaurus-plugin-content-docs/current/user/configurations.md
b/i18n/en/docusaurus-plugin-content-docs/current/user/configurations.md
index 6eeb6a01156..3b24b0e7879 100644
--- a/i18n/en/docusaurus-plugin-content-docs/current/user/configurations.md
+++ b/i18n/en/docusaurus-plugin-content-docs/current/user/configurations.md
@@ -189,7 +189,7 @@
transport.enable-client-batch-send-request、client.log.exceptionRate
### Client side
| key | desc
| remark
| change
record |
-| -------------------------------------------------- |
-------------------------------------------------------------------------------------------
|
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| ------------- |
+| -------------------------------------------------- |
-------------------------------------------------------------------------------------------
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------- |
| seata.enabled | whether to enable
spring boot automatic assembly |
true, false, (SSBS) special configuration, default true (Appendix 4)
|
| seata.enableAutoDataSourceProxy=true | whether to enable
automatic proxy of data source |
True, false, data spring boot starter (SSBS) is a special configuration. SSBS
will enable automatic proxy of data source by default and can be closed through
this configuration item
|
| seata.useJdkProxy=false | whether to use JDK
proxy as the implementation method of data source automatic proxy |
true, false, (SSBS) proprietary configuration, false by default, CGLIB as the
implementation method of data source automatic proxy
|
@@ -222,7 +222,7 @@
transport.enable-client-batch-send-request、client.log.exceptionRate
| client.tm.defaultGlobalTransactionTimeout | global transaction
timeout | The
default is 60 seconds. After TM detects a branch transaction timeout or TC
detects that TM has not made a two-phase report timeout, it initiates a
rollback of the branch transaction
| New in 1.4.0 |
| client.tm.interceptorOrder | TM global transaction
interceptor order | Ordered
by default HIGHEST\_ PRECEDENCE+1000 ensures that the interceptor is executed
before the local transaction interceptor. You can also customize the execution
order of the interceptor for global transactions and business development
| New in
1.5.1 |
| client.undo.dataValidation | Phase2 rollback image
verification | By
default, true is enabled and false is disabled
|
-| client.undo.logSerialization | undo serialization
method |
default jackson
|
+| client.undo.logSerialization | undo serialization
method |
default jackson,Optional fastjson、protostuff、kryo、fastjson2
[...]
| client.undo.logTable | user defined undo table
name | Default
undo\_ log
|
| client.undo.onlyCareUpdateColumns | only images of updated
columns are generated | Default
true
|
| client.undo.compress.enable | undo log compression
switch |
default true
|
New in 1.4.1 |
diff --git
a/i18n/en/docusaurus-plugin-content-docs/version-v2.4/user/configurations.md
b/i18n/en/docusaurus-plugin-content-docs/version-v2.4/user/configurations.md
index 6eeb6a01156..e6e72263640 100644
--- a/i18n/en/docusaurus-plugin-content-docs/version-v2.4/user/configurations.md
+++ b/i18n/en/docusaurus-plugin-content-docs/version-v2.4/user/configurations.md
@@ -189,7 +189,7 @@
transport.enable-client-batch-send-request、client.log.exceptionRate
### Client side
| key | desc
| remark
| change
record |
-| -------------------------------------------------- |
-------------------------------------------------------------------------------------------
|
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| ------------- |
+| -------------------------------------------------- |
-------------------------------------------------------------------------------------------
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------- |
| seata.enabled | whether to enable
spring boot automatic assembly |
true, false, (SSBS) special configuration, default true (Appendix 4)
|
| seata.enableAutoDataSourceProxy=true | whether to enable
automatic proxy of data source |
True, false, data spring boot starter (SSBS) is a special configuration. SSBS
will enable automatic proxy of data source by default and can be closed through
this configuration item
|
| seata.useJdkProxy=false | whether to use JDK
proxy as the implementation method of data source automatic proxy |
true, false, (SSBS) proprietary configuration, false by default, CGLIB as the
implementation method of data source automatic proxy
|
@@ -222,7 +222,7 @@
transport.enable-client-batch-send-request、client.log.exceptionRate
| client.tm.defaultGlobalTransactionTimeout | global transaction
timeout | The
default is 60 seconds. After TM detects a branch transaction timeout or TC
detects that TM has not made a two-phase report timeout, it initiates a
rollback of the branch transaction
| New in 1.4.0 |
| client.tm.interceptorOrder | TM global transaction
interceptor order | Ordered
by default HIGHEST\_ PRECEDENCE+1000 ensures that the interceptor is executed
before the local transaction interceptor. You can also customize the execution
order of the interceptor for global transactions and business development
| New in
1.5.1 |
| client.undo.dataValidation | Phase2 rollback image
verification | By
default, true is enabled and false is disabled
|
-| client.undo.logSerialization | undo serialization
method |
default jackson
|
+| client.undo.logSerialization | undo serialization
method |
default jackson,Optional fastjson、protostuff、kryo、fastjson2
[...]
| client.undo.logTable | user defined undo table
name | Default
undo\_ log
|
| client.undo.onlyCareUpdateColumns | only images of updated
columns are generated | Default
true
|
| client.undo.compress.enable | undo log compression
switch |
default true
|
New in 1.4.1 |
diff --git
a/i18n/zh-cn/docusaurus-plugin-content-docs/current/user/configurations.md
b/i18n/zh-cn/docusaurus-plugin-content-docs/current/user/configurations.md
index 3409c22d0bd..58658f4c22c 100644
--- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/user/configurations.md
+++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/user/configurations.md
@@ -176,7 +176,7 @@ description: Seata 参数配置。
| client.tm.defaultGlobalTransactionTimeout | 全局事务超时时间
| 默认 60 秒，TM 检测到分支事务超时或 TC 检测到 TM 未做二阶段上报超时后，发起对分支事务的回滚
| 1.4.0 版本新增 |
| client.tm.interceptorOrder | TM 全局事务拦截器顺序
| 默认 Ordered.HIGHEST_PRECEDENCE +
1000，保证拦截器在本地事务拦截器之前执行，也可自定义全局事务和业务开发的拦截器执行顺序 |
1.5.1 版本新增 |
| client.undo.dataValidation | 二阶段回滚镜像校验
| 默认 true 开启，false 关闭
|
-| client.undo.logSerialization | undo 序列化方式
| 默认 jackson
|
+| client.undo.logSerialization | undo 序列化方式
| 默认 jackson,可选 fastjson、protostuff、kryo、fastjson2
|
| client.undo.logTable | 自定义 undo 表名
| 默认 undo_log
|
| client.undo.onlyCareUpdateColumns | 只生成被更新列的镜像
| 默认 true
|
| client.undo.compress.enable | undo log 压缩开关
| 默认 true
| 1.4.1 版本新增 |
diff --git
a/i18n/zh-cn/docusaurus-plugin-content-docs/version-v2.4/user/configurations.md
b/i18n/zh-cn/docusaurus-plugin-content-docs/version-v2.4/user/configurations.md
index 3409c22d0bd..a8b6c75ae64 100644
---
a/i18n/zh-cn/docusaurus-plugin-content-docs/version-v2.4/user/configurations.md
+++
b/i18n/zh-cn/docusaurus-plugin-content-docs/version-v2.4/user/configurations.md
@@ -143,46 +143,46 @@ description: Seata 参数配置。
| ratelimit.bucketTokenInitialNum | 令牌桶限流算法桶中初始化令牌数数
| 默认 999999（支持热配置）
| 2.4 版本新增
|
### client 端
-| key | desc
| remark
| change record |
-| -------------------------------------------------- |
--------------------------------------------- |
-----------------------------------------------------------------------------------------------------------------------------------------------------
| -------------- |
-| seata.enabled | 是否开启 spring-boot 自动装配
| true、false,(SSBS)专有配置，默认 true（附录 4）
|
-| seata.enableAutoDataSourceProxy=true | 是否开启数据源自动代理
| true、false,seata-spring-boot-starter(SSBS)专有配置,SSBS
默认会开启数据源自动代理,可通过该配置项关闭. |
-| seata.useJdkProxy=false | 是否使用 JDK
代理作为数据源自动代理的实现方式 | true、false,(SSBS)专有配置,默认 false,采用 CGLIB 作为数据源自动代理的实现方式
|
-| transport.enableClientBatchSendRequest | 客户端事务消息请求是否批量合并发送
| 默认 true，false 单条发送
|
-| transport.enableTmClientChannelCheckFailFast | 客户端 TM 快速失败检查
| 默认 true，false 不检测
|
-| transport.enableRmClientChannelCheckFailFast | 客户端 RM 快速失败检查
| 默认 true，false 不检测
|
-| client.log.exceptionRate | 日志异常输出概率
| 默认 100，目前用于 undo 回滚失败时异常堆栈输出，百分之一的概率输出，回滚失败基本是脏数据，无需输出堆栈占用硬盘空间
|
-| service.vgroupMapping.my_test_tx_group | 事务群组（附录 1）
| my_test_tx_group 为分组，配置项值为 TC 集群名
|
-| service.default.grouplist | TC 服务列表（附录 2）
| 仅注册中心为 file 时使用
|
-| service.disableGlobalTransaction | 全局事务开关
| 默认 false。false 为开启，true 为关闭
|
-| client.tm.degradeCheck | 降级开关
| 默认 false。业务侧根据连续错误数自动降级不走 seata 事务(详细介绍请阅读附录 6)
|
-| client.tm.degradeCheckAllowTimes | 升降级达标阈值
| 默认 10
|
-| client.tm.degradeCheckPeriod | 服务自检周期
| 默认 2000,单位 ms.每 2 秒进行一次服务自检,来决定
|
-| client.rm.reportSuccessEnable | 是否上报一阶段成功
| true、false，从 1.1.0 版本开始,默认 false.true 用于保持分支事务生命周期记录完整，false
可提高不少性能 |
-| client.rm.asyncCommitBufferLimit | 异步提交缓存队列长度
| 默认 10000。 二阶段提交成功，RM 异步清理 undo 队列
|
-| client.rm.lock.retryInterval | 校验或占用全局锁重试间隔
| 默认 10，单位毫秒
|
-| client.rm.lock.retryTimes | 校验或占用全局锁重试次数
| 默认 30
|
-| client.rm.lock.retryPolicyBranchRollbackOnConflict | 分支事务与其它全局回滚事务冲突时锁策略
| 默认 true，优先释放本地锁让回滚成功
|
-| client.rm.reportRetryCount | 一阶段结果上报 TC 重试次数
| 默认 5 次
| 1.4.1 版本新增 |
-| client.rm.tableMetaCheckEnable | 自动刷新缓存中的表结构
| 默认 false
| 1.5.1 版本新增 |
-| client.rm.tableMetaCheckerInterval | 定时刷新缓存中表结构间隔时间
| 默认 60 秒
|
+| key | desc
| remark
| change record |
+| -------------------------------------------------- |
---------------------------------------------
|--------------------------------------------------------------------------------------|
-------------- |
+| seata.enabled | 是否开启 spring-boot 自动装配
| true、false,(SSBS)专有配置，默认 true（附录 4）
|
+| seata.enableAutoDataSourceProxy=true | 是否开启数据源自动代理
| true、false,seata-spring-boot-starter(SSBS)专有配置,SSBS
默认会开启数据源自动代理,可通过该配置项关闭. |
+| seata.useJdkProxy=false | 是否使用 JDK
代理作为数据源自动代理的实现方式 | true、false,(SSBS)专有配置,默认 false,采用 CGLIB 作为数据源自动代理的实现方式
|
+| transport.enableClientBatchSendRequest | 客户端事务消息请求是否批量合并发送
| 默认 true，false 单条发送
|
+| transport.enableTmClientChannelCheckFailFast | 客户端 TM 快速失败检查
| 默认 true，false 不检测
|
+| transport.enableRmClientChannelCheckFailFast | 客户端 RM 快速失败检查
| 默认 true，false 不检测
|
+| client.log.exceptionRate | 日志异常输出概率
| 默认 100，目前用于 undo 回滚失败时异常堆栈输出，百分之一的概率输出，回滚失败基本是脏数据，无需输出堆栈占用硬盘空间
|
+| service.vgroupMapping.my_test_tx_group | 事务群组（附录 1）
| my_test_tx_group 为分组，配置项值为 TC 集群名
|
+| service.default.grouplist | TC 服务列表（附录 2）
| 仅注册中心为 file 时使用
|
+| service.disableGlobalTransaction | 全局事务开关
| 默认 false。false 为开启，true 为关闭
|
+| client.tm.degradeCheck | 降级开关
| 默认 false。业务侧根据连续错误数自动降级不走 seata 事务(详细介绍请阅读附录 6)
|
+| client.tm.degradeCheckAllowTimes | 升降级达标阈值
| 默认 10
|
+| client.tm.degradeCheckPeriod | 服务自检周期
| 默认 2000,单位 ms.每 2 秒进行一次服务自检,来决定
|
+| client.rm.reportSuccessEnable | 是否上报一阶段成功
| true、false，从 1.1.0 版本开始,默认 false.true 用于保持分支事务生命周期记录完整，false
可提高不少性能 |
+| client.rm.asyncCommitBufferLimit | 异步提交缓存队列长度
| 默认 10000。 二阶段提交成功，RM 异步清理 undo 队列
|
+| client.rm.lock.retryInterval | 校验或占用全局锁重试间隔
| 默认 10，单位毫秒
|
+| client.rm.lock.retryTimes | 校验或占用全局锁重试次数
| 默认 30
|
+| client.rm.lock.retryPolicyBranchRollbackOnConflict | 分支事务与其它全局回滚事务冲突时锁策略
| 默认 true，优先释放本地锁让回滚成功
|
+| client.rm.reportRetryCount | 一阶段结果上报 TC 重试次数
| 默认 5 次
| 1.4.1 版本新增 |
+| client.rm.tableMetaCheckEnable | 自动刷新缓存中的表结构
| 默认 false
| 1.5.1 版本新增 |
+| client.rm.tableMetaCheckerInterval | 定时刷新缓存中表结构间隔时间
| 默认 60 秒
|
| client.rm.sagaBranchRegisterEnable | 是否开启 saga 分支注册
| Saga 模式中分支状态存储在状态机本地数据库中，可通过状态机进行提交或回滚，为提高性能可考虑不用向 TC 注册 Saga
分支，但需考虑状态机的可用性，默认 false |
-| client.rm.sagaJsonParser | saga 模式中数据序列化方式
| 默认 fastjson,可选 jackson
| 1.5.1 版本新增 |
-| client.rm.tccActionInterceptorOrder | tcc 拦截器顺序
| 默认 Ordered.HIGHEST_PRECEDENCE + 1000，保证拦截器在本地事务拦截器之前执行，也可自定义
tcc 和业务开发的拦截器执行顺序 | 1.5.1 版本新增 |
-| client.rm.applicationDataLimitCheck | 客户端应用数据是否开启限制
| 默认 false
|
-| client.rm.applicationDataLimit | 客户端应用数据上报限制
| 默认 64000
|
-| client.tm.commitRetryCount | 一阶段全局提交结果上报 TC 重试次数
| 默认 1 次，建议大于 1
|
-| client.tm.rollbackRetryCount | 一阶段全局回滚结果上报 TC 重试次数
| 默认 1 次，建议大于 1
|
-| client.tm.defaultGlobalTransactionTimeout | 全局事务超时时间
| 默认 60 秒，TM 检测到分支事务超时或 TC 检测到 TM 未做二阶段上报超时后，发起对分支事务的回滚
| 1.4.0 版本新增 |
-| client.tm.interceptorOrder | TM 全局事务拦截器顺序
| 默认 Ordered.HIGHEST_PRECEDENCE +
1000，保证拦截器在本地事务拦截器之前执行，也可自定义全局事务和业务开发的拦截器执行顺序 |
1.5.1 版本新增 |
-| client.undo.dataValidation | 二阶段回滚镜像校验
| 默认 true 开启，false 关闭
|
-| client.undo.logSerialization | undo 序列化方式
| 默认 jackson
|
-| client.undo.logTable | 自定义 undo 表名
| 默认 undo_log
|
-| client.undo.onlyCareUpdateColumns | 只生成被更新列的镜像
| 默认 true
|
-| client.undo.compress.enable | undo log 压缩开关
| 默认 true
| 1.4.1 版本新增 |
-| client.undo.compress.type | undo log 压缩算法
| 默认 zip,可选 NONE(不压缩)、GZIP、ZIP、SEVENZ、BZIP2、LZ4、DEFLATER、ZSTD
|
1.4.1 版本新增 |
-| client.undo.compress.threshold | undo log 压缩阈值
| 默认值 64k，压缩开关开启且 undo log 大小超过阈值时才进行压缩
| 1.4.1 版本新增
|
-| client.rm.sqlParserType | sql 解析类型
| 默认 druid,可选 antlr
|
+| client.rm.sagaJsonParser | saga 模式中数据序列化方式
| 默认 fastjson,可选 jackson
| 1.5.1 版本新增 |
+| client.rm.tccActionInterceptorOrder | tcc 拦截器顺序
| 默认 Ordered.HIGHEST_PRECEDENCE + 1000，保证拦截器在本地事务拦截器之前执行，也可自定义
tcc 和业务开发的拦截器执行顺序 | 1.5.1 版本新增 |
+| client.rm.applicationDataLimitCheck | 客户端应用数据是否开启限制
| 默认 false
|
+| client.rm.applicationDataLimit | 客户端应用数据上报限制
| 默认 64000
|
+| client.tm.commitRetryCount | 一阶段全局提交结果上报 TC 重试次数
| 默认 1 次，建议大于 1
|
+| client.tm.rollbackRetryCount | 一阶段全局回滚结果上报 TC 重试次数
| 默认 1 次，建议大于 1
|
+| client.tm.defaultGlobalTransactionTimeout | 全局事务超时时间
| 默认 60 秒，TM 检测到分支事务超时或 TC 检测到 TM 未做二阶段上报超时后，发起对分支事务的回滚
| 1.4.0 版本新增 |
+| client.tm.interceptorOrder | TM 全局事务拦截器顺序
| 默认 Ordered.HIGHEST_PRECEDENCE +
1000，保证拦截器在本地事务拦截器之前执行，也可自定义全局事务和业务开发的拦截器执行顺序 | 1.5.1 版本新增 |
+| client.undo.dataValidation | 二阶段回滚镜像校验
| 默认 true 开启，false 关闭
|
+| client.undo.logSerialization | undo 序列化方式
| 默认 jackson,可选 fastjson、protostuff、kryo、fastjson2
|
+| client.undo.logTable | 自定义 undo 表名
| 默认 undo_log
|
+| client.undo.onlyCareUpdateColumns | 只生成被更新列的镜像
| 默认 true
|
+| client.undo.compress.enable | undo log 压缩开关
| 默认 true
| 1.4.1 版本新增 |
+| client.undo.compress.type | undo log 压缩算法
| 默认 zip,可选 NONE(不压缩)、GZIP、ZIP、SEVENZ、BZIP2、LZ4、DEFLATER、ZSTD
| 1.4.1 版本新增 |
+| client.undo.compress.threshold | undo log 压缩阈值
| 默认值 64k，压缩开关开启且 undo log 大小超过阈值时才进行压缩
| 1.4.1 版本新增 |
+| client.rm.sqlParserType | sql 解析类型
| 默认 druid,可选 antlr
|
<details>
<summary><mark>参数同步到配置中心使用demo</mark></summary>
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscr...@seata.apache.org
For additional commands, e-mail: notifications-h...@seata.apache.org
