负载管理

use_workload_manager

参数说明：是否开启资源管理功能。此参数需在CN和DN同时应用。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示打开资源管理。
• off表示关闭资源管理。
  

  • 当使用表1中的方式二来修改参数值时，新参数值只能对更改操作执行后启动的线程生效。此外，对于后台线程以及线程复用执行的新作业，该参数值的改动不会生效。如果希望这类线程即时识别参数变化，可以使用kill session或重启节点的方式来实现。
  • use_workload_manager参数由off变为on状态后，不会统计off时的存储资源。如果需要统计off时用户使用的存储资源，请在数据库中执行以下命令：

    1	select gs_wlm_readjust_user_space(0);

默认值：on

enable_control_group

参数说明：是否开启Cgroups功能。此参数需在CN和DN同时应用。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示打开Cgroups管理。
• off表示关闭Cgroups管理。

默认值：on

当使用表1中的方式二来修改参数值时，新参数值只能对更改操作执行后启动的线程生效。此外，对于后台线程以及线程复用执行的新作业，该值的改动不会生效。如果希望这类线程即时识别参数变化，可以使用kill session或重启节点的方式来实现。

enable_backend_control

参数说明：是否控制数据库常驻线程到DefaultBackend控制组。此参数需在CN和DN同时应用。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示控制常驻线程到DefaultBackend控制组。
• off表示不控制常驻线程到DefaultBackend控制组。

默认值：on

enable_vacuum_control

参数说明：是否控制数据库常驻线程autoVacuumWorker到Vacuum控制组。此参数需在CN和DN同时应用。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示控制数据库常驻线程autoVacuumWorker到Vacuum控制组。
• off表示不控制数据库常驻线程autoVacuumWorker到Vacuum控制组。

默认值：on

enable_perm_space

参数说明：是否开启perm space功能。此参数需在CN和DN同时应用。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示打开perm space管理。
• off表示关闭perm space管理。

默认值：on

enable_verify_active_statements

参数说明：在静态自适应负载场景下，是否开启后台校准功能。此参数需在CN上应用。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示打开后台校准功能。
• off表示关闭后台校准功能。

默认值：on

max_active_statements

参数说明：设置全局的最大并发数量。此参数只应用到CN，且针对一个CN上的执行作业。

数据库管理员需根据系统资源（如CPU资源、IO资源和内存资源）情况，调整此数值大小，使得系统支持最大限度的并发作业，且防止并发执行作业过多，引起系统崩溃。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，-1 ～ 2147483647‬。设置为-1和0表示对最大并发数不做限制。

parctl_min_cost

参数说明：设置语句受到资源池并发控制（当前特性是实验室特性，使用时请联系华为工程师提供技术支持）的最小执行代价。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，-1 ～ 2147483647‬

• 值为-1时或者执行语句的代价小于10时，不受资源池并发控制。
• 值大于等于0时，当enable_dynamic_workload为off时，如果执行语句的代价大于或等于10并且超过这个参数值就会受到资源池并发控制。

默认值：100000

cgroup_name

参数说明：设置当前使用的Cgroups的名称或者调整当前group下排队的优先级。

即如果先设置cgroup_name，再设置session_respool，那么session_respool关联的控制组起作用，如果再切换cgroup_name，那么新切换的cgroup_name起作用。

切换cgroup_name的过程中如果指定到Workload控制组级别，数据库不对级别进行验证。级别的范围只要在1-10范围内都可以。

该参数属于USERSET类型参数，请参考表1中方式三的方法进行设置。

建议尽量不要混合使用cgroup_name和session_respool。

取值范围：字符串

默认值：DefaultClass:Medium

DefaultClass:Medium表示DefaultClass下Timeshare控制组中的Medium控制组。

cpu_collect_timer

参数说明：设置语句执行时在DN上收集CPU时间的周期。

数据库管理员需根据系统资源（如CPU资源、IO资源和内存资源）情况，调整此数值大小，使得系统支持较合适的收集周期，太小会影响执行效率，太大会影响异常处理的精确度。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，1 ～ 2147483647‬， 单位为秒。

默认值：30

enable_cgroup_switch

参数说明：是否控制数据库执行语句时根据类型自动切换到TopWD组。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示控制数据库执行语句时根据类型自动切换到TopWD组。
• off表示控制数据库执行语句时根据类型不自动切换到TopWD组。

默认值：off

memory_tracking_mode

参数说明：设置记录内存信息的模式。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：

• none，不启动内存统计功能。
• peak, 统计query级内存peak值；此数值记入数据库log，也可由explain analyze输出。
• normal，仅做内存实时统计，不生成文件。
• executor，生成统计文件，包含执行层使用过的所有已分配内存的上下文信息。
• fullexec，生成文件包含执行层申请过的所有内存上下文信息。

默认值：none

memory_detail_tracking

参数说明：设置需要的线程内分配内存上下文的顺序号以及当前线程所在query的plannodeid，仅用在DEBUG版本。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：字符型

默认值：Memory Context Sequent Count: -1, Plan Nodeid: -1（即空字符串，无sequent count和plan nodeid信息）

该参数不允许用户进行设置，建议保持默认值。

enable_resource_track

参数说明：是否开启资源实时监控功能。此参数需在CN和DN同时应用。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示打开资源监控。
• off表示关闭资源监控。

默认值：on

enable_resource_record

参数说明：是否开启资源监控记录归档功能。开启时，对于history视图（GS_WLM_SESSION_HISTORY和GS_WLM_OPERATOR_HISTORY）中的记录，每隔3分钟会分别被归档到相应的info视图（GS_WLM_SESSION_INFO和GS_WLM_OPERATOR_INFO），归档后history视图中的记录会被清除。此参数需在CN和DN同时应用。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示开启资源监控记录归档功能。
• off表示关闭资源监控记录归档功能。

默认值：off

enable_logical_io_statistics

参数说明：设置是否开启资源监控逻辑IO统计功能。开启时，对于PG_TOTAL_USER_RESOURCE_INFO视图中的read_kbytes、write_kbytes、read_counts、write_counts、read_speed和write_speed字段，会统计对应用户的逻辑读写字节数、次数以及速率；对于GS_WLM_USER_RESOURCE_HISTORY与GS_WLM_INSTANCE_HISTORY系统表中的逻辑读写相关字段，会统计相关用户、实例的逻辑读写对应值。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示开启资源监控逻辑IO统计功能。
• off表示关闭资源监控逻辑IO统计功能。

默认值：on

enable_user_metric_persistent

参数说明：设置是否开启用户历史资源监控转存功能。开启时，对于PG_TOTAL_USER_RESOURCE_INFO视图中数据，会定期采样保存到GS_WLM_USER_RESOURCE_HISTORY系统表中。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

● on表示开启用户历史资源监控转存功能。

● off表示关闭用户历史资源监控转存功能。

默认值：on

user_metric_retention_time

参数说明：设置用户历史资源监控数据的保存天数。该参数仅在 enable_user_metric_persistent为on时有效。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，0 ～ 3650，单位为天。

● 值等于0时，用户历史资源监控数据将永久保存。

● 值大于0时，用户历史资源监控数据将保存对应天数。

默认值：7

enable_instance_metric_persistent

参数说明：设置是否开启实例资源监控转存功能。开启时，对实例的监控数据会保存到GS_WLM_INSTANCE_HISTORY系统表中。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示开启实例资源监控转存功能。
• off表示关闭实例资源监控转存功能。

默认值：on

instance_metric_retention_time

参数说明：设置实例历史资源监控数据的保存天数。该参数仅在enable_instance_metric_persistent为on时有效。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，0 ～3650，单位为天。

• 值等于0时，实例历史资源监控数据将永久保存。
• 值大于0时，实例历史资源监控数据将保存对应设置天数。

默认值：7

resource_track_level

参数说明：设置当前会话的资源监控的等级。该参数只有当参数enable_resource_track为on时才有效。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：枚举型

• none，不开启资源监控功能。
• query，开启query级别资源监控功能。
• operator，开启query级别和算子级别资源监控功能。

默认值：query

resource_track_cost

参数说明：设置对当前会话的语句进行资源监控的最小执行代价。该参数只有当参数enable_resource_track为on时才有效。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，-1 ～ 2147483647‬

• 值为-1时，不进行资源监控。
• 值大于或等于0时：
  • 值大于或等于0且小于等于9时，对执行代价大于等于10的语句进行资源监控。
  • 值大于或等于10时，对执行代价超过该参数值的语句进行资源监控。

默认值：100000

resource_track_duration

参数说明：设置资源监控实时视图中记录的语句执行结束后进行历史信息转存的最小执行时间。当执行完成的作业，其执行时间不小于此参数值时，作业信息会从实时视图（以statistics为后缀的视图）转存到相应的历史视图（以history为后缀的视图）中。该参数只有当enable_resource_track为on时才有效。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，0 ～ 2147483647‬，单位为秒。

• 值为0时，资源监控实时视图中记录的所有语句都进行历史信息归档。
• 值大于0时，资源监控实时视图中记录的语句的执行时间超过这个值就会进行历史信息归档。

默认值：1min

dynamic_memory_quota

参数说明：自适应负载场景下，设置内存控制的比重，即可以使用系统最大可用内存的比例。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，1 ～ 100

默认值：80

disable_memory_protect

参数说明：禁止内存保护功能。当系统内存不足时如果需要查询系统视图，可以先将此参数置为on，禁止内存保护功能，保证视图可以正常查询。该参数只适用于在系统内存不足时进行系统诊断和调试，正常运行时请保持该参数配置为off。

该参数属于USERSET类型参数，且只对当前会话有效。请参考表1中方式三的方法进行设置。

取值范围：布尔型

• on表示禁止内存保护功能。
• off表示启动内存保护功能。

默认值：off

query_band

参数说明：用于标示当前会话的作业类型，由用户自定义。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：字符型

默认值：空

enable_bbox_dump

参数说明：是否开启黑匣子功能，在系统不配置core机制的时候仍可产生core文件。此功能只对CN或DN有效，CMA、CMS、GTM、fenced UDF等仍需配置系统core机制才能捕获core文件。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示打开黑匣子功能。
• off表示关闭黑匣子功能。

默认值：on

黑匣子功能生成core文件依赖操作系统开放ptrace接口；若发生权限不足(errno = 1)，请确保/proc/sys/kernel/yama/ptrace_scope配置合理。

enable_ffic_log

参数说明：是否开启FFIC(First Failure Info Capture)功能。此功能只对CN或DN有效，CMA、CMS、GTM、fenced UDF等仍需配置系统core机制才能捕获core文件。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示打开FFIC功能。
• off表示关闭FFIC功能。

默认值：on

enable_dynamic_workload

参数说明：是否开启动态负载管理功能。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示打开动态负载管理功能。
• off表示关闭动态负载管理功能。

• 开启内存自适应后，不再需要使用work_mem进行算子内存使用调优，由系统根据当前负载情况，为每个语句生成计划，并估算每个算子的内存使用量和整个语句的内存使用量。系统根据负载情况和整个语句内存使用量进行队列调度，所以多并发场景会出现语句排队的情况。
• 由于优化器行数估算不准现象的存在，会出现语句内存使用量低估或高估的情况。低估时，执行时内存会自动扩展。高估时，会导致系统内存利用不足，排队语句增多，可能导致性能非最优。此时需要识别语句估算内存远大于实际DN峰值内存的语句，通过设置query_mem进行调优，详见SQL调优关键参数调整。
• 列存分区表导入会消耗较多内存资源，为性能敏感场景，故不推荐启用动态负载管理。

enable_acceleration_cluster_wlm

由于规格变更，当前版本已经不再支持本特性，请不要使用。

参数说明：是否开启加速集群的动态负载管理功能。该参数只针对计算资源池有效；在集群中设置该参数为on并不会启用相关逻辑。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示打开加速集群的动态负载管理功能。
• off表示关闭加速集群的动态负载管理功能。

默认值：off

enable_dywlm_adjust

参数说明：是否开启动态调整不准确资源值的功能。此功能需要在CN和DN同时应用。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示打开资源值动态调整功能。
• off表示关闭资源值动态调整功能。

默认值：on

enable_force_memory_control

参数说明：是否开启资源池下并发控制（当前特性是实验室特性，使用时请联系华为工程师提供技术支持）时基于内存的使用来管控简单查询的功能。此功能需要在CN和DN同时应用。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示管控简单查询。
• off表示忽略简单查询。

默认值：off

enable_reaper_backend

参数说明：是否启用单独线程来回收子线程退出时的信号。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示开启此功能。
• off表示关闭此功能。

默认值：on

memory_fault_percent

参数说明：内存故障测试时内存申请失败的比例，仅用在DEBUG版本。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，0~2147483647

默认值：0

bbox_dump_count

参数说明：在bbox_dump_path定义的路径下，允许存储的GaussDB所产生core文件最大数。超过此数量，旧的core文件会被删除。此参数只有当enable_bbox_dump为on时才生效。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，1～20

默认值：8

在并发产生core文件时，core文件的产生个数可能大于bbox_dump_count。

bbox_dump_path

参数说明：黑匣子core文件的生成路径。此参数只有当enable_bbox_dump为on时才生效。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：字符型

默认值：空。默认生成黑匣子core文件的路径为读取/proc/sys/kernel/core_pattern下的路径，如果这个路径不是一个目录，或者用户对此目录没有写权限，黑匣子core文件将生成在数据库的data目录下。

bbox_blanklist_items

参数说明：黑匣子core文件的脱敏数据选项。此参数只有当enable_bbox_dump为on时才生效。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

取值范围：字符型，以逗号分隔的敏感数据选项的字符串。

默认值：空。表示bbox生成的core文件脱敏所有支持的敏感数据项。

目前支持脱敏的数据项：

• SHARED_BUFFER：buffer数据缓冲区
• XLOG_BUFFER：redo日志缓冲区
• DW_BUFFER：双写数据缓冲区
• XLOG_MESSAGE_SEND：主备日复制日志发送缓冲区
• WALRECIVER_CTL_BLOCK：主备复制日志接收缓冲区
• DATA_MESSAGE_SEND：主备复制数据发送缓冲区
• DATA_WRITER_QUEUE：主备复制数据接收缓冲区

bypass_workload_manager

参数说明：IO管控独立开关，此参数需在CN和DN同时应用。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

在不开启use_workload_manager的情况下，通过此参数单独的控制IO管控功能的开启。打开之后可通过设置io_limits或io_priority进行IO管控。

取值范围：布尔型

• on表示打开IO管控的独立开关。
• off表示关闭IO管控的独立开关。

io_limits

参数说明：每秒触发IO的上限。

该参数属于USERSET类型参数，请参考表1中方式三的方法进行设置。

取值范围：整型，0～1073741823

默认值：0

io_priority

参数说明：IO利用率高达50%时，重消耗IO作业进行IO资源管控时关联的优先级等级。

该参数属于USERSET类型参数，请参考表1中方式三的方法进行设置。

取值范围：枚举型

• None: 表示不受控。
• Low: 表示限制iops为该作业原始触发数值的10%。
• Medium: 表示限制iops为该作业原始触发数值的20%。
• High: 表示限制iops为该作业原始触发数值的50%。

默认值：None

io_control_unit

参数说明：行存场景下，io管控时用来对io次数进行计数的单位，此参数需在CN和DN同时应用。

该参数属于SIGHUP类型参数，请参考表1中方式三的方法进行设置。

记多少次io触发为一计数单位，通过此计数单位所记录的次数进行io管控。

取值范围：整型，1000~1000000

默认值：6000

session_respool

参数说明：当前的session关联的resource pool。

该参数属于USERSET类型参数，请参考表1中方式三的方法进行设置。

即如果先设置cgroup_name，再设置session_respool，那么session_respool关联的控制组起作用，如果再切换cgroup_name，那么新切换的cgroup_name起作用。

切换cgroup_name的过程中如果指定到Workload控制组级别，数据库不对级别进行验证。级别的范围只要在1-10范围内都可以。

建议尽量不要混合使用cgroup_name和session_respool。

取值范围：string类型，通过create resource pool所设置的资源池。

默认值：invalid_pool

enable_transaction_parctl

参数说明：是否管控事务块语句和存储过程语句。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

• on表示对事务块及存储过程语句进行管控。
• off表示对事务块及存储过程语句不进行管控。

默认值：on

session_statistics_memory

参数说明：设置实时查询视图的内存大小。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，5 * 1024 ～ max_process_memory的50%，单位KB。

默认值：5MB

topsql_retention_time

参数说明：设置历史TopSQL中gs_wlm_session_query_info_all和gs_wlm_operator_info表中数据 的保存时间。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，0 ~ 3650，单位为天。● 值为0时，表示数据永久保存。 ● 值大于0时，表示数据能够保存的对应天数。

默认值：0

session_history_memory

参数说明：设置历史查询视图的内存大小。

该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，10 * 1024 ～ max_process_memory的50%，单位KB。

默认值：10MB

node_group_mode

参数说明：展示当前的 node group 模式。

该参数属于INTERNAL类型参数，为固定参数，用户无法修改此参数，只能查看。

取值范围：字符串。

默认值："node group"

current_logic_cluster

参数说明：显示当前的逻辑集群（当前特性是实验室特性，使用时请联系华为工程师提供技术支持）名称。

该参数属于INTERNAL类型参数，为固定参数，用户无法修改此参数，只能查看。

取值范围：字符串。

默认值：空

transaction_pending_time

参数说明：当enable_transaction_parctl为on时，事务块语句和存储过程语句排队的最大时间。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，-1 ～ 1073741823，单位为秒。

• 值为-1或0：事务块语句和存储过程语句无超时判断，排队至资源满足可执行条件。
• 值大于0：事务块语句和存储过程语句排队超过所设数值的时间后，无视当前资源情况强制执行。

默认值：0

此参数仅对存储过程及事务块的内部语句有效，即PG_SESSION_WLMSTAT中enqueue字段显示为Transaction或StoredProc的语句才会生效。