Amazon Aurora 数据库升级流量兼容性检测方案介绍

前言

随着 Amazon RDS MySQL 5.7 的生命周期终止，Amazon Aurora 2 大版本（兼容 RDS MySQL 5.7）将会在 2024 年 10 月 31 日退役。区别于之前的小版本升级的是，从 Aurora 2 升级到 Aurora 3 需要进行驱动兼容性测试、数据库对象兼容性测试以及业务 SQL 语句兼容性测试，其中前两者可以参考之前的升级系列博客：https://aws.amazon.com/cn/blogs/china/amazon-rds-for-mysql-5-7-to-8-0-pre-check/。

而业务 SQL 语句兼容性检测往往依赖于业务研发分析代码中的 SQL 语法来对比新旧版本的兼容性变化, 需要投入大量的精力。本文将利用 VPC traffic mirroring 功能来提供一种近乎没有性能影响的方案, 旨在帮助用户更简单地提前发现升级到 Aurora3 之后不兼容的语句。

项目范围

本项目在进行 Aurora MySQL 5.7 到 8.0 的业务 SQL 语句的语法兼容性检查时，将使用 VPC traffic mirroring 进行数据库流量（业务 SQL 语句）的采集，有关 VPC traffic mirroring 的技术细节，见下方表格：

在采集到某段时间内在 Aurora MySQL 5.7 上执行的业务 SQL 语句之后，我们会使用关键字和 STATEMENT_DIGEST_TEXT 方法来进行语法兼容性检查。

方案

架构设计

架构详细介绍

1. 用户通过 API 调用启动一次流量兼容性检查任务。API 接口设计请见接口设计部分。

2. API Gateway 接受用户请求之后，会启动“Start” Step Function。“Start” Step Function 里面会执行：

• 2.1 检查 Aurora 数据库的信息，包括硬件配置，网卡信息等。Aurora 数据库的硬件配置会作为启动机器数量的依据；Aurora 数据库的网卡信息则会作为 Traffic mirroring session 的源。
• 2.2 修改 Auto Scaling Group 的机器数量，启动数台 EC2 实例作为 NLB 的目标组。启动机器的配置为，数量是根据源 Aurora 数据库的配置匹配产生。
• 2.3 启动 VPC Traffic Mirror 的 session，session 的源为用户传入 Aurora 数据库的网卡，目标是通过 CDK 部署的 Network Load Balancer（NLB）。
• 2.4 将用户请求元数据作为一个 item 存入 DynamoDB（Task 表）。
• 2.5 之后 Step Function 进入等待阶段，等待时长是用户设置的采集流量 window。
• 2.6 等待结束之后，异步触发“Clean-up” Step Function。

3. VPC Traffic Mirror Session 创建成功之后，会把发往 Aurora 数据库的流量同时发往 Traffic Mirror 的目标，也就是 NLB。

4. NLB 会把流量通过负载均衡算法分发给 Auto Scaling Group 下面的 EC2 实例。来自同一个源 IP+端口的流量会被转发到同一台机器。

5. EC2 实例通过监听 UDP 4789 端口获取 packet，通过 tshark 软件解析原始 SQL 查询语句，把源 IP，源端口，时间戳，SQL 语句作为一个消息发送给 SQS。

6. SQS 触发 Lambda function（validate），batch size 为 100，即每次 Lambda function 执行的时候可以收到最多 100 条消息。

7. Lambda function（validate）会首先对从 SQS 队列中拿到的文档进行去重处理，对于新的指令会使用在 Secrets Manager 中的 credential 连接一个 Aurora 3.0.4 Cluster，通过关键字检查和 STATEMENT_DIGEST_TEXT 指令检查 SQL 语句的语法兼容性。运行结果会存储在 DynamoDB（Query 表）中。

8. DynamoDB（Query 表）会触发 put item 的 DynamoDB Stream，启动 Lambda function（Aggregation）。Batch size 为 2000。

9. Lambda function（Aggregation）会轮训新增的执行结果 item，更新 DynamoDB（Task 表）中的源数据，供状态查询。

10. “Clean-up” Step Function 里面的步骤为：关闭 Auto Scaling Group 里面的机器，删除 Traffic Mirror Session，清空 SQS，更新 DynamoDB（Task 表）中的源数据状态为“Finished”。

11. 当 DynamoDB（Task 表）中的源数据被更新为“Finished”或“Stopped”时，DynamoDB Stream 会触发 Lambda function（generate report）。

12. Lambda function（generate report）会从 DynamoDB（Query 表）中查询本次出错的记录，写入 CSV 文件，写入 S3。CSV 文件中每条出错信息内容包括源 IP，源端口，时间戳，SQL 语句，报错信息。

13. 在检查任务进行中（In progress 状态时），用户可以强行停止检查任务，并且关闭所有资源。这时该任务的状态变为“Stopped”。

14. 用户可以调用查看任务进度和报告接口，该接口后面的 Lambda function 会从 DynamoDB（Task 表）中查找该任务的状态，如果状态为 Finished 或者 Stopped 状态，Lambda function 还会从 S3 中获取报告的下载连接。

主要服务

• DynamoDB
  • Amazon DynamoDB 是一种全托管 NoSQL 数据库服务，提供快速而可预测的性能，能够实现无缝扩展。DynamoDB 可以免除操作和扩展分布式数据库的管理工作负担，因而无需担心硬件预置、设置和配置、复制、软件修补或集群扩展等问题。在本次原型项目中，我们使用 DynamoDB 来存储不同用户的会话相关的数。
  • DynamoDB Stream 是一种有关 DynamoDB 表中的项目更改的有序信息流。当您对表启用流时，DynamoDB 将捕获有关对表中的数据项目进行的每项修改的信息。在本次原型项目中，我们使用 DynamoDB stream 实现模块之间的事件驱动（event driven），减少模块之间的相互依赖。

• Lambda
  • 利用 AWS Lambda，您可以运行代码而无需预置或管理服务器。您只需为使用的计算时间付费，在代码未运行期间不产生任何费用。您可以为几乎任何类型的应用程序或后端服务运行代码，而无需任何管理。在本次原型项目中，我们使用 Lambda function 执行一系列复杂的操作，比如说通过 Aurora endpoint 找到 db cluster 的网卡信息等。

• Step Function
  • AWS Step Functions 是一项无服务器编排服务，可让您与 Lambda function 和其他功能集成 AWS 服务以构建关键业务应用程序。使用 Step Functions 的内置控件，您可以检查工作流中每个步骤的状态，以便确保应用程序按预期顺序运行。本项目中 VPC Traffic Mirror 的开启和关闭流程复杂，我们使用 Step Function 来编排代码。

• SQS
  • Amazon Simple Queue Service（SQS）是适用于微服务、分布式系统和无服务器应用程序的完全托管的消息队列，其中标准 Queue 可以提供接近无限的吞吐量，在本项目中适合存储来自源数据库网卡的流量信息。

• S3
  • Amazon Simple Storage Service（Amazon S3）是一种对象存储服务，提供行业领先的可扩展性、数据可用性、安全性和性能。本项目中的关键结果就是兼容性检查的报错信息，由于报错信息可能会比较大，很难通过 API 接口以 JSON 的格式返回，同时多次调用接口可能导致 DynamoDB 查询费用上升。我们会一次性把报错生成 CSV 文件保存到 S3 上，供用户随时下载查看。

• VPC
  • 借助 Amazon Virtual Private Cloud（亚马逊 VPC），您可以在您定义的逻辑隔离的虚拟网络中启动 AWS 资源。这个虚拟网络与您在数据中心中运行的传统网络极其相似，并会为您提供使用的可扩展基础设施的优势 AWS。
  • Traffic Mirroring 流量镜像是亚马逊虚拟私有云（VPC）的一个功能，您可以使用它来复制来自弹性网络接口的网络流量。本次原型项目中，我们利用 Traffic Mirroring 的功能复制来自 Aurora 网卡的流量，从而拿到 SQL query，而对生产数据库零影响。

• Network Load Balancer
  • Network Load Balancer （NLB） 在一个或多个可用区中的多个目标（如 EC2 实例、容器和 IP 地址）之间自动分配传入的流量。它会监控已注册目标的运行状况，并仅将流量传输到运行状况良好的目标。弹性负载均衡 根据传入流量随时间的变化对负载均衡器进行扩展。它可以自动扩展来处理绝大部分工作负载。本原型项目中使用 NLB 把生产数据库的流量分发给不同的 EC2 实例，降低单台 EC2 的压力。

• Secrets Manager
  • 借助 AWS Secrets Manager，您可以在数据库凭证、应用程序凭证、OAuth 令牌、API 密钥和其他密钥的整个生命周期内对其进行管理、检索和轮换。许多 AWS 服务将密钥存储在 Secrets Manager 中。本项目中我们把 Aurora 3 的数据库访问令牌存储在 Secrets Manager 中，避免在代码中硬编码降低安全性。

名词解释

• Task：用于抓取某段时间的 Aurora 集群流量的一个任务， 包含时间窗口、开始时间、状态等信息。
• Traffic Window：一个 Task 抓取 Aurora 集群流量的时间窗口，单位为小时，比如 2 代表从 task 被启动到完成中间 wait 2 小时。
• Agent：启动在 ASG 中的每个 EC2 上的抓取 Aurora 集群流量数据的进程，对应代码在每台 EC2 的/home/ec2-user/agent/agent.py 脚本。
• Agent EC2：用于运行 Agent 的 Auto Scaling Group 中的 EC2。

语法检查说明

本次原型项目我们进行的语法检查主要包括以下三个方法：

1. 使用 MySQL 8.0 的 function STATEMENT_DIGEST_TEXT 进行检查，示例如下：

   MySQL [sales_db]> SELECT STATEMENT_DIGEST_TEXT('CREATE TABLE t_gcol_dep (fid INTEGER NOT NULL PRIMARY KEY, g POINT GENERATED ALWAYS AS (PointFromText(POINT(10, 10))));');
   ERROR 3676 (HY000): Could not parse argument to digest function: "Expression of generated column 'g' contains a disallowed function: `PointFromText`.".
   

2. 使用正则匹配，检查 MySQL 8.0 不支持的 function，检查的 function 列表如下：

   functions = ['load_file', 'udf', 'geometrycollectome', 'geomcollfromtext',
                'linestringfromtext', 'polygonfromtext', 'pointfromtex']

3. 使用正则匹配，检查 MySQL 8.0 预留的关键字，关键字列表如下：

   keywords = [
       'cume_dist', 'dense_rank', 'empty', 'except', 'first_value',
       'grouping', 'groups', 'json_table', 'lag', 'last_value',
       'lateral', 'lead', 'nth_value', 'ntile', 'of', 'over',
       'percent_rank', 'rank', 'recursive', 'row_number', 'system', 'window'
   ]

如果关键字用“引起来，则检查通过，否则不通过。

以下表格是我们通过测试列举出来的一些检查项，在 MySQL 8.0 上使用以上三种检查方式结合即 digest check + keywords 的检查结果的对比。

接口使用说明

本方案共实现了 3 个接口：启动检查任务接口；查看任务进度和报告接口；强行停止任务接口。

API example：https://xxxxxxxxxxx.execute-api.ap-southeast-1.amazonaws.com/prod/task

在使用该接口时， 需要在 Headers 中传入 x-api-key， 对应的 value 在 AWS console API Gateway 服务中， 如下图，找到您对应的 API key 复制即可：

启动检查任务接口：POST

• Request body:

  {
      "cluster_identifier": "string",
      "traffic_window": 2
  }
  

  database_endpoint 为数据库 endpoint。traffic_window 为流量采集时长，单位为小时。

• Response:

  {
      "task_id": "string",
      "message": "string"
  }
  

  task_id 是这次任务的唯一编号，其他的接口需要传入此 id 进行针对一次检查任务的操作。message 是报错信息，默认为空。

查看任务进度和报告接口：GET

• Request：

  ?task_id=xxxx

• Response:
  # Response 的内容与 task 的 status 有关

  {
      "message": "",
      "status": "Finished", # Created，In progress，Finished，Stopped, Error
      "captured_query": 134, # 抓取到的query数量
      "checked_query": 3, # 已完成检查的query数量
      "failed_query": 2, # 出错的query数量
      "created_time": "2024-03-29T07:39:34.354Z",
      "traffic_window": 1,
      "complete_percentage": "100%", # 已经过去的时间/采集的总时间 * 100%
      "start_capture_time": "2024-03-29T07:40:58.354Z", # 开始采集第一批query的时间
      "end_time": "2024-03-29T08:39:50.354Z", # 任务结束/停止时间
      "report_s3_presign_url":"presign_url_you_can_open_to_download_the_file", # 报告的下载链接
      "report_s3_uri": "s3://bucket_name/failed_reports/task_id/failed_queries.csv" # 报告的S3 URI
  }

停止任务接口：PUT

• Request body:

  {
      "task_id": "string"
  }
  

  task_id 是这次任务的唯一编号。

• Response:

  {
      "message": "string"
  }
  

  message 是报错信息，默认为空。

检查报告示例

在通过语法检查之后，如果有检查未通过的 Query，对于这些检查未通过的 Query 会生成一个 CSV 文件的报告，示例如下：

具体的检查未通过的原因在 message 一列中，如果当前进行的三种检查都未通过，则对应的信息都放于该字段中，并以；分隔。

部署文档

前提条件

• 确定需要部署的 VPC，被监控的 Aurora 数据库必须在同一个 VPC 下，记录下 VPC ID，作为参数<VPC ID>。
• 在检测流量兼容性时，我们需要启动一台 MySQL 8.0 的 Aurora 数据库，所以需要准备至少两个私有子网 ID，作为参数<private subnets ID>，使用英文逗号分隔。
• 在采集流量的时候，我们需要部署一些 agent EC2 实例，这些 EC2 实例需要部署在至少一个公有子网中，该公有子网应该有至少 100 个剩余 IP，这个公有子网的 IP 作为参数<public subnets ID>，如果多于一个公有子网，使用英文逗号进行分隔。
• 一个 Keypair，用于 ssh 本账号本区域下的 Linux 服务器，这个 Keypair 的名字作为参数<keypair name>。
• 最后，作为部署人员，需要至少有权限部署 CDK 代码，并且使用 Cloudshell 服务。
• 本方案 CDK 代码仓库链接在下面的附录 3。

部署步骤

在 AWS console 中搜索 Cloudshell 服务，或者打开 Cloudshell console：

以新加坡 region 为例：

https://ap-southeast-1.console.aws.amazon.com/cloudshell/home?region=ap-southeast-1

点击右上角 action 下拉菜单，选择 upload file：

选择本地下载的 CDK 压缩文件 queries-compatibility-check.zip。

默认会上传到

/home/cloudshell-user 目录

在该目录下执行：

unzip queries-compatibility-check.zip
cd queries-compatibility-check
pip3 install -r requirements.txt

# Install requirements for lambda layer
cd infrastructure/query_validation/lambda_function/
mkdir -p lambda_layer/python && cd lambda_layer/python/
pip3 install -t . pymysql

# Go back to folder queries-compatibility-check/
cd infrastructure/query_collection/lambda_function/
mkdir -p lambda_layer/dnspython/python && cd lambda_layer/dnspython/python
pip3 install -t . dnspython

cdk bootstrap -c env=<environment name> \
-c vpc=<VPC ID> \
-c private_subnets=<private subnets ID> \
-c public_subnets=<public subnets ID> \
-c keypair=<Keypair name>

# Example: cdk deploy -c env=dt \
# -c vpc=vpc-0b217a017fa41dedb 
# -c private_subnets=subnet-0dadd45276ef33efc,subnet-01ab09023c8403e03\
# -c public_subnets=subnet-090b3b480c87e8c56 
# -c keypair=dt-deploy

cdk deploy -c env=<environment name> \
-c vpc=<VPC ID> \
-c private_subnets=<private subnets ID> \
-c public_subnets=<public subnets ID> \
-c keypair=<Keypair name> 

查询报告

在 AWS console 中打开 Athena，在 Query Editor 中运行以下 SQL（如果当前账号未配置使用过 Athena，需要在第一次使用时配置一个用来输出查询运行日志的 S3 bucket）

-- 创建表，注意请将LOCATION中的S3 bucket名字改成我们用CDK部署的S3 bucket
CREATE EXTERNAL TABLE failed_report_table (
   task_id string,
   query string,
   src string,
   src_port string,
   message string
)
PARTITIONED BY (id string)
ROW FORMAT SERDE 'org.apache.hadoop.hive.serde2.OpenCSVSerde'
WITH SERDEPROPERTIES (
   'separatorChar' = ',',
   'quoteChar' = '\"',
   'escapeChar' = '\\'
   )
STORED AS TEXTFILE
LOCATION 's3://db-check-bucket-637423544808-ap-southeast-1-jiatin/failed_reports/';

-- 加入新分区的数据，后续如果有新的task跑完，直接运行此句即可
msck repair table failed_report_table;

-- 查询数据
select * from failed_report_table where id='502395e9-220b-4ec2-a5ee-04c7641478a0';

测试总结

1. Agent（部署在 EC2 上运行 tshark 抓取 Aurora 流量数据的 Python 脚本）
   • Agent 机型为 c6gn.large
   • Agent 的并发数为 6，在 Aurora db.r6g.16xlarge 的机型上压测时，c6gn.large 每秒钟通过 tshark 抓取到进行 filter 等操作并发送到 SQS 的最大数量为 500 左右。
2. 整体架构压测
   • 在 Aurora db.r6g.16xlarge 的机型上压测时，用 32 台 c6gn.large 机型抓取流量，从 task 启动到开始抓取第一批流量的时间为 4 分钟左右。对应 task get 接口中的 start_capture_time – created_time。
   • 在 Aurora db.r6g.16xlarge 的机型上每秒钟 20K 左右的 query 数量时，用 32 台 c6gn.large 机型抓取流量，大约在停止往 Aurora 发送 query 的 1 分钟之后获取到所有 query，对应 task get 接口中的 captured_query。
3. MySQL client connection
   • 对于从 client 起的一个 connection，对应一台抓取流量的 EC2。

For UDP traffic, the load balancer selects a target using a flow hash algorithm based on the protocol, source IP address, source port, destination IP address, and destination port. A UDP flow has the same source and destination, so it is consistently routed to a single target throughout its lifetime. Different UDP flows have different source IP addresses and ports, so they can be routed to different targets.

https://docs.aws.amazon.com/elasticloadbalancing/latest/network/introduction.html

24 小时测试报告

RDS Aurora:
Write instance: db.r6g.16xlarge
Read instance: db.r6g.16xlarge

Agent:
c6gn.2xlarge * 16

{
    "message": "",
    "status": "Finished",
    "captured_query": 1067483255,
    "checked_query": 463,
    "failed_query": 7,
    "created_time": "2024-04-18T08:58:37.621Z",
    "traffic_window": 24,
    "complete_percentage": "100%",
    "start_capture_time": "2024-04-18T09:00:16.934Z"
}

截取流量总大小：1,067,483,255
截取流量时长：24 小时
流量速率：12k/s

参数调整

本解决方案里面有很多地方可以按照实际情况进行调整和升级：

1. ASG 里的 EC2 数量和类型

如果我们发现后续使用的时候，Agent 的 EC2 的 CPU 使用率不高，或者对于目标数据库高并发场景有限，可以更改 ASG 里面 EC2 的数量甚至机型，具体更改方法如下：

更改机型：在 /infrastructure/query_collection/launch_template/stack.py 文件中搜索 aws_ec2.InstanceType.of，通过更改 XLARGE2，可以更改 EC2 的大小，目前 C6GN 的最小机型是 MEDIUM，如果选择 2xlarge 的机型，需改为 XLARGE。如下图中所示，为 c6gn.2xlarge：

目前数据库的配置和 EC2 的配置是 1:0.5，即数据库 2xlarge 机型（及以下）对应一台 agent 的机器，4xlarge 对应两台 agent 机器，以此类推，16xlarge 对应 8 台 agent 机器。如果想调整这个比例，可以更改/infrastructure/query_collection/lambda_function/get_db_instance_type/lambda_function.py 文件。在文件中搜索 calculate_instance_count_by_db_class 方法，更改最后的返回值，如更改为 1:2:

2. Agent 的并发

通过更改 Agent 的并发可以有效的提高 agent 的效率，目前我们测试的条件下，单台 EC2 启动 7 并发效果比较好，不过这个并发数也可以根据未来的实际情况机型调整，并发数越高，单 Agent 的利用率越高，CPU 用量也越高。想调整 Agent 并发数，可以修改 /agent/agent.py 文件，找到 run_command 方法，修改 processes 的数量，如下图改为并发 24：

3. Validation Lambda Function 的检查项添加

我们现在在验证 query 兼容性方面做了如下的处理：使用正则表达式查找 query 是否使用了 MySQL 8.0 不支持的方法；使用正则表达式查找 query 中是否使用了新增的 MySQL 8.0 关键字；使用 MySQL 8.0 新增的 STATEMENT_DIGEST_TEXT 方法验证 syntax 是否正确。如果有需要新增了新的关键字，或者新增的检查，我们的都可以通过更改/infrastructure/query_validation/lambda_function/validate_query/lambda_function.py 方法来新增或者去掉检查内容。目前的 3 个检查的方法分别为：check_for_unsupported_functions，check_for_keywords，check_for_mysql_syntax。我们可以根据需要，增加自己的方法或者去掉不需要检查的项目。

4. 从 SQS 消费 message 对 query 去重的批处理大小

在架构中，我们有一个 lambda function 会从 SQS 中接到所有的流量，然后去重之后写入 DynamoDB，而后进行后续的流程。这个 Lambda function 我们进行了批处理的操作，一次从 SQS 中取 2000 条 query 然后进行去重的工作。这个批处理的步骤的批量大小也可以进行配置。

修改/infrastructure/query_collection/lambda_function/stack.py 文件，搜索关键字 sqs_source，通过修改 batch_size 或者 max_batch_window 来控制批处理工作的批量大小和等待时间：

使用限制

1. 目前仅支持 Aurora MySQL 8.0 语法兼容性检查, 不会检查执行效率以及返回结果。
2. 基于 VPC traffic mirroring 限制，超过 8947 bytes 的 SQL 语句无法检查。
3. 部分废弃语法不支持检查，详见上面 <语法检查说明> 章节的表格说明。
4. 如果应用程序是使用 TLS 连接访问 Aurora 数据库，无法使用 traffic mirror 获取加密流量。

安全建议

1. Cloud watch log group 加密。
2. S3 bucket 开启 access logging。
3. API gateway 调用白名单限制。

附录

1. CDK 文档
2. https://aws.amazon.com/cn/blogs/china/amazon-rds-for-mysql-5-7-to-8-0-pre-check
3. 本方案代码仓库：https://github.com/aws-samples/queries-compatibility-check

本篇作者