YugabyteDB中的auto_explain扩展：自动记录慢查询执行计划

胡霆圣

于 2025-06-05 09:05:02 发布

阅读量322

点赞数 5

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00317/article/details/148440726

YugabyteDB中的auto_explain扩展：自动记录慢查询执行计划

yugabyte-db yugabyte/yugabyte-db: 是 YugaByte DB 的官方仓库，一个高性能、高可扩展、分布式的 SQL 数据库，支持 PostgreSQL 兼容性。适合对分布式数据库、SQL 数据库和云原生应用的开发者。项目地址: https://gitcode.com/gh_mirrors/yu/yugabyte-db

什么是auto_explain扩展

auto_explain是PostgreSQL提供的一个实用模块，它能够自动记录执行时间超过阈值的SQL语句的执行计划。在YugabyteDB中，这个扩展同样可用，为数据库管理员和开发人员提供了强大的性能诊断工具。

为什么需要auto_explain

在日常数据库运维和开发过程中，我们经常会遇到性能问题。传统的方法是手动执行EXPLAIN命令来分析查询计划，但这种方法存在几个问题：

需要人工干预，无法自动化
难以捕捉偶发的性能问题
在生产环境中难以实时诊断

auto_explain扩展解决了这些问题，它可以：

自动记录慢查询的执行计划
无需人工干预
可以设置不同的详细级别
支持多种输出格式

启用auto_explain扩展

要在YugabyteDB中启用auto_explain扩展，需要修改数据库配置参数：

首先，将auto_explain添加到shared_preload_libraries参数中
这个修改需要重启YugabyteDB的TServer服务才能生效

配置示例：

--ysql_pg_conf_csv="shared_preload_libraries=auto_explain"

配置参数详解

auto_explain提供了多个配置参数，可以根据需求灵活调整：

基本配置

log_min_duration：设置记录执行计划的最小时间阈值（毫秒）
- 设置为0记录所有查询
- 默认-1表示禁用
- 例如设置为250表示记录执行时间≥250ms的查询

输出详细程度

log_analyze：是否输出实际执行统计信息（类似EXPLAIN ANALYZE）
log_buffers：是否包含缓冲区使用统计
log_timing：是否记录每个节点的执行时间
log_verbose：是否输出详细信息
log_triggers：是否包含触发器执行统计

输出格式

log_format：支持text/xml/json/yaml四种格式
- 默认是text格式

其他配置

log_nested_statements：是否记录嵌套语句（函数内的查询）
sample_rate：采样率（0-1之间）
log_dist：是否包含分布式执行信息（YugabyteDB特有）

使用示例

基本使用

-- 设置记录所有查询的执行计划
SET auto_explain.log_min_duration = 0;
-- 启用详细分析
SET auto_explain.log_analyze = true;

-- 执行查询
SELECT count(*) FROM large_table WHERE condition = 'value';

典型输出

日志文件中会记录类似以下内容：

LOG:  duration: 316.556 ms  plan:
        Query Text: SELECT count(*) FROM large_table WHERE condition = 'value';
        Aggregate  (cost=216.39..216.40 rows=1 width=8) 
          (actual time=316.489..316.489 rows=1 loops=1)
          ->  Seq Scan on large_table  
              (cost=0.00..213.89 rows=1000 width=0) 
              (actual time=10.828..316.200 rows=110 loops=1)
                Filter: (condition = 'value'::text)
                Rows Removed by Filter: 10000