Seata入门系列(5)-Seata参数配置详解

阳光穿透心脏的1/2处 2023-10-10 12:33 70阅读 0赞

### 启动参数 ###

#### 源码 ####

@Parameter(names = "--help", help = true)
        private boolean help;
        @Parameter(names = {
        "--host", "-h"}, description = "The ip to register to registry center.", order = 1)
        private String host;
        @Parameter(names = {
        "--port", "-p"}, description = "The port to listen.", order = 2)
        private int port = SERVER_DEFAULT_PORT;
        @Parameter(names = {
        "--storeMode", "-m"}, description = "log store mode : file, db", order = 3)
        private String storeMode;
        @Parameter(names = {
        "--serverNode", "-n"}, description = "server node id, such as 1, 2, 3.it will be generated according to the snowflake by default", order = 4)
        private Long serverNode;
        @Parameter(names = {
        "--seataEnv", "-e"}, description = "The name used for multi-configuration isolation.",
            order = 5)
        private String seataEnv;

#### 说明 ####

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>–help</td> 
   <td>查看帮助</td> 
  </tr> 
  <tr> 
   <td>–host, -h</td> 
   <td>server端IP，如输入为-h 192.168.8.8时，在nacos中的注册地址为当前地址，可用于多网卡环境</td> 
  </tr> 
  <tr> 
   <td>–port, -p</td> 
   <td>server端启动及监听端口</td> 
  </tr> 
  <tr> 
   <td>–storeMode, -m</td> 
   <td>日志存储方式，支持file, db</td> 
  </tr> 
  <tr> 
   <td>–serverNode, -n</td> 
   <td>serverNode 用于TC集群区分节点的序号，各节点生成的分支事务ID以及各类ID是根据这个node生成的，区间是20亿，比如-n 1 节点大概生成的ID都是2开头的，-n 2 生成的ID是4开头的 ，为了避免xid重复</td> 
  </tr> 
  <tr> 
   <td>–seataEnv, -e</td> 
   <td>registry.conf 文件的多环境配置，例如修改配置文件为registry-dev.conf，添加-e dev启动，则会读取dev环境的配置</td> 
  </tr> 
 </tbody> 
</table>

### 配置参数 ###

#### 通信部分 ####

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>描述</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>transport.type</td> 
   <td>传输协议类型</td> 
   <td>默认TCP</td> 
  </tr> 
  <tr> 
   <td>transport.server</td> 
   <td>传输服务类型</td> 
   <td>默认NIO</td> 
  </tr> 
  <tr> 
   <td>transport.heartbeat</td> 
   <td>client和server通信心跳检测开关</td> 
   <td>默认true开启</td> 
  </tr> 
  <tr> 
   <td>transport.enableClientBatchSendRequest</td> 
   <td>客户端事务消息请求是否批量合并发送</td> 
   <td>默认true，false单条发送</td> 
  </tr> 
  <tr> 
   <td>transport.threadFactory.bossThreadPrefix</td> 
   <td>线程工厂Boss线程前缀</td> 
   <td>默认NettyBoss</td> 
  </tr> 
  <tr> 
   <td>transport.threadFactory.workerThreadPrefix</td> 
   <td>线程工厂Worker线程前缀</td> 
   <td>默认NettyServerNIOWorker</td> 
  </tr> 
  <tr> 
   <td>transport.threadFactory.serverExecutorThreadPrefix</td> 
   <td>服务器执行线程前缀</td> 
   <td>默认NettyServerBizHandler</td> 
  </tr> 
  <tr> 
   <td>transport.threadFactory.shareBossWorker</td> 
   <td>是否共享boss/worker</td> 
   <td>默认false</td> 
  </tr> 
  <tr> 
   <td>transport.threadFactory.clientSelectorThreadPrefix</td> 
   <td>客户端线程选择器前缀</td> 
   <td>默认NettyClientSelector</td> 
  </tr> 
  <tr> 
   <td>transport.threadFactory.clientSelectorThreadSize</td> 
   <td>客户端线程选择器数量</td> 
   <td>默认1</td> 
  </tr> 
  <tr> 
   <td>transport.threadFactory.clientWorkerThreadPrefix</td> 
   <td>客户端worker线程前缀</td> 
   <td>默认NettyClientWorkerThread</td> 
  </tr> 
  <tr> 
   <td>transport.threadFactory.bossThreadSize</td> 
   <td>Boss线程数量</td> 
   <td>默认1</td> 
  </tr> 
  <tr> 
   <td>transport.threadFactory.workerThreadSize</td> 
   <td>Worker线程数量</td> 
   <td>默认default</td> 
  </tr> 
  <tr> 
   <td>transport.shutdown.wait</td> 
   <td>server端销毁后客户端的等待时间</td> 
   <td>默认3秒</td> 
  </tr> 
  <tr> 
   <td>transport.serialization</td> 
   <td>client和server通信编解码方式</td> 
   <td>seata(ByteBuf)、protobuf、kryo、hession、fst，默认seata</td> 
  </tr> 
  <tr> 
   <td>transport.compressor</td> 
   <td>client和server通信数据压缩方式</td> 
   <td>none、gzip，默认none</td> 
  </tr> 
 </tbody> 
</table>

#### 服务端 ####

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>描述</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>service.enableDegrade</td> 
   <td>是否开启降级</td> 
   <td>默认false</td> 
  </tr> 
  <tr> 
   <td>service.disableGlobalTransaction</td> 
   <td>全局事务开关</td> 
   <td>默认false。false为开启，true为关闭</td> 
  </tr> 
  <tr> 
   <td>server.recovery.committingRetryPeriod</td> 
   <td>二阶段提交未完成状态全局事务重试提交线程间隔时间</td> 
   <td>默认1000，单位毫秒</td> 
  </tr> 
  <tr> 
   <td>server.recovery.asynCommittingRetryPeriod</td> 
   <td>二阶段异步提交状态重试提交线程间隔时间</td> 
   <td>默认1000，单位毫秒</td> 
  </tr> 
  <tr> 
   <td>server.recovery.rollbackingRetryPeriod</td> 
   <td>二阶段回滚状态重试回滚线程间隔时间</td> 
   <td>默认1000，单位毫秒</td> 
  </tr> 
  <tr> 
   <td>server.recovery.timeoutRetryPeriod</td> 
   <td>超时状态检测重试线程间隔时间</td> 
   <td>默认1000，单位毫秒，检测出超时将全局事务置入回滚会话管理器</td> 
  </tr> 
  <tr> 
   <td>server.maxCommitRetryTimeout</td> 
   <td>二阶段提交重试超时时长</td> 
   <td>单位ms,s,m,h,d,对应毫秒,秒,分,小时,天,默认毫秒。默认值-1表示无限重试。公式: timeout&gt;=now-globalTransactionBeginTime,true表示超时则不再重试</td> 
  </tr> 
  <tr> 
   <td>server.maxRollbackRetryTimeout</td> 
   <td>二阶段回滚重试超时时长</td> 
   <td>同上</td> 
  </tr> 
  <tr> 
   <td>server.rollbackRetryTimeoutUnlockEnable</td> 
   <td>是否开启回滚重试超时后释放锁资源</td> 
   <td>默认false</td> 
  </tr> 
  <tr> 
   <td>server.undo.logSaveDays</td> 
   <td>undo日志保留天数</td> 
   <td>默认7天</td> 
  </tr> 
  <tr> 
   <td>server.undo.logDeletePeriod</td> 
   <td>undo清理线程间隔时间</td> 
   <td>默认86400000（24小时），单位毫秒</td> 
  </tr> 
 </tbody> 
</table>

#### 客户端 ####

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>描述</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>client.rm.asyncCommitBufferLimit</td> 
   <td>异步提交缓存队列长度</td> 
   <td>默认10000。 二阶段提交成功，RM异步清理undo队列</td> 
  </tr> 
  <tr> 
   <td>client.rm.lock.retryInterval</td> 
   <td>校验或占用全局锁重试间隔</td> 
   <td>默认10，单位毫秒</td> 
  </tr> 
  <tr> 
   <td>client.rm.lock.retryTimes</td> 
   <td>校验或占用全局锁重试次数</td> 
   <td>默认30ms</td> 
  </tr> 
  <tr> 
   <td>client.rm.lock.retryPolicyBranchRollbackOnConflict</td> 
   <td>分支事务与其它全局回滚事务冲突时锁策略</td> 
   <td>默认true，优先释放本地锁让回滚成功</td> 
  </tr> 
  <tr> 
   <td>client.rm.reportRetryCount</td> 
   <td>一阶段结果上报TC重试次数</td> 
   <td>默认5次</td> 
  </tr> 
  <tr> 
   <td>client.rm.tableMetaCheckEnable</td> 
   <td>自动刷新缓存中的表结构</td> 
   <td>默认false</td> 
  </tr> 
  <tr> 
   <td>client.rm.sqlParserType</td> 
   <td>SQL解析器</td> 
   <td>默认druid</td> 
  </tr> 
  <tr> 
   <td>client.rm.reportSuccessEnable</td> 
   <td>是否上报一阶段成功</td> 
   <td>true、false，从1.1.0版本开始,默认false.true用于保持分支事务生命周期记录完整，false可提高不少性能</td> 
  </tr> 
  <tr> 
   <td>client.rm.sagaBranchRegisterEnable</td> 
   <td>是否开启saga分支注册</td> 
   <td>默认false</td> 
  </tr> 
  <tr> 
   <td>client.tm.commitRetryCount</td> 
   <td>一阶段全局提交结果上报TC重试次数</td> 
   <td>默认1次，建议大于1</td> 
  </tr> 
  <tr> 
   <td>client.tm.rollbackRetryCount</td> 
   <td>一阶段全局回滚结果上报TC重试次数</td> 
   <td>默认1次，建议大于1</td> 
  </tr> 
  <tr> 
   <td>client.tm.defaultGlobalTransactionTimeout</td> 
   <td>全局事务超时时间</td> 
   <td>默认60000ms</td> 
  </tr> 
  <tr> 
   <td>client.tm.degradeCheck</td> 
   <td>是否服务自动降级策略</td> 
   <td>默认false ,为true时,开启自检线程.随后读取degradeCheckAllowTimes和degradeCheckPeriod,确认阈值与自检周期，都为默认值时，那么每2秒钟会进行一个begin,commit的测试,如果失败,则记录连续失败数,如果成功则清空连续失败数.连续错误由用户接口及自检线程进行累计,直到连续失败次数达到用户的阈值,则关闭Seata分布式事务,避免用户自身业务长时间不可用，反之,假如当前分布式事务关闭,那么自检线程继续按照2秒一次的自检,直到连续成功数达到用户设置的阈值,那么Seata分布式事务将恢复使用</td> 
  </tr> 
  <tr> 
   <td>client.tm.degradeCheckAllowTimes</td> 
   <td>升降级达标阈值</td> 
   <td>默认10</td> 
  </tr> 
  <tr> 
   <td>client.tm.degradeCheckPeriod</td> 
   <td>服务自检周期</td> 
   <td>默认2000,单位ms.每2秒进行一次服务自检,来决定</td> 
  </tr> 
  <tr> 
   <td>client.undo.dataValidation</td> 
   <td>二阶段回滚镜像校验</td> 
   <td>默认true开启，false关闭</td> 
  </tr> 
  <tr> 
   <td>client.undo.logSerialization</td> 
   <td>undo序列化方式</td> 
   <td>默认jackson</td> 
  </tr> 
  <tr> 
   <td>client.undo.onlyCareUpdateColumn</td> 
   <td>update操作回滚时，是否只更新update字段</td> 
   <td>默认true,默认seata回滚时对于原始update语句只回滚set 的update column ，false就意味着，回滚时会反向update 所有列字段，不管你原始语句是否更新过这个字段值。</td> 
  </tr> 
  <tr> 
   <td>client.undo.logTable</td> 
   <td>自定义undo表名</td> 
   <td>默认undo_log</td> 
  </tr> 
  <tr> 
   <td>client.log.exceptionRate</td> 
   <td>日志异常输出概率</td> 
   <td>默认100，目前用于undo回滚失败时异常堆栈输出，百分之一的概率输出，回滚失败基本是脏数据，无需输出堆栈占用硬盘空间</td> 
  </tr> 
  <tr> 
   <td>service.vgroupMapping.my_test_tx_group</td> 
   <td>事务群组</td> 
   <td>my_test_tx_group为分组，配置项值为TC集群名,事务分组是seata的资源逻辑，类似于服务实例。首先程序中配置了事务分组（GlobalTransactionScanner 构造方法的 txServiceGroup 参数），程序会通过用户配置的配置中心去寻找 service.vgroupMapping. 事务分组配置项，取得配置项的值就是 TC 集群的名称。拿到集群名称程序通过一定的前后缀+集群名称去构造服务名，各配置中心的服务名实现不同。拿到服务名去相应的注册中心去拉取相应服务名的服务列表，获得后端真实的 TC 服务列表。分组的含义就是映射到一套集群，所以你可以配一个分组也可以配置多个。</td> 
  </tr> 
  <tr> 
   <td>service.default.grouplist</td> 
   <td>TC服务列表</td> 
   <td>仅注册中心为file时使用，当registry.type=file时会用到，其他时候不读</td> 
  </tr> 
 </tbody> 
</table>

#### 存储 ####

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>描述</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>store.mode</td> 
   <td>事务会话信息存储方式</td> 
   <td>file本地文件(不支持HA)，db数据库</td> 
  </tr> 
  <tr> 
   <td>store.file.dir</td> 
   <td>file模式文件存储文件夹名</td> 
   <td>默认sessionStore</td> 
  </tr> 
  <tr> 
   <td>store.file.maxBranchSessionSize</td> 
   <td>最大分支会话大小</td> 
   <td>默认16384（16kb）</td> 
  </tr> 
  <tr> 
   <td>store.file.maxGlobalSessionSize</td> 
   <td>最大全局会话大小</td> 
   <td>默认512</td> 
  </tr> 
  <tr> 
   <td>store.file.fileWriteBufferCacheSize</td> 
   <td>文件缓冲区大小</td> 
   <td>默认16384（16kb）</td> 
  </tr> 
  <tr> 
   <td>store.file.flushDiskMode</td> 
   <td>刷新磁盘方式</td> 
   <td>async、sync，异步、同步</td> 
  </tr> 
  <tr> 
   <td>store.file.sessionReloadReadSize</td> 
   <td>会话重载读取大小</td> 
   <td>100</td> 
  </tr> 
  <tr> 
   <td>store.db.datasource</td> 
   <td>db模式数据源类型</td> 
   <td>dbcp、druid、hikari；无默认值，store.mode=db时必须指定。</td> 
  </tr> 
  <tr> 
   <td>store.db.dbType</td> 
   <td>db模式数据库类型</td> 
   <td>mysql、oracle、db2、sqlserver、sybaee、h2、sqlite、access、postgresql、oceanbase；无默认值，store.mode=db时必须指定。</td> 
  </tr> 
  <tr> 
   <td>store.db.driverClassName</td> 
   <td>db模式数据库驱动</td> 
   <td>com.mysql.jdbc.Driver</td> 
  </tr> 
  <tr> 
   <td>store.db.url</td> 
   <td>db模式数据库url</td> 
   <td>store.mode=db时必须指定，在使用mysql作为数据源时，建议在连接参数中加上rewriteBatchedStatements=true,由于seata是通过jdbc的executeBatch来批量插入全局锁的，根据MySQL官网的说明，连接参数中的rewriteBatchedStatements为true时，在执行executeBatch，并且操作类型为insert时，jdbc驱动会把对应的SQL优化成<code>insert into () values (), ()</code>的形式来提升批量插入的性能。</td> 
  </tr> 
  <tr> 
   <td>根据实际的测试，该参数设置</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>store.db.user</td> 
   <td>db模式数据库账户</td> 
   <td>store.mode=db时必须指定</td> 
  </tr> 
  <tr> 
   <td>store.db.password</td> 
   <td>db模式数据库账户密码</td> 
   <td>store.mode=db时必须指定</td> 
  </tr> 
  <tr> 
   <td>store.db.minConn</td> 
   <td>db模式数据库初始连接数</td> 
   <td>默认1</td> 
  </tr> 
  <tr> 
   <td>store.db.maxConn</td> 
   <td>db模式数据库最大连接数</td> 
   <td>默认20</td> 
  </tr> 
  <tr> 
   <td>store.db.globalTable</td> 
   <td>db模式全局事务表名</td> 
   <td>默认global_table</td> 
  </tr> 
  <tr> 
   <td>store.db.branchTable</td> 
   <td>db模式分支事务表名</td> 
   <td>默认branch_table</td> 
  </tr> 
  <tr> 
   <td>store.db.queryLimit</td> 
   <td>db模式查询全局事务一次的最大条数</td> 
   <td>默认100</td> 
  </tr> 
  <tr> 
   <td>store.db.lockTable</td> 
   <td>db模式全局锁表名</td> 
   <td>默认lock_table</td> 
  </tr> 
  <tr> 
   <td>store.db.maxWait</td> 
   <td>db模式获取连接时最大等待时间</td> 
   <td>默认5000，单位毫秒</td> 
  </tr> 
  <tr> 
   <td>store.redis.host</td> 
   <td>redis模式ip</td> 
   <td>默认127.0.0.1</td> 
  </tr> 
  <tr> 
   <td>store.redis.port</td> 
   <td>redis模式端口</td> 
   <td>默认6379</td> 
  </tr> 
  <tr> 
   <td>store.redis.maxConn</td> 
   <td>redis模式最大连接数</td> 
   <td>默认10</td> 
  </tr> 
  <tr> 
   <td>store.redis.minConn</td> 
   <td>redis模式最小连接数</td> 
   <td>默认1</td> 
  </tr> 
  <tr> 
   <td>store.redis.database</td> 
   <td>redis模式默认库</td> 
   <td>默认0</td> 
  </tr> 
  <tr> 
   <td>store.redis.password</td> 
   <td>redis模式密码(无可不填)</td> 
   <td>默认null</td> 
  </tr> 
  <tr> 
   <td>store.redis.queryLimit</td> 
   <td>redis模式一次查询最大条数</td> 
   <td>默认100</td> 
  </tr> 
 </tbody> 
</table>

#### 监控 ####

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>描述</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>metrics.enabled</td> 
   <td>是否启用Metrics</td> 
   <td>默认false关闭，在False状态下，所有与Metrics相关的组件将不会被初始化，使得性能损耗最低</td> 
  </tr> 
  <tr> 
   <td>metrics.registryType</td> 
   <td>指标注册器类型</td> 
   <td>Metrics使用的指标注册器类型，默认为内置的compact（简易）实现，这个实现中的Meter仅使用有限内存计数，性能高足够满足大多数场景；目前只能设置一个指标注册器实现</td> 
  </tr> 
  <tr> 
   <td>metrics.exporterList</td> 
   <td>指标结果Measurement数据输出器列表</td> 
   <td>默认prometheus，多个输出器使用英文逗号分割，例如"prometheus,jmx"，目前仅实现了对接prometheus的输出器</td> 
  </tr> 
  <tr> 
   <td>metrics.exporterPrometheusPort</td> 
   <td>prometheus输出器Client端口号</td> 
   <td>默认9898</td> 
  </tr> 
 </tbody> 
</table>