GTM相关参数
GTM相关参数可以在gtm.conf文件中进行设置，或通过gs_guc进行设置。
nodename
参数说明：主GTM或备GTM的名称。
参数类型：字符串
参数单位：无
取值范围：字符串，要符合标识符的命名规范。
默认值：""
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
port
参数说明：主GTM或备GTM侦听的主机端口号。
参数类型：整型
参数单位：无
取值范围：0 ~ 2147483647，建议设置为1024 ~ 65535。
默认值：6666
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
log_file
参数说明：日志文件名。
参数类型：字符串
参数单位：无
取值范围：字符串，要符合标识符的命名规范。
默认值："gtm-%Y-%m-%d_%H%M%S.log"
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
active_host
参数说明：目标GTM的地址。即在主GTM上时为备GTM的地址，在备GTM上时为主GTM的地址。该地址支持IPv4与IPv6格式。
参数类型：字符串
参数单位：无
取值范围：字符串，要符合标识符的命名规范。
默认值：""
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
local_host
参数说明：HA本地地址，根据集群配置文件进行设置，不需要手动设置。该地址支持IPv4与IPv6格式。
参数类型：字符串
参数单位：无
取值范围：字符串，要符合标识符的命名规范。
默认值：""
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
active_port
参数说明：目标GTM的服务器端口号。
参数类型：整型
参数单位：无
取值范围：0 ~ 2147483647，建议设置为1024 ~ 65535。
默认值：0
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：该参数由安装时的配置文件指定，请勿轻易修改，否则修改后会影响数据库正常通信。
local_port
参数说明：HA本地端口。
参数类型：整型
参数单位：无
取值范围：0 ~ 2147483647，建议设置为1024 ~ 65535。
默认值：0
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：该参数由安装时的配置文件指定，请勿轻易修改，否则修改后会影响数据库正常通信。
standby_connection_timeout
参数说明：设置GTM主备之间的超时时间。此参数控制GTM主备机之间的超时设置，增大该参数可以增加GTM主备之间的网络容错能力，但是也会增加故障场景下GTM主备断连的检测时长。
参数类型：整型
参数单位：s（秒）
取值范围：5 ~ 2147483647
默认值：5
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：设置过大时，可能无法及时检测到断连故障。
keepalives_count
参数说明：在支持TCP_KEEPCNT套接字选项的操作系统上，此参数控制GTM服务端在断开与客户端连接之前，等待未响应的保持活跃信号的最大数量。该参数仅在备GTM上生效。
参数类型：整型
参数单位：无
取值范围：0 ~ 2147483647
默认值：0，表示GTM未收到客户端反馈的保持活跃信号则立即断开连接。
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
keepalives_idle
参数说明：在支持TCP_KEEPIDLE套接字选项的操作系统上，此参数控制GTM服务端连接上客户端之后，如果没有数据发送，多长时间发送保持活跃信号。
参数类型：整型
参数单位：s（秒）
取值范围：0 ~ 2147483647
默认值：0
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
keepalives_interval
参数说明：在支持TCP_KEEPINTVL套接字选项的操作系统上，此参数控制GTM服务端保持活跃信号发送的时间间隔。
参数类型：整型
参数单位：s（秒）
取值范围：0 ~ 2147483647
默认值：0
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
synchronous_backup
参数说明：指定是否以同步方式备份到GTM备机。
参数类型：枚举类型
参数单位：无
取值范围：
- on：表示开启同步方式。
- off：表示关闭同步方式。
- auto：表示自动同步方式。
默认值：auto
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
query_memory_limit
参数说明：设置查询可以使用的内存百分比限制。该参数仅适用于默认资源组。对于其它的资源组，没有查询内存限制影响。
参数类型：浮点型
参数单位：无
取值范围：0.0 ~ 1.0
默认值：0.25
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
wlm_max_mem
参数说明：设置GTM执行时可使用的最大内存。
参数类型：整型
参数单位：MB
取值范围：512 ~ 2147483647
默认值：2048
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
config_file
参数说明：GTM配置文件名，仅sysadmin用户可以访问。
参数类型：字符串
参数单位：无
取值范围：合法的文件名称。
默认值："gtm.conf"
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
data_dir
参数说明：GTM数据文件目录。
参数类型：字符串
参数单位：无
取值范围：合法的目录路径。
默认值：""
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
listen_addresses
参数说明：声明服务器侦听客户端的TCP/IP地址。该地址支持IPv4与IPv6格式。
参数类型：字符串
参数单位：无
取值范围：
- 主机名或IP地址，多个值之间用英文逗号分隔。支持IPv4与IPv6格式。
- 星号（*）表示所有IP地址。
- 置空则服务器不会侦听任何IP地址，这种情况下，只有Unix域套接字可以用于连接数据库。
默认值："*"
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
log_directory
参数说明：当logging_collector设置为on时，log_directory决定存放服务器日志文件的目录。 它可以是绝对路径，或者是相对路径（相对于数据目录的路径）。
- 当配置文件中log_directory的值为非法路径（即用户对此路径无读写权限）时，会导致集群无法重新启动。
- 修改log_directory时，当指定路径为合法路径（即用户对此路径有读写权限）时，日志输出到新的路径下。当指定路径为非法路径时，日志输出到上一次的合法日志输出路径下而不影响数据库正常运行。此时即使指定的log_directory的值非法，也会写入到配置文件中。
参数类型：字符串
参数单位：无
取值范围：合法的目录路径。
默认值：“gtm_log”，表示在数据目录下的“gtm_log/”目录下生成服务器日志。
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
log_min_messages
参数说明：控制写到服务器日志文件夹下GTM日志文件中的消息级别，当产生该设置参数级别相等或更高级别的消息时，将这些信息记入日志文件。因此级别越低，服务器运行日志中记录的消息就越多。
参数类型：枚举类型
参数单位：无
取值范围：消息级别从低到高为debug5、debug4、debug3、debug2（debug）、debug1、info、notice、warning、error、log、fatal、panic。参数的详细信息请参见表1。
- debug的消息级别等效于debug2。
- 对于log_min_messages，log的消息级别高于error，低于fatal。
默认值：warning
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
alarm_component
参数说明：在对告警做上报时，会进行告警抑制，即同一个实例的同一个告警项在alarm_report_interval（默认值为10s）内不做重复上报。在这种情况下，该参数设置用于处理告警内容的告警组件的位置。
参数类型：字符串
参数单位：无
取值范围：
- 若前置脚本gs_preinstall中的--alarm-type参数设置为5，表示未对接第三方组件，告警写入system_alarm日志，此时GUC参数alarm_component的取值为：/opt/huawei/snas/bin/snas_cm_cmd。
- 若前置脚本gs_preinstall中的--alarm-type参数设置为1，表示对接第三方组件，此时GUC参数alarm_component的值为第三方组件的可执行程序的绝对路径。
默认值："/opt/huawei/snas/bin/snas_cm_cmd"
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
alarm_report_interval
参数说明：指定告警上报的时间间隔。
参数类型：整型
参数单位：s（秒）
取值范围：0 ~ 2147483647
默认值：10
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
standby_only
参数说明：是否强制同步信息到备机，在一主多备模式下只强制同步到ETCD。
参数类型：整型
参数单位：无
取值范围：
- 0：表示不强制同步信息到备机。
- 1：表示强制同步信息到备机。
默认值：0
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
gtm_max_trans
参数说明：设置gtm最大可接收连接数，不建议用户修改该参数。
参数类型：整型
参数单位：无
取值范围：256 ~ 200000
默认值：8192
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。如果需要改动，此参数不能小于（最大连接数+100）。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
enable_connect_control
参数说明：设置gtm开启连接控制，检测连接IP是否来自集群内部。
参数类型：布尔型
参数单位：无
取值范围：
- on：检测连接IP是否来自集群内部，非集群内部的IP连接则拒绝访问。
- off：不会检测连接IP是否来自集群内部。
默认值：on
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
gtm_authentication_type
参数说明：GTM模块端口认证方式。
参数类型：枚举类型
参数单位：无
取值范围：
- trust：表示未配置端口认证。
- gss：表示采用kerberos端口认证。
只有当kerberos服务端和客户端成功安装后才能修改为gss，否则GTM模块无法正常通信，将影响集群状态。
默认值：trust
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
gtm_krb_server_keyfile
参数说明：kerberos服务端key文件所在位置，需要配置为绝对路径。该文件通常为${GAUSSHOME}/kerberos路径下，以keytab格式结尾，文件名与集群运行所在用户名相同。与上述gtm_authentication_type参数是配对的，当gtm_authentication_type参数修改为gss时，该参数也必须配置为正确路径，否则将影响集群状态。
参数类型：字符串
参数单位：无
取值范围：合法的文件路径。
默认值：""
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
enable_gtm_free
参数说明：大并发场景下同一时刻存在活跃事务较多，GTM下发的快照变大且快照请求变多的情况下，瓶颈卡在GTM与CN通讯的网络上。为消除该瓶颈，引入GTM-FREE模式。取消CN和GTM的交互，取消CN下发GTM获取的事务信息给DN。CN只向各个DN发送query，各个DN由本地产生快照及xid等信息，开启该参数支持分布式事务读最终一致性，即分布式事务只有写外部一致性，不具有读外部一致性。
业务使用GTM-Free模式时，建议将application_type设置成perfect_sharding_type，以便及时发现可能导致数据不一致的SQL语句。否则，系统不会拦截可能导致数据不一致的语句，造成数据不一致。
参数类型：布尔型
参数单位：无
取值范围：
- on：表示开启GTM-FREE模式，集群状态为读最终一致性。
- off：表示非GTM-FREE模式。
默认值：off
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：GTM-FREE模式有可能出现数据不一致问题。
gtm_option
参数说明：GTM模式选项，用来指定选用的GTM模式，需要在GTM/CN/DN所有实例上配置，配置的值要一致，共三种模式：GTM模式，GTM-Lite模式，GTM-Free模式。其中GTM模式和GTM-Lite模式要在enable_gtm_free参数设置为off的情况下生效，当前版本暂不支持安装好的集群进行不同GTM模式之间的切换。这三种不同的GTM模式介绍，参见《开发指南》中“特性使用指导 > GTM > GTM模式”章节。
参数类型：整型
参数单位：无
取值范围：0 ~ 2
- 0：表示GTM模式；
- 1：表示GTM-Lite模式；
- 2：表示GTM-Free模式。
默认值：1
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
csn_sync_interval
参数说明：用来指定GTM主备之间同步CSN的时间间隔。
参数类型：整型
参数单位：s（秒）
取值范围：1 ~ 2147483647
默认值：1
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
restore_duration
参数说明：该参数用来指定GTM上XID或CSN的恢复间隔（个数）。
参数类型：整型
参数单位：无
取值范围：1000000 ~ 2147483647
默认值：1000000
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
gtm_enable_threadpool
参数说明：用来指定GTM是否开启GTM线程池功能，设置后需要重启才能生效。
参数类型：布尔型
参数单位：无
取值范围：
- true：表示开启GTM线程池功能。
- false：表示不开启GTM线程池功能。
默认值：true
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
gtm_num_threads
参数说明：当gtm_enable_threadpool线程池功能开启时，用来控制线程池工作线程的数量。
参数类型：整型
参数单位：无
取值范围：0 ~ 16384之间。该数值与gtm_max_trans大小相关，不应该超过（gtm_max_trans - 1 - 辅助线程数），其中辅助线程数当前版本为2。
默认值：1024
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：推荐使用默认值。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
check_gtm_primary_time
参数说明：该参数设置GTM检测其主节点与ETCD主节点一致性的时间间隔。
参数类型：整型
参数单位：s（秒）
取值范围：0 ~ 2147483647。0表示检测功能关闭，不进行检测。
默认值：2
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：根据业务需要进行设置。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
seq_cache_coefficient
参数说明：该参数用来指定GTM上sequence缓存的系数，该缓存系数用于计算sequence的恢复值。
参数类型：整型
参数单位：无
取值范围：3 ~ 20000
默认值：20000
设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。
设置建议：推荐使用默认值，最小值不能低于节点数。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
gtm_dcf_run_mode
参数说明：该参数设置GTM在使用DCC时，DCC的DCF运行模式。
参数类型：整型
参数单位：无
取值范围：0 ~ 2。0表示开启选举，1表示手动选举，2表示不开启选举。
默认值：2
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：此参数由CM设置，不建议手动设置或更改。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。可能导致不必要的主备切换或主备状态异常。
gtm_dcc_id
参数说明：该参数设置GTM在使用DCC时，本实例的DCC编号。
参数类型：整型
参数单位：无
取值范围：1 ~ 127
默认值：0
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：此参数由OM设置与维护，不允许用户修改。
设置不当的风险与影响：无。
gtm_dcf_extreme_mode
参数说明：该参数设置GTM在使用DCC时，DCC的DCF是否开启最大可用模式。
参数类型：整型
参数单位：无
取值范围：0 ~ 2。0表示最大保护模式，1表示最大可用模式，2表示最大性能模式。
默认值：0
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：此参数由CM设置，不建议手动设置或更改。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。可能影响业务的一致性。
gtm_dcf_static_leader_timeout
参数说明：该参数设置GTM在使用DCC时，优先等待DCF静态主或者原主升主的超时时间，主要用于集群启动阶段。
参数类型：整型
参数单位：无
取值范围：0 ~ 2147483647
默认值：0
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：此参数由CM或OM设置，不建议手动设置或更改。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。可能造成集群启动异常。
gtm_dcc_config
参数说明：该参数设置GTM在使用DCC时，DCC的集群配置信息。
参数类型：字符串
参数单位：无
取值范围：包含合法信息的json格式字符串。
默认值：""
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：此参数由OM设置与维护，不允许用户修改。
设置不当的风险与影响：无。
gtm_dcc_data_dir
参数说明：该参数设置GTM在使用DCC时，DCC的数据目录。
参数类型：字符串
参数单位：无
取值范围：有效的绝对路径。
默认值：""
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：此参数由OM设置与维护，不允许用户修改。
设置不当的风险与影响：无。
gtm_dcf_sync_nodes
参数说明：该参数设置GTM在使用DCC时，DCC之间的同步方式。
参数类型：字符串
参数单位：无
取值范围：
- ANY num_sync:standby1,standby2：指定复制备机的策略。ANY N:1,2,...表示任选“：”后面的N个备节点同步日志。
- FIRST num_sync:standby1,standby2：指定复制备机的策略。FIRST N:1,2,...表示按“：”后面顺序进行日志优先级同步。
其中num_sync指的需要把日志同步给备节点的数量，standby是备节点id。
默认值：""
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：此参数由CM或OM设置，不建议手动设置或更改。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。可能导致不必要的主备切换或主备状态异常。
gtm_dcf_candidate_nodes
参数说明：该参数设置GTM在使用DCC时，DCC的主节点候选者列表。
参数类型：字符串
参数单位：无
取值范围：以逗号分隔的数字。
默认值：""
设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。
设置建议：此参数由CM或OM设置，不建议手动设置或更改。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。可能导致不必要的主备切换或主备状态异常。
gtm_dcc_log_level
参数说明：该参数设置GTM在使用DCC时，DCC的日志打印级别。
参数类型：字符串
参数单位：无
取值范围：
- “NONE”：表示关闭日志打印，不能与以下日志级别混合使用。
- “RUN_ERR|RUN_WAR|RUN_INF|DEBUG_ERR|DEBUG_WAR|DEBUG_INF|TRACE|PROFILE|OPER”：表示开启对应级别日志。
默认值：“RUN_ERR|RUN_WAR|DEBUG_ERR|OPER|RUN_INF|PROFILE”
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：根据业务需要进行设置。
设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。
gtm_ddb
参数说明：该参数设置GTM当前使用ETCD还是DCC。
参数类型：字符串
参数单位：无
取值范围：etcd或dcc。
默认值：etcd
设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。
设置建议：此参数由OM在集群安装时设置，不允许安装后手动修改。
设置不当的风险与影响：无。
