auto_explain 模块提供了一种方法，可以自动记录慢速语句的执行计划，而无需手动运行 EXPLAIN。这对于在大型应用程序中跟踪未优化的查询特别有用。
该模块不提供任何 SQL 可访问的函数。要使用它，只需将其加载到服务器中。您可以将其加载到单个会话中
LOAD 'auto_explain';
（您必须是超级用户才能这样做。）更典型的用法是通过将 auto_explain 包含在 postgresql.conf 文件中的 session_preload_libraries 或 shared_preload_libraries 中，将其预加载到部分或所有会话中。然后，无论何时发生，您都可以跟踪意外的慢速查询。当然，这样做会带来一定的开销。
有几个配置参数控制 auto_explain 的行为。请注意，默认行为是不执行任何操作，因此，如果您想要任何结果，则必须至少设置 auto_explain.log_min_duration。
auto_explain.log_min_duration (integer) #auto_explain.log_min_duration 是语句执行时间的最小值（以毫秒为单位），如果超过此值，则会记录该语句的计划。将其设置为 0 将记录所有计划。 -1（默认值）将禁用记录计划。例如，如果您将其设置为 250ms，则所有运行时间为 250ms 或更长的语句都将被记录。只有超级用户可以更改此设置。
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 (boolean) #auto_explain.log_triggers 会导致记录执行计划时包含触发器执行统计信息。除非 auto_explain.log_analyze 已启用，否则此参数无效。此参数默认关闭。只有超级用户可以更改此设置。
auto_explain.log_verbose (boolean) #auto_explain.log_verbose 控制是否在记录执行计划时打印详细的详细信息；它等同于 EXPLAIN 的 VERBOSE 选项。此参数默认关闭。只有超级用户可以更改此设置。
auto_explain.log_settings (boolean) #auto_explain.log_settings 控制是否在记录执行计划时打印有关修改的配置选项的信息。只有影响查询计划且值与内置默认值不同的选项才会包含在输出中。此参数默认关闭。只有超级用户可以更改此设置。
auto_explain.log_format (enum) #auto_explain.log_format 选择要使用的 EXPLAIN 输出格式。允许的值是 text、xml、json 和 yaml。默认值为文本。只有超级用户可以更改此设置。
auto_explain.log_level (enum) #auto_explain.log_level 选择 auto_explain 记录查询计划的日志级别。有效值为 DEBUG5、DEBUG4、DEBUG3、DEBUG2、DEBUG1、INFO、NOTICE、WARNING 和 LOG。默认值为 LOG。只有超级用户可以更改此设置。
auto_explain.log_nested_statements (boolean) #auto_explain.log_nested_statements 会导致嵌套语句（在函数内部执行的语句）被考虑进行记录。当它关闭时，只记录顶级查询计划。此参数默认关闭。只有超级用户可以更改此设置。
auto_explain.sample_rate (real) #auto_explain.sample_rate 会导致 auto_explain 仅解释每个会话中一小部分语句。默认值为 1，表示解释所有查询。在嵌套语句的情况下，要么全部解释，要么都不解释。只有超级用户可以更改此设置。
在一般使用中，这些参数是在 postgresql.conf 中设置的，但超级用户可以在自己的会话中动态更改它们。典型用法可能是
# postgresql.conf session_preload_libraries = 'auto_explain' auto_explain.log_min_duration = '3s'
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
板垣 孝浩 <[email protected]>
如果您在文档中发现任何不正确的内容，与您对特定功能的体验不符，或者需要进一步澄清，请使用 此表格 报告文档问题。