PostgreSQL 教程

Appearance

F.4. auto_explain — 记录慢查询的执行计划# ​

F.4.1. 配置参数
F.4.2. 示例
F.4.3. 作者

auto_explain模块提供了一种自动记录慢语句执行计划的方法，而无需手动运行EXPLAIN。这对于追踪大型应用程序中的未优化查询特别有用。

该模块不提供可通过 SQL 访问的函数。要使用它，只需将其加载到服务器中即可。您可以将其加载到单个会话中

LOAD 'auto_explain';

(您必须是超级用户才能执行此操作。) 更典型的用法是通过在postgresql.conf中的session_preload_libraries或shared_preload_libraries中包含auto_explain来将其预加载到某些或所有会话中。然后，无论何时发生意外的慢查询，您都可以对其进行追踪。当然，这样做会产生开销。

F.4.1. 配置参数# ​

有几个配置参数控制auto_explain的行为。请注意，默认行为是不执行任何操作，因此如果您想要任何结果，则必须至少设置auto_explain.log_min_duration。

auto_explain.log_min_duration (integer) #

auto_explain.log_min_duration 是以毫秒为单位的最小语句执行时间，它将导致记录语句的计划。将其设置为 0 将记录所有计划。-1（默认值）禁用计划记录。例如，如果您将其设置为 250ms，则所有运行 250 毫秒或更长时间的语句都将被记录。只有超级用户可以更改此设置。

auto_explain.log_parameter_max_length (integer) #

auto_explain.log_parameter_max_length 控制查询参数值的记录。值为 -1（默认值）时，完整记录参数值。 0 禁用参数值的记录。大于零的值将每个参数值截断为该字节数。只有超级用户可以更改此设置。

auto_explain.log_analyze (boolean) #

auto_explain.log_analyze 导致打印 EXPLAIN ANALYZE 输出，而不仅仅是 EXPLAIN 输出，当执行计划被记录时。此参数默认关闭。只有超级用户可以更改此设置。

注意

当此参数开启时，所有执行的语句都会发生按计划节点计时，无论它们是否运行足够长的时间以实际获取记录。这会对性能产生极大的负面影响。关闭 auto_explain.log_timing 可以缓解性能成本，但代价是获取的信息更少。

auto_explain.log_buffers (boolean) #

auto_explain.log_buffers 控制当执行计划被记录时是否打印缓冲区使用情况统计信息；它等同于 EXPLAIN 的 BUFFERS 选项。除非启用 auto_explain.log_analyze，否则此参数不起作用。此参数默认关闭。只有超级用户可以更改此设置。

auto_explain.log_wal (boolean) #

auto_explain.log_wal 控制当执行计划被记录时是否打印 WAL 使用情况统计信息；它等同于 EXPLAIN 的 WAL 选项。除非启用 auto_explain.log_analyze，否则此参数不起作用。此参数默认关闭。只有超级用户可以更改此设置。

auto_explain.log_timing (boolean) #

auto_explain.log_timing 控制当执行计划被记录时是否打印按节点计时信息；它等同于 EXPLAIN 的 TIMING 选项。在某些系统上，反复读取系统时钟的开销会显著降低查询速度，因此当只需要实际行数而不是确切时间时，将此参数设置为关闭可能很有用。除非启用 auto_explain.log_analyze，否则此参数不起作用。此参数默认开启。只有超级用户可以更改此设置。

auto_explain.log_triggers (布尔值) #

auto_explain.log_triggers 在记录执行计划时会导致包含触发器执行统计信息。除非启用了 auto_explain.log_analyze，否则此参数无效。此参数默认关闭。只有超级用户可以更改此设置。

auto_explain.log_verbose (布尔值) #

auto_explain.log_verbose 控制在记录执行计划时是否打印详细详细信息；它等效于 EXPLAIN 的 VERBOSE 选项。此参数默认关闭。只有超级用户可以更改此设置。

auto_explain.log_settings (布尔值) #

auto_explain.log_settings 控制在记录执行计划时是否打印有关修改的配置选项的信息。仅包含影响查询计划且值与内置默认值不同的选项。此参数默认关闭。只有超级用户可以更改此设置。

auto_explain.log_format (枚举) #

auto_explain.log_format 选择要使用的 EXPLAIN 输出格式。允许的值为 text、xml、json 和 yaml。默认值为文本。只有超级用户可以更改此设置。

auto_explain.log_level (枚举) #

auto_explain.log_level 选择 auto_explain 将记录查询计划的日志级别。有效值为 DEBUG5、DEBUG4、DEBUG3、DEBUG2、DEBUG1、INFO、NOTICE、WARNING 和 LOG。默认值为 LOG。只有超级用户可以更改此设置。

auto_explain.log_nested_statements (布尔值) #

auto_explain.log_nested_statements 导致考虑记录嵌套语句（在函数中执行的语句）。当它关闭时，只有顶级查询计划被记录。此参数默认关闭。只有超级用户可以更改此设置。

auto_explain.sample_rate (实数) #

auto_explain.sample_rate 导致 auto_explain 仅解释每个会话中的一部分语句。默认值为 1，表示解释所有查询。对于嵌套语句，要么全部解释，要么都不解释。只有超级用户可以更改此设置。

在一般用法中，这些参数在postgresql.conf中设置，尽管超级用户可以在自己的会话中随时更改它们。典型用法可能是

# postgresql.conf
session_preload_libraries = 'auto_explain'

auto_explain.log_min_duration = '3s'

F.4.2. 示例# ​

postgres=# LOAD 'auto_explain';
postgres=# SET auto_explain.log_min_duration = 0;
postgres=# SET auto_explain.log_analyze = true;
postgres=# SELECT count(*)
           FROM pg_class, pg_index
           WHERE oid = indrelid AND indisunique;

这可能会产生诸如

LOG:  duration: 3.651 ms  plan:
  Query Text: SELECT count(*)
              FROM pg_class, pg_index
              WHERE oid = indrelid AND indisunique;
  Aggregate  (cost=16.79..16.80 rows=1 width=0) (actual time=3.626..3.627 rows=1 loops=1)
    ->  Hash Join  (cost=4.17..16.55 rows=92 width=0) (actual time=3.349..3.594 rows=92 loops=1)
          Hash Cond: (pg_class.oid = pg_index.indrelid)
          ->  Seq Scan on pg_class  (cost=0.00..9.55 rows=255 width=4) (actual time=0.016..0.140 rows=255 loops=1)
          ->  Hash  (cost=3.02..3.02 rows=92 width=4) (actual time=3.238..3.238 rows=92 loops=1)
                Buckets: 1024  Batches: 1  Memory Usage: 4kB
                ->  Seq Scan on pg_index  (cost=0.00..3.02 rows=92 width=4) (actual time=0.008..3.187 rows=92 loops=1)
                      Filter: indisunique

F.4.3. 作者# ​

Takahiro Itagaki<[[email protected]](/cdn-cgi/l/email-protection#325b46535553595b1c465359535a5b405d725d41411c5c46461c515d1c5842)>