X-Tuner：参数调优与诊断

一、概述

二、使用准备

 三、使用示例

 四、获取帮助

五、命令参考

六、常见问题处理

一、概述

增量物化视图可以对物化视图增量刷新，需要用户手动执行语句完成对物化视图在一段时间内的增量数据刷新。与全量创建物化视图的不同在于目前增量物化视图所支持场景较小。目前物化视图创建语句仅支持基表扫描语句或者UNION ALL语句。

二、使用准备

①前提条件与使用事项

• 数据库状态正常、客户端能够正常连接、要求数据库内导入数据，以便调优程序可以执行benchmark测试调优效果。
• 使用本工具需要指定登录到数据库的用户身份，要求该登录到数据库上的用户具有足够的权限，以便可以获得充足的数据库状态信息。
• 使用登录到数据库宿主机上的Linux用户，需要将$GAUSSHOME/bin添加到PATH环境变量中，即能够直接运行gsql、gs_guc、gs_ctl等数据库运维工具。
• Python版本建议为Python3.6+，且运行环境中已经安装相应依赖，并能够正常启动调优程序。您可以独立安装一个Python3.6+的环境，无需设置到全局环境变量中。不建议使用root用户权限安装本工具，如果以root身份安装本完毕工具，使用其他用户身份运行本工具时，需要确保配置文件有读取权限。
• 本工具支持以三种模式运行，其中tune和train模式要求用户配置好benchmark运行环境，并导入数据，本工具将会通过迭代运行benchmark来判断修改后的参数是否有性能提升。
• recommend模式建议在数据库正在执行workload的过程中执行，以便获得更准确的实时workload信息。
• 本工具默认带有TPC-C、TPC-H、TPC-DS以及sysbench的benchmark运行脚本样例，如果用户使用上述benchmark对数据库系统进行压力测试，则可以对上述配置文件进行适度修改或配置。如果需要适配用户自己的业务场景，需要您参照benchmark目录中的template.py文件编写驱动您自定义benchmark的脚本文件。

②原理简介

调优程序是一个独立于数据库内核之外的工具，需要提供数据库及其所在实例的用户名和登录密码信息，以便控制数据库执行benchmark进行性能测试；在启动调优程序前，要求用户测试环境交互正常，能够正常跑通benchmark测试脚本、能够正常连接数据库。

 说明： 如果需要调优的参数中，包含重启数据库后才能使修改生效的参数，那么在调优过程中数据库将会重启多次。如果用户的数据库正在执行作业，请慎用train与tune模式。 

调优程序X-Tuner包含三种运行模式，分别是：

• recommend：通过用户指定的用户名等信息登录到数据库环境中，获取当前正在运行的workload特征信息，根据上述特征信息生成参数推荐报告。报告当前数据库中不合理的参数配置和潜在风险等；输出根据当前正在运行的workload行为和特征；输出推荐的参数配置。该模式是秒级的，不涉及数据库的重启操作，其他模式可能需要反复重启数据库。
• train：通过用户提供的benchmark信息，不断地进行参数修改和benchmark的执行。通过反复的迭代过程，训练强化学习模型，以便用户在后面通过tune模式加载该模型进行调优。
• tune：使用优化算法进行数据库参数的调优，当前支持两大类算法，一种是深度强化学习，另一种是全局搜索算法（全局优化算法）。深度强化学习模式要求先运行train模式，生成训练后的调优模型，而使用全局搜索算法则不需要提前进行训练，可以直接进行搜索调优。

 须知： 如果在tune模式下，使用深度强化学习算法，要求必须有一个训练好的模型，且要求训练该模型时的参数与进行调优时的参数列表（包括max与min）必须一致。 

图 1 X-Tuner结构图

X-Tuner的整体架构如图1 X-Tuner 结构图所示，系统可以分为：

• DB侧：通过DB_Agent模块对数据库实例进行抽象，通过该模块可以获取数据库内部的状态信息、当前数据库参数、以及设置数据库参数等。DB侧包括登录数据库环境使用的SSH连接。
• 算法侧：用于调优的算法包，包括全局搜索算法（如贝叶斯优化、粒子群算法等）和深度强化学习（如DDPG）；
• X-Tuner主体逻辑模块：通过Enviroment模块进行封装，每一个step 就是一次调优过程。整个调优过程通过多个step进行迭代；
• benchmark：由用户指定的benchmark性能测试脚本，用于运行benchmark作业，通过跑分结果反映数据库系统性能优劣。

 说明： 应确保benchmark脚本跑分结果越大表示性能越好。例如TPC-H这种衡量SQL语句整体执行时长的benchmark，可以通过取总体执行时间的相反数作为benchmark的输出分数。 

③X-Tuner的运行和安装方法

可以通过两种方式运行X-Tuner，一种是直接通过源码运行，另一种则是通过Python的setuptools将X-Tuner安装到系统上，而后直接通过gs_xtuner命令调用。下面分别介绍两种运行X-Tuner的方法。

方法一：直接通过源代码运行

1. 切换到xtuner的源代码目录下。对于openGauss社区代码来说，该路径在openGauss-server/src/gausskernel/dbmind/tools/xtuner。对于已经安装的数据库系统，则该源代码路径为 $GAUSSHOME/bin/dbmind/xtuner。

2. 在当前目录下可以看到 requirements.txt 等文件，通过pip包管理工具根据该 requirements.txt 文件安装依赖：

   pip install -r requirements.txt
   

3. 安装成功后需要添加环境变量PYTHONPATH，然后可执行main.py。以获取帮助信息为例，则可以执行：

   cd tuner # 切换到 main.py 入口文件所在的目录
   export PYTHONPATH='..'  # 将上一级目录添加到寻找包的路径中
   python main.py --help  # 可以直接通过该命令执行获取帮助的动作，其他功能使用方法类似
   

方法二：将X-Tuner安装到系统中

1. 可以通过setup.py文件将X-Tuner安装到系统中，然后通过命令gs_xtuner运行。首先需要切换到xtuner的根目录，目录位置见上文。

2. 执行下述命令，Python会通过自身的setuptools将本工具安装到Python环境中：

   python setup.py install
   

   如果Python的bin目录被添加到PATH环境变量中，则gs_xtuner命令也可以在任何地方被直接调用。

3. 仍然以获取帮助信息为例，执行下述命令：

   gs_xtuner --help
   

④X-Tuner 的配置文件说明

X-Tuner在运行前需要加载配置文件，该配置文件默认路径是 $INSTALL_DIR/tuner/xtuner.conf ，可以通过 gs_xtuner –help 命令查看默认加载的配置文件绝对路径：

...  
 -x TUNER_CONFIG_FILE, --tuner-config-file TUNER_CONFIG_FILE
                        This is the path of the core configuration file of the
                        X-Tuner. You can specify the path of the new
                        configuration file. The default path is /path/to/xtuner/xtuner.conf.
                        You can modify the configuration file to control the
                        tuning process.
...

修改配置文件的配置项可以指引X-Tuner执行不同的动作，用户可以根据自己的不同需求来修改配置文件的内容，配置文件的配置项说明详见表2。如果需要修改配置文件的加载路径，则可以通过选项 -x 命令行选项来指定。

⑤Benchmark的选择与配置

Benchmark的驱动脚本存放路径为X-Tuner的benchmark子目录。X-Tuner自带常用的benchmark驱动脚本，例如基于时间周期的探测脚本（默认）、TPC-C、TPC-H等。X-Tuner通过调用benchmark/__init__.py文件中 get_benchmark_instance() 命令来加载不同的benchmark驱动脚本，获取benchmark驱动实例。其中，benchmark驱动脚本的格式说明如下：

• 驱动脚本文件名：表示benchmark的名字，该名字用于表示驱动脚本的唯一性，可通过在X-Tuner的配置文件中的配置项 benchmark_script来指定选择加载哪个benchmark驱动脚本。
• 驱动脚本内容三要素：path变量、cmd变量以及run函数。

下面分别介绍驱动脚本的内容三要素：

1. path变量：表示benchmark脚本的存放地址，可以直接在驱动脚本中修改，也可以通过配置文件的benchmark_path配置项来指定。

2. cmd变量：表示执行benchmark脚本需要运行的命令，可以直接在驱动脚本中修改，也可以通过配置文件的benchmark_cmd配置项来指定。cmd中的文本允许使用占位符，用于获取某些运行cmd命令时的必要信息，使用示例参见TPC-H驱动脚本示例。这些占位符包括：

   • {host}：数据库宿主机的IP地址
   • {port}：数据库实例的侦听端口号
   • {user}：登录数据库系统上的用户名
   • {password}：与登录数据库系统上的用户相匹配的密码
   • {db}：正在进行调优的数据库名

3. run函数：该函数的函数签名为：

   def run(remote_server, local_host) -> float:
   

   其中，返回数据类型为float，表示benchmark执行后的评估分数值，要求该值越大表示性能越好，例如使用TPC-C跑分结果tpmC即可作为返回值，TPC-H的全部SQL语句执行总时间的相反数（取相反数后可保证返回值越大则性能越好）也可作为返回值。

   remote_server 变量是X-Tuner 程序传递给脚本使用的远端主机（数据库宿主机）的shell命令接口，local_host 变量是X-Tuner 程序传递给脚本使用的本地主机（运行X-Tuner脚本的主机）的shell命令接口。上述shell命令接口提供的方法包括：

   exec_command_sync(command, timeout)
   功能：该方法用于在主机上执行shell命令。
   参数列表：
   command 必选，数据类型可以是str, 以及元素为str类型的list或tuple;
   timeout 可选，表示命令执行的超时时长，单位是秒。
   返回值：
   返回二元组 (stdout, stderr)，stdout表示标准输出流结果，stderr表示标准错误流结果，数据类型均为str.
   

   exit_status
   功能：该属性表示最近一条shell命令执行后的退出状态码(exit status code)。
   说明：一般情况，退出状态码为0表示执行正常，非0表示存在错误。
   

Benchmark驱动脚本示例说明

1. TPC-C 驱动脚本

   from tuner.exceptions import ExecutionError
       
   # WARN: You need to download the benchmark-sql test tool to the system,
   # replace the PostgreSQL JDBC driver with the openGauss driver,
   # and configure the benchmark-sql configuration file.
   # The program starts the test by running the following command:
   path = '/path/to/benchmarksql/run'  # TPC-C测试脚本benchmark-sql 的存放路径
   cmd = "./runBenchmark.sh props.gs"  # 自定义一个名为 props.gs 的benchmark-sql测试配置文件
       
       
   def run(remote_server, local_host):
       # 切换到 TPC-C 脚本目录下，清除历史错误日志，然后运行测试命令。
       # 此处最好等待几秒钟，因为benchmark-sql 测试脚本生成最终测试报告是通过一个shell脚本实现的，整个过程会有延迟，
       # 为了保证能够获取到最终的tpmC数值报告，我们这里选择等待3秒钟。
       stdout, stderr = remote_server.exec_command_sync(['cd %s' % path, 'rm -rf benchmarksql-error.log', cmd, 'sleep 3'])
       # 如果标准错误流中有数据，则报异常退出。
       if len(stderr) > 0:
           raise ExecutionError(stderr)
       
       # 寻找最终tpmC结果
       tpmC = None
       split_string = stdout.split()  # 对标准输出流结果进行分词。
       for i, st in enumerate(split_string):
           # 在5.0版本的benchmark-sql中，tpmC最终测试结果数值在 ‘(NewOrders)’关键字的后两位，正常情况下，找到该字段后直接返回即可。
           if "(NewOrders)" in st:
               tpmC = split_string[i + 2]
               break
       stdout, stderr = remote_server.exec_command_sync(
           "cat %s/benchmarksql-error.log" % path)
       nb_err = stdout.count("ERROR:")  # 判断整个benchmark运行过程中，是否有报错，记录报错的错误数
       return float(tpmC) - 10 * nb_err  # 这里将报错的错误数作为一个惩罚项，惩罚系数为10，越高的惩罚系数表示越看中报错的数量.
       
   

2. TPC-H驱动脚本

   import time
       
   from tuner.exceptions import ExecutionError
       
   # WARN: You need to import data into the database and SQL statements in the following path will be executed.
   # The program automatically collects the total execution duration of these SQL statements.
   path = '/path/to/tpch/queries'  # 存放TPC-H测试用的SQL脚本目录
   cmd = "gsql -U {user} -W {password} -d {db} -p {port} -f {file}"  # 需要运行TPC-H测试脚本的命令，一般使用'gsql -f 脚本文件' 来运行
       
       
   def run(remote_server, local_host):
       # 遍历当前目录下所有的测试用例文件名
       find_file_cmd = "find . -type f -name '*.sql'"
       stdout, stderr = remote_server.exec_command_sync(['cd %s' % path, find_file_cmd])
       if len(stderr) > 0:
           raise ExecutionError(stderr)
       files = stdout.strip().split('\n')
       time_start = time.time()
       for file in files:
           # 使用 file 变量替换 {file}，然后执行该命令行。
           perform_cmd = cmd.format(file=file)
           stdout, stderr = remote_server.exec_command_sync(['cd %s' % path, perform_cmd])
           if len(stderr) > 0:
               print(stderr)
       # 代价为全部测试用例的执行总时长
       cost = time.time() - time_start
       # 取相反数，适配run 函数的定义：返回结果越大表示性能越好。
       return - cost

三、使用示例

X-Tuner支持三种模式，分别是获取参数诊断报告的recommend模式、训练强化学习模型的train模式以及使用算法进行调优的tune模式。上述三种模式可以通过命令行参数来区别，通过配置文件来指定具体的细节。

①配置数据库连接信息

三种模式连接数据库的配置项是相同的，有两种方式：一种是直接通过命令行输入详细的连接信息，另一种是通过JSON格式的配置文件输入，下面分别对两种指定数据库连接信息的方法进行说明。

1. 通过命令行指定：

   分别传递 –db-name –db-user –port –host –host-user 参数，可选 –host-ssh-port 参数，例如：

   gs_xtuner recommend --db-name postgres --db-user omm --port 5678 --host 192.168.1.100 --host-user omm
   

2. 通过JSON格式的连接信息配置文件指定：

   JSON配置文件的示例如下，并假设文件名为 connection.json：

   {
     "db_name": "postgres",  # 数据库名
     "db_user": "dba",       # 登录到数据库上的用户名
     "host": "127.0.0.1",    # 数据库宿主机的IP地址
     "host_user": "dba",     # 登录到数据库宿主机的用户名
     "port": 5432,           # 数据库的侦听端口号
     "ssh_port": 22          # 数据库宿主机的SSH侦听端口号
   }
   

   则可通过 -f connection.json 传递。

 说明：
为了防止密码泄露，配置文件和命令行参数中默认都不包含密码信息，用户在输入上述连接信息后，程序会采用交互式的方式要求用户输数据库密码以及操作系统登录用户的密码。 

②recommend 模式使用示例

对recommend 模式生效的配置项为 scenario，若为auto，则自动检测workload类型。

执行下述命令，获取诊断结果：

gs_xtuner recommend -f connection.json

则可以生成诊断报告如下：

图 1 recommend 模式生成的报告示意图

在上述报告中，推荐了该环境上的数据库参数配置，并进行了风险提示。报告同时生成了当前workload的特征信息，其中有几个特征是比较有参考意义的：

• temp_file_size：产生的临时文件数量，如果该结果大于0，则表明系统使用了临时文件。使用过多的临时文件会导致性能不佳，如果可能的话，需要提高work_mem参数的配置。
• cache_hit_rate：shared_buffer 的缓存命中率，表明当前workload使用缓存的效率。
• read_write_ratio：数据库作业的读写比例。
• search_modify_ratio：数据库作业的查询与修改数据的比例。
• ap_index：表明当前workload的AP指数，取值范围是0到10，该数值越大，表明越偏向于数据分析与检索。
• workload_type：根据数据库统计信息，推测当前负载类型，分为AP、TP以及HTAP三种类型。
• checkpoint_avg_sync_time：数据库在checkpoint 时，平均每次同步刷新数据到磁盘的时长，单位是毫秒。
• load_average：平均每个CPU核心在1分钟、5分钟以及15分钟内的负载。一般地，该数值在1左右表明当前硬件比较匹配workload、在3左右表明运行当前作业压力比较大，大于5则表示当前硬件环境运行该workload压力过大（此时一般建议减少负载或升级硬件）。

 说明： recommend 模式会读取数据库中的pg_stat_database以及 pg_stat_bgwriter等系统表中的信息，需要登录到数据库上的用户具有足够的权限（建议为管理员权限，可通过alter user username sysadmin；授予username相应的权限）。 由于某些系统表会一直记录统计信息，这可能会对负载特征识别造成干扰，因此建议最好先清空某些系统表的统计信息，运行一段时间的workload后再使用recommend模式进行诊断，以便获得更准确的结果。使用如下命令清除统计信息： 

select pg_stat_reset_shared('bgwriter');
select pg_stat_reset();

③train 模式使用示例

该模式是用来训练深度强化学习模型的，与该模式有关的配置项为：

• rl_algorithm：用于训练强化学习模型的算法，当前支持设置为ddpg。
• rl_model_path: 训练后生成的强化学习模型保存路径。
• rl_steps：训练过程的最大迭代步数。
• max_episode_steps：每个回合的最大步数。
• scenario: 明确指定的workload类型，如果为auto则为自动判断。在不同模式下，推荐的调优参数列表也不一样。

• tuning_list: 用户指定需要调哪些参数，如果不指定，则根据workload类型自动推荐应该调的参数列表。如需指定，则tuning_list 表示调优列表文件的路径。一个调优列表配置文件的文件内容示例如下：

  {
    "work_mem": {
      "default": 65536,
      "min": 65536,
      "max": 655360,
      "type": "int",
      "restart": false
    },
    "shared_buffers": {
      "default": 32000,
      "min": 16000,
      "max": 64000,
      "type": "int",
      "restart": true
    },
    "random_page_cost": {
      "default": 4.0,
      "min": 1.0,
      "max": 4.0,
      "type": "float",
      "restart": false
    },
    "enable_nestloop": {
      "default": true,
      "type": "bool",
      "restart": false
    }
  }
  

待上述配置项配置完成后，可以通过下述命令启动训练：

gs_xtuner train -f connection.json

训练完成后，会在配置项rl_model_path指定的目录中生成模型文件。

④tune模式使用示例

tune模式支持多种算法，包括基于强化学习（Reinforcement Learning, RL）的DDPG算法、基于全局搜索算法（Global OPtimization algorithm, GOP）算法的贝叶斯优化算法（Bayesian Optimization）以及粒子群算法（Particle Swarm Optimization, PSO）。

与tune模式相关的配置项为：

• tune_strategy: 指定选择哪种算法进行调优，支持rl（使用强化学习模型进行调优）、gop （使用全局搜索算法）以及 auto（自动选择）。若该参数设置为rl，则rl相关的配置项生效。除前文提到过的train模式下生效的配置项外，test_episode配置项也生效，该配置项表明调优过程的最大回合数，该参数直接影响了调优过程的执行时间（一般地，数值越大越耗时）。
• gop_algorithm: 选择何种全局搜索算法，支持bayes以及pso。
• max_iterations: 最大迭代轮次，数值越高搜索时间越长，效果往往越好。
• particle_nums: 在PSO算法上生效，表示粒子数。
• scenario 与 tuning_list 见上文 train 模式中的描述。

待上述配置项配置完成后，可以通过下述命令启动调优：

gs_xtuner tune -f connection.json

 注意： 在使用tune和train 模式前，用户需要先导入benchmark所需数据并检查benchmark能否正常跑通。调优过程结束后，调优程序会自动恢复调优前的数据库参数配置。

四、获取帮助

启动调优程序之前，可以通过如下命令获取帮助信息：

gs_dbmind component xtuner --help

输出帮助信息结果如下：

usage:  [-h] [--db-name DB_NAME] [--db-user DB_USER] [--port PORT]
                 [--host HOST] [--host-user HOST_USER]
                 [--host-ssh-port HOST_SSH_PORT] [-f DB_CONFIG_FILE]
                 [-x TUNER_CONFIG_FILE] [-v]
                 {train,tune,recommend}

X-Tuner: a self-tuning tool integrated by openGauss.

positional arguments:
  {train,tune,recommend}
                        Train a reinforcement learning model or tune database
                        by model. And also can recommend best_knobs according
                        to your workload.

optional arguments:
  -h, --help            show this help message and exit
  -f DB_CONFIG_FILE, --db-config-file DB_CONFIG_FILE
                        You can pass a path of configuration file otherwise
                        you should enter database information by command
                        arguments manually. Please see the template file
                        share/server.json.template.
  -x TUNER_CONFIG_FILE, --tuner-config-file TUNER_CONFIG_FILE
                        This is the path of the core configuration file of the
                        X-Tuner. You can specify the path of the new
                        configuration file. The default path is xtuner.conf.
                        You can modify the configuration file to control the
                        tuning process.
  -v, --version         show program's version number and exit

Database Connection Information:
  --db-name DB_NAME     The name of database where your workload running on.
  --db-user DB_USER     Use this user to login your database. Note that the
                        user must have sufficient permissions.
  --port PORT           Use this port to connect with the database.
  --host HOST           The IP address of your database installation host.
  --host-user HOST_USER
                        The login user of your database installation host.
  --host-ssh-port HOST_SSH_PORT
                        The SSH port of your database installation host.

五、命令参考 

表 1 命令行参数

表 2 配置文件中的参数详解

六、常见问题处理

• 数据库实例连接失败：请检查数据库实例的情况，是否数据库实例出现了问题或安全权限配置（pg_hba.conf文件中的配置项）不正确。
• 重启失败：请检查数据库实例健康情况，确保数据库实例工作正常。
• 跑TPC-C作业时发现性能越来越慢：TPC-C等高并发场景下的压力测试，往往伴随着大量的数据修改。由于每一次测试并非是幂等的（TPC-C数据库数据量的增加、没有进行vacuum full清理掉失效元组、数据库没有触发checkpoint、没有进行drop cache等），因此一般建议TPC-C等伴随着较多数据写入的benchmark应该每隔一段时间（视具体并发量、执行时长的不同而异）重新导入一次数据，比较简单的方法是备份$PGDATA目录。
• TPC-C 跑作业时，TPC-C驱动脚本报异常 “TypeError: float() argument must be a string or a number, not 'NoneType'”（不能将None转换为float类型）：这是因为没有获取到TPC-C的压测返回结果，造成该问题的原因比较多，请首先手动检测是否能够跑通TPC-C并能够获取返回结果。若无上述问题，则建议将 TPC-C 驱动脚本中的命令列表中的 “sleep” 命令延迟时间设得更大一些。

 — END —