# GTM相关参数
GTM相关参数可以在gtm.conf文件中进行设置，或通过gs_guc进行设置。
#### nodename
**参数说明：**主GTM或备GTM名称。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**字符串，要符合标识符命名规范（具体可参见《开发指南》中"SQL参考 \> 关键字"章节的"标识符命名规范"）。
**默认值：**NULL
#### port
**参数说明：**主GTM或备GTM侦听的主机端口号。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**整型，0～2147483647，建议设置为1024 \~ 65535。
**默认值：**6666
#### log_file
**参数说明：**日志文件名。
该参数属于SIGHUP类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**字符串，要符合标识符命名规范（具体可参见《开发指南》中"SQL参考 \> 关键字"章节的"标识符命名规范"）。
**默认值：**gtm-%Y-%m-%d_%H%M%S.log
#### active_host
**参数说明：**目标GTM的地址。即在主GTM上时为备GTM的地址，在备GTM上时为主GTM的地址。
该参数属于SIGHUP类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**字符串，要符合标识符命名规范（具体可参见《开发指南》中"SQL参考 \> 关键字"章节的"标识符命名规范"）。
**默认值：**NULL
#### local_host
**参数说明：**HA本地地址，根据集群配置文件进行设置，不需要手动设置。
该参数属于SIGHUP类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**字符串，要符合标识符命名规范（具体可参见《开发指南》中"SQL参考 \> 关键字"章节的"标识符命名规范"）。
**默认值：**NULL
#### active_port
**参数说明：**目标GTM的服务器端口号。
该参数属于SIGHUP类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**整型，0～2147483647，建议设置为1024 \~ 65535。
![](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/public_sys-resources/note_3.0-zh-cn.png)
该参数由安装时的配置文件指定，请勿轻易修改，否则修改后会影响数据库正常通信。
**默认值：**0
#### local_port
**参数说明：**HA本地端口。
该参数属于SIGHUP类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**整型，0～2147483647，建议设置为1024 \~ 65535。
![](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/public_sys-resources/note_3.0-zh-cn.png)
该参数由安装时的配置文件指定，请勿轻易修改，否则修改后会影响数据库正常通信。
**默认值：**0
#### standby_connection_timeout
**参数说明：**设置GTM主备之间的超时时间。此参数控制GTM主备机之间的超时设置，增大可以增加GTM主备之间的网络容错能力，但是也会增加故障场景下GTM主备断连的检测时长。
该参数属于SIGHUP类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**整型，5～2147483647（秒）。
**默认值：**5
#### keepalives_count
**参数说明：**在支持TCP_KEEPCNT套接字选项的操作系统上，设置GTM服务端在断开与客户端连接之前可以等待的保持活跃信号个数。该参数仅在备GTM上生效。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**整型，0～2147483647。
**默认值：**0，表示GTM未收到客户端反馈的保持活跃信号则立即断开连接。
#### keepalives_idle
**参数说明：**发送活跃信号的间隔秒数。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**整型，0～2147483647（秒）。
**默认值：**0
#### keepalives_interval
**参数说明：**在支持TCP_KEEPINTVL套接字选项的操作系统上，以秒数声明在重新传输之间等待响应的时间。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**整型，0～2147483647（秒）。
**默认值：**0
#### synchronous_backup
**参数说明：**指定是否以同步方式备份到GTM备机。
该参数属于SIGHUP类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**off/on/auto。
- on表示开启同步方式。
- off表示关闭同步方式。
- auto表示自动同步方式。
**默认值：**auto
#### query_memory_limit
**参数说明：**设置查询可以使用的内存百分比限制。该参数仅适用于默认资源组。对于其它的资源组，没有查询内存限制影响。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**0.0\~1.0。
**默认值：**0.25
#### wlm_max_mem
**参数说明：**设置GTM执行时可使用的最大内存。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**整型，512MB～2147483647。
**默认值：**2048
#### config_file
**参数说明：**GTM配置文件名，仅sysadmin用户可以访问。
**取值范围：** 字符串。请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**默认值：**gtm.conf
#### data_dir
**参数说明：**GTM数据文件目录。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**字符串。
**默认值：**NULL
#### listen_addresses
**参数说明：**声明服务器侦听客户端的TCP/IP地址。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**
- 主机名或IP地址，多个值之间用英文逗号分隔。
- 星号（\*）表示所有IP地址。
- 置空则服务器不会侦听任何IP地址，这种情况下，只有UNIX域套接字可以用于连接数据库。
**默认值：\***
#### log_directory
**参数说明：** 当[logging_collector](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1142.html#ZH-CN_TOPIC_0000002186711696__zh-cn_topic_0000002063771960_zh-cn_topic_0237124721_zh-cn_topic_0059778787_s61d6090c04ee464fb54f8b31936ba818)设置为on时，log_directory决定存放服务器日志文件的目录。 它可以是绝对路径，或者是相对路径（相对于数据目录的路径）。
该参数属于SIGHUP类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
![](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
- 当配置文件中log_directory的值为非法路径（即用户对此路径无读写权限）时，会导致集群无法重新启动。
- 修改log_directory时，当指定路径为合法路径（即用户对此路径有读写权限）时，日志输出到新的路径下。当指定路径为非法路径时，日志输出到上一次的合法日志输出路径下而不影响数据库正常运行。此时即使指定的log_directory的值非法，也会写入到配置文件中。
 
**取值范围：**字符串
**默认值：**"gtm_log"，表示在数据目录下的"gtm_log/"目录下生成服务器日志。
#### log_min_messages
**参数说明：**控制写到服务器日志文件中的消息级别。每个级别都包含排在它后面的所有级别中的信息。级别越低，服务器运行日志中记录的消息就越少。
![](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
当client_min_messages和log_min_messages取值相同时，其值所代表的级别不同。
**取值范围：** 枚举类型，有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1143.html#ZH-CN_TOPIC_0000002222151817__zh-cn_topic_0000002099772137_zh-cn_topic_0237124722_zh-cn_topic_0059778452_zh-cn_topic_0058967791_table55180162)。
**默认值：**warning
#### alarm_component
**参数说明：** 在对告警做上报时，会进行告警抑制，即同一个实例的同一个告警项在[alarm_report_interval]（默认值为10s）内不做重复上报。在这种情况下设置用于处理告警内容的告警组件的位置。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**字符串
- 若前置脚本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
 #### alarm_report_interval
**参数说明：**指定告警上报的时间间隔。
该参数属于SIGHUP类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**非负整型，单位为秒。
**默认值：**10
#### standby_only
**参数说明：**是否强制同步信息到备机，在一主多备模式下只强制同步到ETCD。
**取值范围：** 整型，取值为0或1，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
- 0表示不强制同步信息到备机。
- 1表示强制同步信息到备机。
**默认值：**0
#### gtm_max_trans
**参数说明：**设置gtm最大可接收连接数，不建议用户修改该参数。如果需要改动，此参数不能小于最大连接数加100。
**取值范围：** 整型，256\~200000，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**默认值：**8192
#### enable_connect_control
**参数说明：**设置gtm开启连接控制，检测连接IP是否来自集群内部。
**取值范围：** 布尔型，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
- true：检测连接IP是否来自集群内部，非集群内部的IP连接则拒绝访问。
- false：不检测连接IP是否来自集群内部。
**默认值**：true
#### gtm_authentication_type
**参数说明：**GTM模块端口认证方式，trust表示未配置端口认证，gss表示采用kerberos端口认证。必须注意的是：只有当kerberos服务端和客户端成功安装后才能修改为gss，否则GTM模块无法正常通信，将影响集群状态。
该参数属于SIGHUP类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**枚举类型，有效值有trust, gss。
**默认值**：trust
#### gtm_krb_server_keyfile
**参数说明：**kerberos服务端key文件所在位置，需要配置为绝对路径。该文件通常为${GAUSSHOME}/kerberos路径下，以keytab格式结尾，文件名与集群运行所在用户名相同。与上述gtm_authentication_type参数是配对的，当gtm_authentication_type参数修改为gss时，该参数也必须配置为正确路径，否则将影响集群状态。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：字符串类型**
**默认值**：''
#### gtm_option
**参数说明：**GTM模式选项，用来指定选用的GTM模式，需要在GTM，CN，DN所有实例上配置，配置的值要一致，共三种模式：GTM模式，GTM-Lite模式，GTM-Free模式。其中GTM模式和GTM-Lite模式要在enable_gtm_free参数设置为off的情况下生效，当前版本暂不支持安装好的集群进行不同GTM模式之间的切换。
**取值范围：** 整型，0\~2，0表示GTM模式，1表示GTM-Lite模式，2表示GTM-Free模式。请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**默认值**：1
#### csn_sync_interval
**参数说明：**用来指定GTM主备之间同步CSN的时间间隔，单位为秒（s）。
**取值范围：** 整型，1\~2147483647‬之间。请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**默认值**：1
#### restore_duration
**参数说明：**用来指定gtm上xid或csn的回复间隔（个数）。
**取值范围：** 整型，1000000\~2147483647‬之间。请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**默认值**：1000000
#### gtm_enable_threadpool
**参数说明：**用来指定GTM是否开启GTM线程池功能，设置后需要重启才能生效。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**布尔型。
**默认值**：true
#### gtm_num_threads
**参数说明：**当gtm_enable_threadpool线程池功能开启时，用来控制线程池工作线程的个数。
该数值与gtm_max_trans大小相关，不应该超过（gtm_max_trans - 1 - 辅助线程数），其中辅助线程数当前版本为2。
该参数属于POSTMASTER类型参数，请参考[表1](https://support.huaweicloud.com/distributed-devg-v2-gaussdb/gaussdb-12-1111.html#ZH-CN_TOPIC_0000002222151777__zh-cn_topic_0000002099772105_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。
**取值范围：**整型，0\~16384之间。
**默认值**：1024