v5.0

cm_agent参数

log_dir

参数说明：log_dir决定存放cm_agent日志文件的目录。可以是绝对路径，或者是相对路径（相对于$GAUSSLOG的路径）。通过cm_ctl设置绝对路径时需要将路径用''把路径包含起来，例如：cm_ctl set --param --agent -k log_dir="'/log/dir'"。

取值范围：字符串，最大长度为1024。修改后需要重启cm_agent才能生效。参数修改请参考表 set cm参数进行设置。

默认值：“log”，表示在$GAUSSLOG下对应的cm目录下生成cm_agent日志。

log_file_size

参数说明：控制日志文件的大小。当cm_agent-xx-current.log日志文件达到指定大小时，则重新创建一个日志文件记录日志信息。

取值范围：整型，[0, 2047]，实际生效范围[1, 2047]，单位：MB。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：16MB。

log_min_messages

参数说明：控制写到cm_agent日志文件中的消息级别。每个级别都包含排在它后面的所有级别中的信息。级别越低，服务器运行日志中记录的消息就越少。

取值范围：枚举类型，有效值有debug5、debug1、warning、error、log、fatal（不区分大小写）。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：warning

incremental_build

参数说明：控制重建备节点模式是否为增量。打开这个开关，则增量重建备节点；否则，全量重建备节点。

取值范围：布尔型。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

on、yes、true、1：表示增量重建备节点。
off、no、false、0：表示全量重建备节点。

默认值：on

security_mode

参数说明：控制是否以安全模式启动节点。打开这个开关，则以安全模式启动节点；否则，以非安全模式启动节点。

取值范围：布尔型。修改后可以动态生效。参数修改请参考表 set cm参数进行设置。

on、yes、true、1：表示以安全模式启动节点。
off、no、false、0：表示以非安全模式启动节点。

默认值：off

upgrade_from

参数说明：就地升级过程中使用，用于标示升级前数据库的内部版本号，此参数禁止手动修改。

取值范围：非负整型，[0, 4294967295]。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：0

alarm_component

参数说明：在使用第一种告警方式时，设置用于处理告警内容的告警组件的位置。通过cm_ctl设置绝对路径时需要将路径用''把路径包含起来，例如：cm_ctl set --param --agent -k alarm_component="'/alarm/dir'"。

取值范围：字符串，最大长度为1024。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：/opt/huawei/snas/bin/snas_cm_cmd

alarm_report_interval

参数说明：指定告警上报的时间间隔。

取值范围：非负整型，[0, 2147483647]，单位：秒。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：1

agent_heartbeat_timeout

参数说明：cm_server心跳超时时间。

取值范围：整型，[2, 2147483647]，单位：秒。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：5

agent_connect_timeout

参数说明：cm_agent连接cm_server超时时间。

取值范围：整型，[0, 2147483647]，单位：秒。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：1

agent_connect_retries

参数说明：cm_agent连接cm_server尝试次数。

取值范围：整型，[0, 2147483647]。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：15

agent_kill_instance_timeout

参数说明：当cm_agent在无法连接cm_server主节点后，发起一次杀死本节点上所有实例的操作之前，所需等待的时间间隔。

取值范围：整型，[0, 2147483647]。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：0，不发起杀死本节点上所有实例的操作。

agent_report_interval

参数说明：cm_agent上报实例状态的时间间隔。

取值范围：整型，[0, 2147483647]。单位：秒。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：1

alarm_report_max_count

参数说明：指定告警上报的最大次数。

取值范围：非负整型，[1, 2592000]。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：1

agent_check_interval

参数说明：cm_agent查询实例状态的时间间隔。

取值范围：整型，[0, 2147483647]，单位：秒。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：2

enable_log_compress

参数说明：控制压缩日志功能。

取值范围：布尔型。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

on、yes、true、1：表示允许压缩日志。
off、no、false、0：表示不允许压缩日志。

默认值：on

process_cpu_affinity

参数说明：控制是否以绑核优化模式启动主节点进程。配置该参数为0，则不进行绑核优化；否则，进行绑核优化，且物理CPU片数为2n个。仅支持ARM。

取值范围：整型，[0, 2]。修改后需要重启数据库、cm_agent才能生效，参数修改请参考表 set cm参数进行设置。

默认值：0

enable_xc_maintenance_mode

参数说明：在数据库为只读模式下，控制是否可以修改pgxc_node系统表。

取值范围：布尔型。修改后需要重启cm_agent才能生效。参数修改请参考表 set cm参数进行设置。

on、yes、true、1：表示开启可以修改pgxc_node系统表功能。
off、no、false、0：表示关闭可以修改pgxc_node系统表功能。

默认值：on

log_threshold_check_interval

参数说明：cm日志压缩和清除的时间间隔，每1800秒压缩和清理一次。

生效范围：$GAUSSLOG/cm/cm_ctl；$GAUSSLOG/cm/cm_server；$GAUSSLOG/cm/om_monitor目录下的文件以及$GAUSSLOG/cm/cm_agent目录下以cm_agent-、system_call-、system_alarm-为前缀的日志文件。

取值范围：整型，[0, 2147483647]，单位：秒。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：1800

log_max_size

参数说明：控制cm日志最大存储值，当CM日志总大小超过（log_max_size95/100）MB时，根据压缩日志生成时间，依次删除历史压缩日志，直到日志总大小小于（log_max_size95/100）MB。

取值范围：整型，[0, 2147483647]，单位：MB。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：10240

log_max_count

参数说明：cm可存储的最多日志数量，当cm日志总个数超过该值，根据压缩日志文件名时间，删除超过保留天数log_saved_days的压缩日志。

取值范围：整型，[0, 10000]，单位：个。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：10000

log_saved_days

参数说明：cm压缩日志保存的天数，cm压缩日志超过该值并且cm日志总个数超过log_max_count，删除压缩日志。

取值范围：整型，[0, 1000]，单位天。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：90

须知： 日志压缩能力受限于内存限制，最多只能检测到30000个日志文件。总日志量超过30000个文件时，则无法保证日志能被正常压缩及删除。可以通过调整log_saved_days和log_threshold_check_interval快速清理已压缩日志文件。

agent_phony_dead_check_interval

参数说明：cm_agent检测进程是否僵死的时间间隔。

取值范围：整型，[0, 2147483647]，单位：秒。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：10

unix_socket_directory

参数说明：unix套接字的目录位置。通过cm_ctl设置绝对路径时需要将路径用''把路径包含起来，例如：cm_ctl set --param --agent -k unix_socket_directory="'/unix/dir'"。

取值范围：字符串，最大长度为1024。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：''

dilatation_shard_count_for_disk_capacity_alarm

参数说明：扩容场景下，设置新增的扩容分片数，用于上报磁盘容量告警时的阈值计算。

取值范围：整型，[0, 2147483647]，单位：个。该参数设置为0，表示关闭磁盘扩容告警上报；该参数设置为大于0，表示开启磁盘扩容告警上报，且告警上报的阈值根据此参数设置的分片数量进行计算。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：1

enable_dcf

参数说明：DCF模式开关。

取值范围：布尔型。修改后需要重启cm_agent才能生效。参数修改请参考表 set cm参数进行设置。

on、yes、true、1：表示启用dcf。
off、no、false、0：表示不启用dcf。

默认值：off

disaster_recovery_type

参数说明：主备数据库灾备关系的类型。

取值范围：整型，[0, 2]。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

0表示未搭建灾备关系。
1表示搭建了obs灾备关系。
2表示搭建了流式灾备关系

默认值：0

agent_backup_open

参数说明：灾备模式设置，开启后CM按照灾备模式运行。

取值范围：整型，[0, 2]。修改后需要重启cm_agent才能生效。参数修改请参考表 set cm参数进行设置。

0表示未搭建灾备关系。
1表示搭建了obs灾备关系（之后不再支持）。
2表示搭建了流式灾备关系。

默认值：0

disk_timeout

参数说明：磁盘心跳超时时间。

取值范围：整型，[0, 2147483647]，单位：秒。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

默认值：200

voting_disk_path

参数说明：投票盘路径。

取值范围：字符串，最大长度为1024。修改后需要重启cm_agent才能生效。参数修改请参考表 set cm参数进行设置。

默认值：无，需要安装时进行配置。

agent_rhb_interval

参数说明：cma节点间网络连通性检测周期。

取值范围：整型，[0, 2147483647]，单位：毫秒。修改后需要重启cm_agent才能生效。参数修改请参考表 set cm参数进行设置。

默认值：1000

enable_ssl

参数说明：ssl证书开关。

取值范围：布尔型。打开后使用ssl证书加密通信。修改后需要重启cm_agent才能生效。参数修改请参考表 set cm参数进行设置。

on、yes、true、1：表示启用ssl。
off、no、false、0：表示不启用ssl。
默认值：on

须知： 出于安全性考虑，建议不要关闭该配置。关闭后cm将不使用加密通信，所有信息明文传播，可能带来窃听、篡改、冒充等安全风险。

ssl_cert_expire_alert_threshold

参数说明：ssl证书过期告警时间。

取值范围：整型，[7, 180]，单位：天。证书过期时间少于该时间时，上报证书即将过期告警。修改后需要重启cm_agent才能生效，参数修改请参考表 set cm参数进行设置。

默认值：90

ssl_cert_expire_check_interval

参数说明：ssl证书过期检测周期。

取值范围：整型，[0, 2147483647]，单位：秒。修改后需要重启cm_agent才能生效，参数修改请参考表 set cm参数进行设置。

默认值：86400

enable_fence_dn

参数说明：cm_agent连不上任何除了自身节点的cms，并且自身节点cms不是Primary时，设置是否重启datanode进程。

取值范围：布尔型。修改后可以reload生效，参数修改请参考表 set cm参数进行设置。

on、yes、true、1：表示重启datanode进程。
off、no、false、0：表示不重启datanode进程。

默认值：off

event_triggers

参数说明：该参数用于定义事件触发器。

取值范围：以字符串表示的json类型。配置形式为：'{“trigger_type_1”:“trigger_value_1”,…,“trigger_type_n”:“trigger_value_n”}' 其中：

trigger_type为事件触发器类型，当前支持的事件触发器类型为：on_start、on_stop、on_failover、on_switchover trigger_value为发生对应事件时待执行的用户自定义触发器脚本

修改后重载cm_agent参数生效，参数修改请参考表 set cm参数进行设置。

自定义脚本的输出会重定向至cm_agent日志目录下的system-callxxx.log中。

默认值：''

约束条件：

trigger_value即自定义脚本，必须为真实存在的shell脚本，且为绝对路径，并且对当前用户至少有读取和执行权限。
使用cm_ctl set命令配置该参数时，参数值必须符合json格式，并且将json类型表示为字符串类型，中间不能包含换行和空格。
参数值最大长度为1024。

配置样例： '{“on_start”:"/dir/on_start.sh",“on_stop”:"/dir/on_stop.sh",“on_failover”:"/dir/on_failover.sh",“on_switchover”:"/dir/on_switchover.sh"}'

注意： 由于CM内部对各事件的执行均是异步执行，即将事件置于后台执行，所以CM在调用用户自定义的触发器脚本时，有可能事件还尚未执行完成，所以用户自定义触发器脚本中如果是需要等待事件完成后才执行动作的话，则需要在脚本中添加对应的状态检查，以确保事件完成。

db_service_vip

参数说明：数据库集群对外提供服务的VIP。

取值范围：字符串。修改后可以reload生效。参数修改请参考表 set cm参数进行设置。

默认值：无，安装时可选配置。

反馈