使用准备

前提条件与使用事项

  • 数据库状态正常、客户端能够正常连接、且要求数据库内导入数据，以便调优程序可以执行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测试脚本、能够正常连接数据库。

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

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

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

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

图 1 X-Tuner结构图
使用准备 - 图3

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

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

使用准备 - 图4 说明： 应确保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 文件安装依赖：

    1. pip install -r requirements.txt

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

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

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

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

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

    1. python setup.py install

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

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

    1. gs_xtuner --help

X-Tuner 的配置文件说明

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

  1. ...  
  2.  -x TUNER_CONFIG_FILE, --tuner-config-file TUNER_CONFIG_FILE
  3.                         This is the path of the core configuration file of the
  4.                         X-Tuner. You can specify the path of the new
  5.                         configuration file. The default path is /path/to/xtuner/xtuner.conf.
  6.                         You can modify the configuration file to control the
  7.                         tuning process.
  8. ...

修改配置文件的配置项可以指引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函数：该函数的函数签名为：

    1. 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命令接口提供的方法包括：

    1. exec_command_sync(command, timeout)
    2. 功能：该方法用于在主机上执行shell命令。
    3. 参数列表：
    4. command 必选，数据类型可以是str, 以及元素为str类型的list或tuple;
    5. timeout 可选，表示命令执行的超时时长，单位是秒。
    6. 返回值：
    7. 返回二元组 (stdout, stderr)，stdout表示标准输出流结果，stderr表示标准错误流结果，数据类型均为str.
    1. exit_status
    2. 功能：该属性表示最近一条shell命令执行后的退出状态码(exit status code)。
    3. 说明：一般情况，退出状态码为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测试配置文件

  1. def run(remote_server, local_host):
  2.     # 切换到 TPC-C 脚本目录下，清除历史错误日志，然后运行测试命令。
  3.     # 此处最好等待几秒钟，因为benchmark-sql 测试脚本生成最终测试报告是通过一个shell脚本实现的，整个过程会有延迟，
  4.     # 为了保证能够获取到最终的tpmC数值报告，我们这里选择等待3秒钟。
  5.     stdout, stderr = remote_server.exec_command_sync(['cd %s' % path, 'rm -rf benchmarksql-error.log', cmd, 'sleep 3'])
  6.     # 如果标准错误流中有数据，则报异常退出。
  7.     if len(stderr) > 0:
  8.         raise ExecutionError(stderr)
  10.     # 寻找最终tpmC结果
  11.     tpmC = None
  12.     split_string = stdout.split()  # 对标准输出流结果进行分词。
  13.     for i, st in enumerate(split_string):
  14.         # 在5.0版本的benchmark-sql中，tpmC最终测试结果数值在 ‘(NewOrders)’关键字的后两位，正常情况下，找到该字段后直接返回即可。
  15.         if "(NewOrders)" in st:
  16.             tpmC = split_string[i + 2]
  17.             break
  18.     stdout, stderr = remote_server.exec_command_sync(
  19.         "cat %s/benchmarksql-error.log" % path)
  20.     nb_err = stdout.count("ERROR:")  # 判断整个benchmark运行过程中，是否有报错，记录报错的错误数
  21.     return float(tpmC) - 10 * nb_err  # 这里将报错的错误数作为一个惩罚项，惩罚系数为10，越高的惩罚系数表示越看中报错的数量.
  23. ```

  1. 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 脚本文件’ 来运行

  1. def run(remote_server, local_host):
  2.     # 遍历当前目录下所有的测试用例文件名
  3.     find_file_cmd = "find . -type f -name '*.sql'"
  4.     stdout, stderr = remote_server.exec_command_sync(['cd %s' % path, find_file_cmd])
  5.     if len(stderr) > 0:
  6.         raise ExecutionError(stderr)
  7.     files = stdout.strip().split('\n')
  8.     time_start = time.time()
  9.     for file in files:
  10.         # 使用 file 变量替换 {file}，然后执行该命令行。
  11.         perform_cmd = cmd.format(file=file)
  12.         stdout, stderr = remote_server.exec_command_sync(['cd %s' % path, perform_cmd])
  13.         if len(stderr) > 0:
  14.             print(stderr)
  15.     # 代价为全部测试用例的执行总时长
  16.     cost = time.time() - time_start
  17.     # 取相反数，适配run 函数的定义：返回结果越大表示性能越好。
  18.     return - cost
  19. ```