HomeMogDBMogDB StackUqbar
v5.0

Documentation:v5.0

Supported Versions:

Other Versions:

cm_agent Parameters

log_dir

Parameter description: Specifies the directory where cm_agent logs are stored. It can be specified as an absolute path, or a path relative to $GAUSSLOG. When you set an absolute path using cm_ctl, the path must be included in quotation marks (''), for example, cm_ctl set --param --agent -k log_dir="'/log/dir'".

Value range: a string of up to 1024 characters. Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: log, indicating that the cm_agent log is generated in the CM directory in $GAUSSLOG.

log_file_size

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

Value range: an integer ranging from 0 to 2047. The actual value range that takes effect is from 1 to 2047 (MB). Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: 16 MB

log_min_messages

Parameter description: Specifies which message levels are written to the cm_agent log. A higher level covers the messages of all the lower levels. The lower the level is, the fewer messages will be written into the log.

Value range: enumerated type. Valid values are debug5, debug1, warning, error, log, and fatal (case-insensitive). Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: warning

incremental_build

Parameter description: Specifies whether a standby node is incrementally built. If this parameter is enabled, a standby node is incrementally rebuilt. Otherwise, a standby node is fully rebuilt.

Value range: Boolean Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

  • on, yes, true, or 1: A standby node is incrementally rebuilt.
  • off, no, false, or 0: A standby node is fully rebuilt.

Default value: on

security_mode

Parameter description: Specifies whether nodes are started in secure mode. If this parameter is enabled, nodes are started in secure mode. Otherwise, nodes are started in non-secure mode.

Value range: Boolean The modification of this parameter takes effect dynamically. For details, see Options of set cm.

  • on, yes, true, or 1: Nodes are started in secure mode.
  • off, no, false, or 0: Nodes are started in non-secure mode.

Default value: off

upgrade_from

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

Value range: a non-negative integer, in the range [0,4294967295]. Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: 0

alarm_component

Parameter description: Sets the position of the alarm component that handles alarms if the first mode is used. When you set an absolute path using cm_ctl, the path must be included in quotation marks (''), for example, cm_ctl set --param --agent -k alarm_component="'/alarm/dir'".

Value range: a string of up to 1024 characters. Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

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

alarm_report_interval

Parameter description: specifies the interval at which an alarm is reported.

Value range: a non-negative integer, in the range [0,2147483647] (unit: second). The modification of this parameter takes effect after reloading. For details, see Options of set cm.

Default value: 1

agent_heartbeat_timeout

Parameter description: Specifies the time to wait before the cm_server heartbeat times out.

Value range: an integer, in the range [2,2147483647] (unit: second). Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: 5

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, in the range [0,2147483647] (unit: second). Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

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, in the range [0,2147483647]. Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

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 kills all instances on the node.

Value range: an integer, in the range [0,2147483647]. Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

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

agent_report_interval

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

Value range: an integer, in the range [0,2147483647]. Unit: second. Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: 1

alarm_report_max_count

Parameter description: Specifies the maximum number of times an alarm is reported.

Value range: a non-negative integer, in the range [1,2592000]. The modification of this parameter takes effect after reloading. For details, see Options of set cm.

Default value: 1

agent_check_interval

Parameter description: Specifies the interval at which cm_agent queries for the status of instances.

Value range: an integer, in the range [0,2147483647] (unit: second). Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: 2

enable_log_compress

Parameter description: Specifies whether to enable log compression.

Value range: Boolean Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

  • on, yes, true, or 1: Log compression is allowed.
  • off, no, false, or 0: Log compression is not allowed.

Default value: on

process_cpu_affinity

Parameter description: Specifies whether to bind a primary node process to a CPU core before starting the process. If this parameter is set to 0, core binding is not performed. If it is set to another value, core binding is performed, and the number of physical CPU cores is 2n. Restart the database and cm_agent for the modification to take effect. Only ARM is supported. For details, see Options of set cm.

Value range: an integer, in the range [0,2].

Default value: 0

enable_xc_maintenance_mode

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

Value range: Boolean The modification of this parameter takes effect after reloading. For details, see Options of set cm.

  • on, yes, true, or 1: The function of modifying the pgxc_node system catalog is enabled.
  • off, no, false, or 0: disables the function of modifying the pgxc_node system catalog.

Default value: on

log_threshold_check_interval

Parameter description: Specifies the interval for compressing and clearing CM logs. Typically, this interval is set to 1800s.

Application scope: Files in the $GAUSSLOG/cm/cm_ctl, $GAUSSLOG/cm/cm_server, and $GAUSSLOG/cm/om_monitor directories and log files prefixed with cm_agent-, system_call-, and system_alarm- in the $GAUSSLOG/cm/cm_agent directory.

Value range: an integer, in the range [0,2147483647] (unit: second). Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: 1800

log_max_size

Parameter description: Specifies the maximum size of CM logs. When the total size of CM logs exceeds (log_max_size x 95/100) MB, historical compressed logs are deleted in sequence based on the log generation time until the total size is less than (log_max_size x 95/100) MB.

Application scope: Files in the $GAUSSLOG/cm/cm_ctl, $GAUSSLOG/cm/cm_server, and $GAUSSLOG/cm/om_monitor directories and log files prefixed with cm_agent-, system_call-, and system_alarm- in the $GAUSSLOG/cm/cm_agent directory.

Value range: an integer, in the range [0,2147483647] (unit: MB). Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: 10240

log_max_count

Parameter description: Specifies the maximum number of CM logs that can be stored. When the total number of CM logs exceeds the value of this parameter, historical compressed logs that have been stored for more than the value of log_saved_days based on the generation time in the log file name.

Application scope: Files in the $GAUSSLOG/cm/cm_ctl, $GAUSSLOG/cm/cm_server, and $GAUSSLOG/cm/om_monitor directories and log files prefixed with cm_agent-, system_call-, and system_alarm- in the $GAUSSLOG/cm/cm_agent directory.

Value range: an integer, in the range [0,10000]. Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: 10000

log_saved_days

Parameter description: Specifies the number of days for storing compressed CM logs. If the number of compressed logs exceeds the value of this parameter and the total number of CM logs exceeds the value of log_max_count, the compressed logs are deleted.

Application scope: Files in the $GAUSSLOG/cm/cm_ctl, $GAUSSLOG/cm/cm_server, and $GAUSSLOG/cm/om_monitor directories and log files prefixed with cm_agent-, system_call-, and system_alarm- in the $GAUSSLOG/cm/cm_agent directory.

Value range: an integer, in the range [0,1000] (unit: day). Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: 90

agent_phony_dead_check_interval

Parameter description: Specifies the interval at which cm_agent checks whether the process is suspended.

Value range: an integer, in the range [0,2147483647] (unit: second). Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: 10

unix_socket_directory

Parameter description: Specifies the directory location of the Unix socket. When you set an absolute path using cm_ctl, the path must be included in quotation marks (''), for example, cm_ctl set --param --agent -k unix_socket_directory="'/unix/dir'".

Value range: a string of up to 1024 characters. Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: ''

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.

Value range: an integer, in the range [0,2147483647]. 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. Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

Default value: 1

enable_dcf

Parameter description: Specifies the status of the DCF mode.

Value range: Boolean Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

  • on, yes, true, or 1: The DCF function is enabled.
  • off, no, false, or 0: The DCF function is disabled.

Default value: off

disaster_recovery_type

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

Value range: an integer, in the range [0,2]. Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

  • 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

agent_backup_open

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

Value range: an integer, in the range [0,2]. Any modification of this parameter takes effect only after cm_agent is restarted. For details, see Options of set cm.

  • 0 indicates that no DR relationship is established.
  • 1 indicates that the OBS DR relationship is established (not supported later versions).
  • 2 indicates that the streaming DR relationship is established.

Default value: 0

enable_fence_dn

Parameter description: Specifies whether to restart the DN process when cm_agent cannot connect to any CMS except its own CMS which is not primary.

Value range: Boolean The modification of this parameter takes effect after reloading. For details, see Options of set cm.

  • on, yes, true, or 1: The DN process is restarted.
  • off, no, false, or 0: The DN process is not restarted.

Default value: off

Copyright © 2011-2024 www.enmotech.com All rights reserved.