↑↓ 选择↵ 打开⌫ 切换范围完整搜索

PG.CENTER 连接 PostgreSQL 文档、百科与生态知识。由 Pigsty 维护。

支持中的版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发中的版本: 19 / 20devel
已结束支持的版本: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4
历史版本。 PostgreSQL 9.0 已结束支持。 2015-10-08. 请参阅 当前版本手册.

F.29. pg_stat_statements #

pg_stat_statements模块提供了一种机制,用于跟踪服务器执行的所有 SQL 语句的执行统计信息。

由于该模块需要额外的共享内存,因此必须通过在postgresql.conf中将pg_stat_statements加入shared_preload_libraries来加载该模块。这意味着添加或移除此模块都需要重启服务器。

F.29.1. pg_stat_statements 视图

该模块收集的统计信息可通过名为 pg_stat_statements 的系统视图获取。该视图为每个不同的查询文本、数据库 ID 和用户 ID 各包含一行(最多达到该模块能够跟踪的不同语句数量上限)。视图的列见表 F.20。

表 F.20. pg_stat_statements 列

NameTypeReferencesDescription
useridoidpg_authid.oid执行该语句的用户的 OID
dbidoidpg_database.oid执行该语句的数据库的 OID
querytext 语句的文本(最多track_activity_query_size字节)
callsbigint 执行次数
total_timedouble precision 该语句所花费的总时间,单位为秒
rowsbigint 该语句检索或影响的总行数
shared_blks_hitbigint 该语句的共享块缓存命中总数
shared_blks_readbigint 该语句读取的共享块总数
shared_blks_writtenbigint 该语句写入的共享块总数
local_blks_hitbigint 该语句的本地块缓存命中总数
local_blks_readbigint 该语句读取的本地块总数
local_blks_writtenbigint 该语句写入的本地块总数
temp_blks_readbigint 该语句读取的临时块总数
temp_blks_writtenbigint 该语句写入的临时块总数

该视图以及函数 pg_stat_statements_reset,只有在通过运行 pg_stat_statements.sql 安装脚本而专门安装了它们的数据库中才可用。不过,只要 pg_stat_statements 模块被装载到服务器中,无论视图是否存在,它都会跟踪该服务器上所有数据库的统计信息。

出于安全原因,非超级用户不允许查看其他用户执行的查询的文本。不过,只要该视图已经安装在其数据库中,他们仍然可以查看统计信息。

注意,只要文本相同,语句就被视为相同的语句,无论语句中使用的任何离线参数的值如何。使用离线参数有助于把语句分组,从而可能使统计信息更有用。

F.29.2. 函数

pg_stat_statements_reset() returns void

pg_stat_statements_reset会丢弃到目前为止由pg_stat_statements收集的所有统计信息。默认情况下,只有超级用户可以执行此函数。

F.29.3. Configuration parameters

pg_stat_statements.max (integer)

pg_stat_statements.max 是该模块跟踪的语句最大数量(即 pg_stat_statements 视图中的最大行数)。如果观察到的不同语句超过该数量,则执行次数最少的语句信息会被丢弃。默认值为 1000。该参数只能在服务器启动时设置。

pg_stat_statements.track (enum)

pg_stat_statements.track 控制该模块统计哪些语句。指定 top 可跟踪顶层语句(即直接由客户端发出的语句),指定 all 还会跟踪嵌套语句(例如在函数内调用的语句),而指定 none 则会禁用。默认值为 top。只有超级用户可以更改此设置。

pg_stat_statements.track_utility (boolean)

pg_stat_statements.track_utility 控制该模块是否跟踪实用命令。实用命令是除 SELECT、INSERT、UPDATE 和 DELETE 之外的所有命令。默认值为 on。只有超级用户可以更改此设置。

pg_stat_statements.save (boolean)

pg_stat_statements.save 指定是否在服务器关闭后保留语句统计信息。如果它为 off,则在关闭时不会保存统计信息,并且在服务器启动时也不会重新载入这些统计信息。默认值为 on。该参数只能在 postgresql.conf 文件中或在服务器命令行上设置。

该模块需要约 pg_stat_statements.max * track_activity_query_size字节的额外共享内存。注意,只要该模块被装载,就会消耗这些内存,即使 pg_stat_statements.track 被设为 none。

为了能在 postgresql.conf 文件中设置这些参数,你需要把 pg_stat_statements 加入custom_variable_classes。典型用法如下:

# postgresql.conf
shared_preload_libraries = 'pg_stat_statements'

custom_variable_classes = 'pg_stat_statements'
pg_stat_statements.max = 10000
pg_stat_statements.track = all

F.29.4. Sample output

bench=# SELECT pg_stat_statements_reset();

$ pgbench -i bench
$ pgbench -c10 -t300 -M prepared bench

bench=# \x
bench=# SELECT query, calls, total_time, rows, 100.0 * shared_blks_hit /
               nullif(shared_blks_hit + shared_blks_read, 0) AS hit_percent
          FROM pg_stat_statements ORDER BY total_time DESC LIMIT 5;
-[ RECORD 1 ]---------------------------------------------------------------------
query       | UPDATE pgbench_branches SET bbalance = bbalance + $1 WHERE bid = $2;
calls       | 3000
total_time  | 9.60900100000002
rows        | 2836
hit_percent | 99.9778970000200936
-[ RECORD 2 ]---------------------------------------------------------------------
query       | UPDATE pgbench_tellers SET tbalance = tbalance + $1 WHERE tid = $2;
calls       | 3000
total_time  | 8.015156
rows        | 2990
hit_percent | 99.9731126579631345
-[ RECORD 3 ]---------------------------------------------------------------------
query       | copy pgbench_accounts from stdin
calls       | 1
total_time  | 0.310624
rows        | 100000
hit_percent | 0.30395136778115501520
-[ RECORD 4 ]---------------------------------------------------------------------
query       | UPDATE pgbench_accounts SET abalance = abalance + $1 WHERE aid = $2;
calls       | 3000
total_time  | 0.271741999999997
rows        | 3000
hit_percent | 93.7968855088209426
-[ RECORD 5 ]---------------------------------------------------------------------
query       | alter table pgbench_accounts add primary key (aid)
calls       | 1
total_time  | 0.08142
rows        | 0
hit_percent | 34.4947735191637631

F.29.5. Author

Takahiro Itagaki

报告文档问题

阅读 上游文档. 反馈更正前请先核对 当前版本手册.