CM Agent Parameters

log_dir

Parameter description: Specifies the directory where CM Agent logs are stored. The value can be an absolute path, or a path relative to the CM Agent data directory.

Value range: a string. The modification takes effect after CM Agent is restarted. For details about how to modify this parameter, see Table 2.

Default value: "log", indicating that CM Agent logs are generated in the CM Agent data directory.

log_file_size

Parameter description: Specifies the size of a log file. If a log file exceeds the specified size, a new one is created to record log information.

Value range: an integer ranging from 0 to 2047. The unit is MB. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: 16MB

log_min_messages

Parameter description: Specifies which message levels are written to the CM Agent log. Each level covers all the levels following it. The lower the level is, the fewer messages will be written into the log.

Value range: enumerated type. Valid values are debug5, debug1, log, warning, error, and fatal. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: warning

incremental_build

Parameter description: Specifies whether a standby DN is incrementally built. If this parameter is enabled, a standby DN is incrementally built.

Value range: Boolean. The value can be on or off. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: on

alarm_component

Parameter description: Specifies the location of the alarm component that processes alarms.

Value range: a string. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

• If --alarm-type in the gs_preinstall script is set to 5, no third-party component is connected and alarms are written into system_alarm logs. In this case, the value of alarm_component is /opt/huawei/snas/bin/snas_cm_cmd.
• If --alarm-type in the gs_preinstall script is set to 1, a third-party component is connected. In this case, the value of alarm_component is the absolute path of the executable program of the third-party component.

Default value: /opt/huawei/snas/bin/snas_cm_cmd

alarm_report_interval

Parameter description: Specifies the interval at which an alarm is reported. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Value range: a non-negative integer (unit: s)

Default value: 1

alarm_report_max_count

Parameter description: Specifies the maximum number of times an alarm is reported. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Value range: a non-negative integer

Default value: 1

agent_report_interval

Parameter description: Specifies the interval at which CM Agent reports the instance status.

Value range: an integer. The unit is s. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: 1

agent_phony_dead_check_interval

Parameter description: Specifies the interval at which CM Agent checks whether the CN, DN, or GTM process is suspended.

Value range: an integer. The unit is s. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: 10

agent_check_interval

Parameter description: Specifies the interval at which the CM Agent queries the status of instances, such as the DNs, CN, and GTM.

Value range: an integer. The unit is s. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: 2

agent_heartbeat_timeout

Parameter description: Specifies the heartbeat timeout interval for CM Agent to connect to CM Server.

Value range: an integer ranging from 2 to 2³¹ – 1. The unit is second. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: 8

agent_connect_timeout

Parameter description: Specifies the time to wait before the attempt of CM Agent to connect to CM Server times out.

Value range: an integer. The unit is s. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: 1

agent_connect_retries

Parameter description: Specifies the number of times CM Agent tries to connect to the CM Server.

Value range: an integer. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: 15

agent_kill_instance_timeout

Parameter description: Specifies the interval from the time when CM Agent fails to connect to the primary CM Server to the time when CM Agent terminates all instances on the node.

Value range: an integer. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: 0, indicating that the operation of terminating all instances on the node is not initiated.

enable_gtm_phony_dead_check

Parameter description: Specifies whether to enable the GTM zombie check function.

Value range: an integer. The value 1 indicates that the zombie check is enabled, and the value 0 indicates that the zombie check is disabled. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: 1

security_mode

Parameter description: Specifies whether CNs and DNs are started in secure mode. If this parameter is set to on, CNs and DNs are started in secure mode.

Value range: Boolean. The value can be on or off. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: off

upgrade_from

Parameter description: Specifies the internal version number of the cluster before an in-place upgrade. Do not modify the value of this parameter.

Value range: a non-negative integer. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

The recommended value range is [0,Version number of the installation package].

Default value: 0

process_cpu_affinity

Parameter description: Specifies whether to bind a primary DN process to a CPU core before starting the process. If this parameter is set to 0, core binding will not be performed. If it is set to another value, core binding will be performed, and the number of physical CPU cores is 2ⁿ. Only Arm is supported.

Value range: an integer ranging from 0 to 2. The modification takes effect after CM Agent is restarted. For details about how to modify the parameter, see Table 2.

Default value: 0

enable_xc_maintenance_mode

Parameter description: Specifies whether the pgxc_node system catalog can be modified when the cluster is in read-only mode.

Value range: Boolean. The modification takes effect after CM Agent is restarted. For details about how to modify this parameter, see Table 2.

• on indicates that the pgxc_node system catalog can be modified.
• off indicates that the pgxc_node system catalog cannot be modified.

Default value: on

log_threshold_check_interval

Parameter description: Specifies the interval for compressing and clearing logs.

Parameter type: integer

Unit: second

Value range: 0 to 2³¹ – 1

Default value: 1800

Setting method: This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Setting suggestion: Retain the default value. You can adjust the value based on the disk space and scenario requirements.

dilatation_shard_count_for_disk_capacity_alarm

Parameter description: Specifies the number of shards to be added in the scale-out scenario. This parameter is used to calculate the threshold for reporting a disk capacity alarm.

The parameter value must be the same as the actual number of shards to be added.

Value range: an integer ranging from 0 to 2³¹ – 1. If this parameter is set to 0, the disk scale-out alarm is not reported. If this parameter is set to a value greater than 0, the disk scale-out alarm is reported and the threshold is calculated based on the number of shards specified by this parameter. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: 1

log_max_size

Parameter description: Specifies the maximum size of a log file.

Parameter type: integer

Unit: MB

Value range: 0 to 2³¹ – 1

Default value: 10240

Setting method: This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Setting suggestion: Retain the default value. You can adjust the value based on the disk space and scenario requirements.

log_max_count

Parameter description: Specifies the maximum number of logs that can be stored on hard disks.

Parameter type: integer

Unit: none

Value range: 0 to 10000

Default value: 10000

Setting method: This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Setting suggestion: Retain the default value. You can adjust the value based on the disk space and scenario requirements.

log_saved_days

Parameter description: Specifies the number of days for storing logs.

Parameter type: integer

Unit: day

Value range: 0 to 1000

Default value: 90

Setting method: This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Setting suggestion: Retain the default value. You can adjust the value based on the disk space and scenario requirements.

enable_log_compress

Parameter description: Specifies whether to enable log compression.

Value range: Boolean. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

• on indicates that log compression is enabled.
• off indicates that log compression is disabled.

Default value: on

enable_cn_auto_repair

Parameter description: Specifies whether to enable automatic CN recovery.

Parameter type: Boolean

Unit: none

Value range:

• on indicates that the automatic CN recovery is enabled. That is, after a CN is removed, the agent automatically attempts to recover the CN and add the CN back.
• off indicates that automatic CN recovery is disabled.

Default value: on

Setting method: This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Setting suggestion: This parameter is enabled by default after reloading. After it is disabled, CNs will not be automatically added. If you want to adjust the value, make sure you understand the parameter meaning and adjust the value with caution to avoid risks caused by misoperations.

agent_backup_open

Parameter description: Specifies whether to enable the DR cluster. After the DR cluster is enabled, the CM runs in DR cluster mode.

Value range: an integer, 0 or 1. The modification takes effect after CM Agent is restarted. For details about how to modify this parameter, see Table 2.

• 0: disabled.
• 1: enabled.

Default value: 0

enable_e2e_rto

Parameter description: Specifies whether to enable the E2E RTO function. After this function is enabled, the hang-up detection period and network detection timeout interval are shortened. The CM can reach the E2E RTO indicator (RTO for a single instance ≤ 10s; RTO for combined faults ≤ 30s).

Parameter type: integer.

Unit: none

Value range:

• 1: enabled.
• 0: disabled.

Default value:

Independent deployment: 1

Finance edition (standard), enterprise edition, and finance edition (data computing): 0

Setting method: Refer to the set cm parameters table in "Unified Database Management Tool > cm_ctl Tool Introduction" in Tool Reference. Then run the reload command for the settings to take effect.

Setting suggestion: Retain the default value. You can adjust the value based on the disk space and scenario requirements.

enable_dcf

Parameter description: Specifies the status of the DCF mode.

Value range: Boolean. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

• 0: disabled.
• 1: enabled.

Default value: off

unix_socket_directory

Parameter description: Specifies the directory location of the Unix socket.

Value range: a string. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: ''

disaster_recovery_type

Parameter description: Specifies the type of the DR relationship between the primary and standby clusters.

Value range: an integer ranging from 0 to 2. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

• 0 indicates that no DR relationship is established.
• 1 indicates that the OBS DR relationship is established.
• 2 indicates that the streaming DR relationship is established.

Default value: 0

environment_threshold

Parameter description: Specifies the thresholds for the physical environment and node status monitored by the agent. If the thresholds are exceeded, logs will be printed. The thresholds include the memory usage threshold, CPU usage threshold, disk usage threshold, instance memory usage threshold, and instance thread pool usage threshold.

Value range: a string, in the format of (0, 0, 0, 0). The value range for each number is [0,100]. The unit is %. Value 0 indicates that the detection is disabled. The modification of this parameter takes effect after reloading. For details about how to modify the parameter, see Table 2.

Default value: (0,0,0,0,0)