Apache Doris 执行计划诊断工具 PLAN REPLAYER DUMP 详解

概述

PLAN REPLAYER DUMP 是 Apache Doris 提供的一个强大的执行计划诊断工具，它能够帮助数据库管理员和开发人员捕获查询优化器的状态和输入数据，生成完整的执行计划诊断文件。这个功能对于分析和调试复杂的查询优化问题特别有用。

工作原理

当执行 PLAN REPLAYER DUMP 命令时，Doris 会：

1. 解析并执行指定的查询语句
2. 收集查询优化过程中的所有关键信息
3. 将这些信息打包成一个诊断文件
4. 返回该文件的下载地址

语法结构

PLAN REPLAYER DUMP <query>

其中 <query> 是需要分析的查询语句，必须是有效的 SELECT 查询。

使用前提

使用此功能需要满足以下条件：

1. 用户必须对查询中涉及的表具有 SELECT 权限
2. 查询必须是有效的 SELECT 语句
3. 系统正常运行且能够生成执行计划

使用示例

基础使用

假设我们有一个简单的测试环境：

-- 创建测试数据库和表
CREATE DATABASE test_replayer;
USE test_replayer;
CREATE TABLE t1 (c1 INT, c11 INT) 
DISTRIBUTED BY HASH(c1) 
BUCKETS 3 
PROPERTIES('replication_num' = '1');

-- 生成执行计划诊断文件
PLAN REPLAYER DUMP SELECT * FROM t1;

执行后会返回类似以下结果：

+-------------------------------------------------------------------------------+
| Plan Replayer dump url                                                        |
+-------------------------------------------------------------------------------+
| http://127.0.0.1:8030/api/minidump?query_id=6e7441f741e94afd-ad3ba69429ad18ec |
+-------------------------------------------------------------------------------+

获取诊断文件

可以使用 wget 或 curl 工具下载诊断文件：

wget "http://127.0.0.1:8030/api/minidump?query_id=6e7441f741e94afd-ad3ba69429ad18ec"

如果需要认证，可以这样操作：

wget --header="Authorization: Basic $(echo -n 'root:' | base64)" \
"http://127..0.1:8030/api/minidump?query_id=6e7441f741e94afd-ad3ba69429ad18ec"

诊断文件内容

生成的诊断文件通常包含以下关键信息：

1. 原始 SQL 语句
2. 查询优化器生成的执行计划
3. 统计信息
4. 优化器决策过程
5. 相关表的元数据信息

应用场景

PLAN REPLAYER DUMP 在以下场景特别有用：

1. 性能调优：当查询性能不符合预期时，可以分析执行计划
2. 问题诊断：当查询结果异常时，可以检查优化器决策
3. 版本升级验证：比较不同版本 Doris 对同一查询的执行计划差异
4. 教学演示：用于展示查询优化器的工作原理

注意事项

1. 诊断文件可能包含敏感信息，应妥善保管
2. 生成诊断文件会对系统产生额外开销，不建议在高负载时频繁使用
3. 诊断文件的大小取决于查询复杂度，复杂查询可能生成较大文件

通过 PLAN REPLAYER DUMP 工具，Doris 用户可以更深入地理解查询执行过程，快速定位和解决查询优化相关问题。