↑↓ 选择 ↵ 打开 ⌫ 改范围 完整检索页

pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。

百科 / 配置参数 / 错误报告和日志

CONFIGURATION PARAMETER错误报告和日志 / 记录什么

debug_print_plan

这些参数会启用多种调试输出。

Logs each query's execution plan.

布尔 会话 引入 7.4(基线) 现存至 20 devel 0 次默认值变更

类型
布尔bool
上下文
会话任何用户都可在会话内用 SET 修改
默认值
off
引入版本
7.4(基线)
状态
现存

PostgreSQL 18.7 手册 官方文档

版本轨迹

相对 PostgreSQL 17 无变化。

默认值变迁

off 9.0 – 19

已记录的默认值在 PostgreSQL 9.0–19 之间未变。带单位的取值换算成了可读形式,原始的 boot_val 与单位写在悬浮提示里。

手册说明

PostgreSQL 18.7 手册 · 19.8 错误报告和日志 本站手册 官方原文

这些参数将会让多种调试输出被发出。当被设置时,它们为每一个被执行的查询打印结果分析树、查询重写器输出或执行计划。这些消息在 LOG 消息级别上被发出,因此默认情况下它们将出现在服务器日志中但不会被发送到客户端。你可以通过调整 client_min_messages 和/或 log_min_messages 来改变这种情况。这些参数默认是关闭的。

机制详解

debug_print_plan:记录每个查询的执行计划树。输出是每条查询的内部计划树,比定向执行 EXPLAIN 冗长得多,主要用于服务器调试。

debug_print_plan 属于 USER 上下文。获授权角色可在会话内修改,ALTER ROLE 或 ALTER DATABASE 可为未来会话建立默认值。

debug_print_* 开关沿普通服务器日志路径输出,因此 log_min_messages、log_destination 与收集器容量共同决定内容能否安全保留。

调优建议

按典型负载给出的取值思路,不是放之四海皆准的配方:实际取值要看数据量、并发度与硬件。

  • OLTP在线事务处理

    不应在生产环境全局调优或启用 debug_print_plan。若服务器开发级诊断确有需要,只在单一会话短时开启,并安全接收产生的日志。

  • OLAP分析与批处理

    不要用 debug_print_plan 替代分析 SQL 的 EXPLAIN;应定向抓取计划,而不是转储每一棵内部树。

  • 小规格低配实例与开发机

    保持 debug_print_plan 的正常默认值。冗长内部树可能意外耗尽小节点的日志 I/O 与磁盘。

常见问题

  • 只在一个会话中修改 debug_print_plan,却认为角色默认值、数据库默认值或其他池化会话也已随之改变。
  • 全局长期打开内部树转储,压垮日志 I/O、存储或摄取。
  • 把调试输出当作稳定公共格式,或用它替代定向 EXPLAIN 诊断。
  • 没有回滚计划及客户端或运维兼容测试,就全局修改 debug_print_plan。

演化历史

相邻两个大版本之间的差异,新的在前。版本号链到该版的快照。

  1. 本数据集收录 debug_print_plan 以来没有记录到变化。

逐版本快照

每个收录版本里的 7 项事实,与上一个存在的版本不同的格子带底色。版本号链到该版。

版本 默认值单位上下文类型最小值最大值枚举值
7.4 — — — 布尔 — — —
8.0 — — — 布尔 — — —
8.1 — — — 布尔 — — —
8.2 — — — 布尔 — — —
8.3 — — — 布尔 — — —
8.4 — — — 布尔 — — —
9.0 off — 会话 布尔 — — —
9.1 off — 会话 布尔 — — —
9.2 off — 会话 布尔 — — —
9.3 off — 会话 布尔 — — —
9.4 off — 会话 布尔 — — —
9.5 off — 会话 布尔 — — —
9.6 off — 会话 布尔 — — —
10 off — 会话 布尔 — — —
11 off — 会话 布尔 — — —
12 off — 会话 布尔 — — —
13 off — 会话 布尔 — — —
14 off — 会话 布尔 — — —
15 off — 会话 布尔 — — —
16 off — 会话 布尔 — — —
17 off — 会话 布尔 — — —
18 off — 会话 布尔 — — —
19 off — 会话 布尔 — — —
20 — — — 布尔 — — —

参考资料

同类参数

参数 类型 上下文 默认值 版本变动 最近变更
Reporting and Logging 错误报告和日志 25 个 ↗
记录什么 25
application_name 字符串 会话 空字符串 —
application_name 可以是任意小于 NAMEDATALEN 个字符(标准编译中是 64 个字符)的字符串。 现存
debug_pretty_print 布尔 会话 on —
当被设置时,debug_pretty_print 会缩进由 debug_print_raw_parse、debug_print_parse、debug_print_rewritten 或 debug_print_plan 产生的输出。 现存
debug_print_parse 布尔 会话 off —
这些参数会启用多种调试输出。 现存
debug_print_plan 布尔 会话 off —
这些参数会启用多种调试输出。 现存
debug_print_raw_parse 布尔 — —
这些参数会启用多种调试输出。 现存
debug_print_rewritten 布尔 会话 off —
这些参数会启用多种调试输出。 现存
log_autoanalyze_min_duration 整数 — —
当自动清理执行的分析操作运行时间至少达到指定时间时,就会记录该操作。 现存
log_autovacuum_min_duration 整数 重载生效 10 min 152 次
当自动清理执行的清理操作运行时间至少达到指定时间时,就会记录该操作。 现存
log_checkpoints 布尔 重载生效 on 151 次
导致检查点和重启点在服务器日志中记录。 现存
log_connections 字符串 连接时(超级用户) 空字符串 182 次
控制是否记录到服务器的每次连接的相关信息。 现存
log_disconnections 布尔 连接时(超级用户) off 9.51 次
导致会话终止被记录。 现存
log_duration 布尔 会话(超级用户) off —
记录每个已完成语句的持续时间。 现存
log_error_verbosity 枚举 会话(超级用户) default 8.41 次
控制在服务器日志中记录的每条消息的详细程度。 现存
log_hostname 布尔 重载生效 off —
默认情况下,连接日志消息只显示连接主机的 IP 地址。 现存
log_line_prefix 字符串 重载生效 %m [%p] 101 次
这是一个 printf 风格的字符串,它在发送到 stderr、syslog 或 eventlog 的每条日志条目的开头输出。 现存
log_lock_failures 布尔 会话(超级用户) off —
控制当获取锁失败时是否生成详细日志消息。 现存
log_lock_waits 布尔 会话(超级用户) off 191 次
控制会话为获取锁而等待的时间超过 deadlock_timeout 时是否生成日志消息。 现存
log_parameter_max_length 整数 会话(超级用户) -1 B —
如果大于零,则记录在非错误语句日志消息中的每个绑定参数值都会被截断为指定的字节数。 现存
log_parameter_max_length_on_error 整数 会话 0 B —
如果大于零,则错误消息中报告的每个绑定参数值都将裁剪为这么多字节。 现存
log_recovery_conflict_waits 布尔 重载生效 off —
控制启动进程因恢复冲突而等待超过 deadlock_timeout 时是否产生日志消息。 现存
log_replication_commands 布尔 会话(超级用户) off —
在服务器日志中记录每个复制命令,以及 walsender 进程获取和释放复制槽的操作。 现存
log_statement 枚举 会话(超级用户) none 8.42 次
控制哪些 SQL 语句被记录。 现存
log_statement_max_length 整数 — —
如果大于零,通过 log_statement、log_min_duration_statement、log_min_duration_sample 或 log_transaction_sample_rate 记录的每条语句,其文本都会被截断为最多这么多字节。 现存
log_temp_files 整数 会话(超级用户) -1 kB —
控制临时文件名和大小的日志记录。 现存
log_timezone 字符串 重载生效 GMT 9.22 次
设置在服务器日志中写入的时间戳的时区。 现存