pg_stat_activitypg_stat_replicationpg_stat_replication_slotspg_stat_wal_receiverpg_stat_recovery_prefetchpg_stat_subscriptionpg_stat_subscription_statspg_stat_sslpg_stat_gssapipg_stat_archiverpg_stat_bgwriterpg_stat_walpg_stat_databasepg_stat_database_conflictspg_stat_all_tablespg_stat_all_indexespg_statio_all_tablespg_statio_all_indexespg_statio_all_sequencespg_stat_user_functionspg_stat_slruPostgreSQL's cumulative statistics system supports collection and reporting of information about server activity. Presently, accesses to tables and indexes in both disk-block and individual-row terms are counted. The total number of rows in each table, and information about vacuum and analyze actions for each table are also counted. If enabled, calls to user-defined functions and the total time spent in each one are counted as well.
PostgreSQL also supports reporting dynamic information about exactly what is going on in the system right now, such as the exact command currently being executed by other server processes, and which other connections exist in the system. This facility is independent of the cumulative statistics system.
Since collection of statistics adds some overhead to query execution, the system can be configured to collect or not collect information. This is controlled by configuration parameters that are normally set in postgresql.conf. (See Chapter 20 for details about setting configuration parameters.)
The parameter track_activities enables monitoring of the current command being executed by any server process.
The parameter track_counts controls whether cumulative statistics are collected about table and index accesses.
The parameter track_functions enables tracking of usage of user-defined functions.
The parameter track_io_timing enables monitoring of block read and write times.
The parameter track_wal_io_timing enables monitoring of WAL write times.
Normally these parameters are set in postgresql.conf so that they apply to all server processes, but it is possible to turn them on or off in individual sessions using the SET command. (To prevent ordinary users from hiding their activity from the administrator, only superusers are allowed to change these parameters with SET.)
Cumulative statistics are collected in shared memory. Every PostgreSQL process collects statistics locally, then updates the shared data at appropriate intervals. When a server, including a physical replica, shuts down cleanly, a permanent copy of the statistics data is stored in the pg_stat subdirectory, so that statistics can be retained across server restarts. In contrast, when starting from an unclean shutdown (e.g., after an immediate shutdown, a server crash, starting from a base backup, and point-in-time recovery), all statistics counters are reset.
Several predefined views, listed in Table 28.1, are available to show the current state of the system. There are also several other views, listed in Table 28.2, available to show the accumulated statistics. Alternatively, one can build custom views using the underlying cumulative statistics functions, as discussed in Section 28.2.24.
When using the cumulative statistics views and functions to monitor collected data, it is important to realize that the information does not update instantaneously. Each individual server process flushes out accumulated statistics to shared memory just before going idle, but not more frequently than once per PGSTAT_MIN_INTERVAL milliseconds (1 second unless altered while building the server); so a query or transaction still in progress does not affect the displayed totals and the displayed information lags behind actual activity. However, current-query information collected by track_activities is always up-to-date.
Another important point is that when a server process is asked to display any of the accumulated statistics, accessed values are cached until the end of its current transaction in the default configuration. So the statistics will show static information as long as you continue the current transaction. Similarly, information about the current queries of all sessions is collected when any such information is first requested within a transaction, and the same information will be displayed throughout the transaction. This is a feature, not a bug, because it allows you to perform several queries on the statistics and correlate the results without worrying that the numbers are changing underneath you. When analyzing statistics interactively, or with expensive queries, the time delta between accesses to individual statistics can lead to significant skew in the cached statistics. To minimize skew, stats_fetch_consistency can be set to snapshot, at the price of increased memory usage for caching not-needed statistics data. Conversely, if it's known that statistics are only accessed once, caching accessed statistics is unnecessary and can be avoided by setting stats_fetch_consistency to none. You can invoke pg_stat_clear_snapshot() to discard the current transaction's statistics snapshot or cached values (if any). The next use of statistical information will (when in snapshot mode) cause a new snapshot to be built or (when in cache mode) accessed statistics to be cached.
A transaction can also see its own statistics (not yet flushed out to the shared memory statistics) in the views pg_stat_xact_all_tables, pg_stat_xact_sys_tables, pg_stat_xact_user_tables, and pg_stat_xact_user_functions. These numbers do not act as stated above; instead they update continuously throughout the transaction.
Some of the information in the dynamic statistics views shown in Table 28.1 is security restricted. Ordinary users can only see all the information about their own sessions (sessions belonging to a role that they are a member of). In rows about other sessions, many columns will be null. Note, however, that the existence of a session and its general properties such as its sessions user and database are visible to all users. Superusers and roles with privileges of built-in role pg_read_all_stats (see also Section 22.5) can see all the information about all sessions.
Table 28.1. Dynamic Statistics Views
| View Name | Description |
|---|---|
pg_stat_activity |
One row per server process, showing information related to the current activity of that process, such as state and current query. See pg_stat_activity for details. |
pg_stat_replication |
One row per WAL sender process, showing statistics about replication to that sender's connected standby server. See pg_stat_replication for details. |
pg_stat_wal_receiver |
Only one row, showing statistics about the WAL receiver from that receiver's connected server. See pg_stat_wal_receiver for details. |
pg_stat_recovery_prefetch |
Only one row, showing statistics about blocks prefetched during recovery. See pg_stat_recovery_prefetch for details. |
pg_stat_subscription |
At least one row per subscription, showing information about the subscription workers. See pg_stat_subscription for details. |
pg_stat_ssl |
One row per connection (regular and replication), showing information about SSL used on this connection. See pg_stat_ssl for details. |
pg_stat_gssapi |
One row per connection (regular and replication), showing information about GSSAPI authentication and encryption used on this connection. See pg_stat_gssapi for details. |
pg_stat_progress_analyze |
One row for each backend (including autovacuum worker processes) running ANALYZE, showing current progress. See Section 28.4.1. |
pg_stat_progress_create_index |
One row for each backend running CREATE INDEX or REINDEX, showing current progress. See Section 28.4.2. |
pg_stat_progress_vacuum |
One row for each backend (including autovacuum worker processes) running VACUUM, showing current progress. See Section 28.4.3. |
pg_stat_progress_cluster |
One row for each backend running CLUSTER or VACUUM FULL, showing current progress. See Section 28.4.4. |
pg_stat_progress_basebackup |
One row for each WAL sender process streaming a base backup, showing current progress. See Section 28.4.5. |
pg_stat_progress_copy |
One row for each backend running COPY, showing current progress. See Section 28.4.6. |
Table 28.2. Collected Statistics Views
| View Name | Description |
|---|---|
pg_stat_archiver |
One row only, showing statistics about the WAL archiver process's activity. See pg_stat_archiver for details. |
pg_stat_bgwriter |
One row only, showing statistics about the background writer process's activity. See pg_stat_bgwriter for details. |
pg_stat_wal |
One row only, showing statistics about WAL activity. See pg_stat_wal for details. |
pg_stat_database |
One row per database, showing database-wide statistics. See pg_stat_database for details. |
pg_stat_database_conflicts |
One row per database, showing database-wide statistics about query cancels due to conflict with recovery on standby servers. See pg_stat_database_conflicts for details. |
pg_stat_all_tables |
One row for each table in the current database, showing statistics about accesses to that specific table. See pg_stat_all_tables for details. |
pg_stat_sys_tables |
Same as pg_stat_all_tables, except that only system tables are shown. |
pg_stat_user_tables |
Same as pg_stat_all_tables, except that only user tables are shown. |
pg_stat_xact_all_tables |
Similar to pg_stat_all_tables, but counts actions taken so far within the current transaction (which are not yet included in pg_stat_all_tables and related views). The columns for numbers of live and dead rows and vacuum and analyze actions are not present in this view. |
pg_stat_xact_sys_tables |
Same as pg_stat_xact_all_tables, except that only system tables are shown. |
pg_stat_xact_user_tables |
Same as pg_stat_xact_all_tables, except that only user tables are shown. |
pg_stat_all_indexes |
One row for each index in the current database, showing statistics about accesses to that specific index. See pg_stat_all_indexes for details. |
pg_stat_sys_indexes |
Same as pg_stat_all_indexes, except that only indexes on system tables are shown. |
pg_stat_user_indexes |
Same as pg_stat_all_indexes, except that only indexes on user tables are shown. |
pg_statio_all_tables |
One row for each table in the current database, showing statistics about I/O on that specific table. See pg_statio_all_tables for details. |
pg_statio_sys_tables |
Same as pg_statio_all_tables, except that only system tables are shown. |
pg_statio_user_tables |
Same as pg_statio_all_tables, except that only user tables are shown. |
pg_statio_all_indexes |
One row for each index in the current database, showing statistics about I/O on that specific index. See pg_statio_all_indexes for details. |
pg_statio_sys_indexes |
Same as pg_statio_all_indexes, except that only indexes on system tables are shown. |
pg_statio_user_indexes |
Same as pg_statio_all_indexes, except that only indexes on user tables are shown. |
pg_statio_all_sequences |
One row for each sequence in the current database, showing statistics about I/O on that specific sequence. See pg_statio_all_sequences for details. |
pg_statio_sys_sequences |
Same as pg_statio_all_sequences, except that only system sequences are shown. (Presently, no system sequences are defined, so this view is always empty.) |
pg_statio_user_sequences |
Same as pg_statio_all_sequences, except that only user sequences are shown. |
pg_stat_user_functions |
One row for each tracked function, showing statistics about executions of that function. See pg_stat_user_functions for details. |
pg_stat_xact_user_functions |
Similar to pg_stat_user_functions, but counts only calls during the current transaction (which are not yet included in pg_stat_user_functions). |
pg_stat_slru |
One row per SLRU, showing statistics of operations. See pg_stat_slru for details. |
pg_stat_replication_slots |
One row per replication slot, showing statistics about the replication slot's usage. See pg_stat_replication_slots for details. |
pg_stat_subscription_stats |
One row per subscription, showing statistics about errors. See pg_stat_subscription_stats for details. |
The per-index statistics are particularly useful to determine which indexes are being used and how effective they are.
The pg_statio_ views are primarily useful to determine the effectiveness of the buffer cache. When the number of actual disk reads is much smaller than the number of buffer hits, then the cache is satisfying most read requests without invoking a kernel call. However, these statistics do not give the entire story: due to the way in which PostgreSQL handles disk I/O, data that is not in the PostgreSQL buffer cache might still reside in the kernel's I/O cache, and might therefore still be fetched without requiring a physical read. Users interested in obtaining more detailed information on PostgreSQL I/O behavior are advised to use the PostgreSQL statistics views in combination with operating system utilities that allow insight into the kernel's handling of I/O.
pg_stat_activityThe pg_stat_activity view will have one row per server process, showing information related to the current activity of that process.
Table 28.3. pg_stat_activity View
|
Column Type Description |
|---|
|
OID of the database this backend is connected to |
|
Name of the database this backend is connected to |
|
Process ID of this backend |
|
Process ID of the parallel group leader, if this process is a parallel query worker. |
|
OID of the user logged into this backend |
|
Name of the user logged into this backend |
|
Name of the application that is connected to this backend |
|
IP address of the client connected to this backend. If this field is null, it indicates either that the client is connected via a Unix socket on the server machine or that this is an internal process such as autovacuum. |
|
Host name of the connected client, as reported by a reverse DNS lookup of |
|
TCP port number that the client is using for communication with this backend, or |
|
Time when this process was started. For client backends, this is the time the client connected to the server. |
|
Time when this process' current transaction was started, or null if no transaction is active. If the current query is the first of its transaction, this column is equal to the |
|
Time when the currently active query was started, or if |
|
Time when the |
|
The type of event for which the backend is waiting, if any; otherwise NULL. See Table 28.4. |
|
Wait event name if backend is currently waiting, otherwise NULL. See Table 28.5 through Table 28.13. |
|
Current overall state of this backend. Possible values are:
|
|
Top-level transaction identifier of this backend, if any. |
|
The current backend's |
|
Identifier of this backend's most recent query. If |
|
Text of this backend's most recent query. If |
|
Type of current backend. Possible types are |
The wait_event and state columns are independent. If a backend is in the active state, it may or may not be waiting on some event. If the state is active and wait_event is non-null, it means that a query is being executed, but is being blocked somewhere in the system.
Table 28.4. Wait Event Types
| Wait Event Type | Description |
|---|---|
Activity |
The server process is idle. This event type indicates a process waiting for activity in its main processing loop. wait_event will identify the specific wait point; see Table 28.5. |
BufferPin |
The server process is waiting for exclusive access to a data buffer. Buffer pin waits can be protracted if another process holds an open cursor that last read data from the buffer in question. See Table 28.6. |
Client |
The server process is waiting for activity on a socket connected to a user application. Thus, the server expects something to happen that is independent of its internal processes. wait_event will identify the specific wait point; see Table 28.7. |
Extension |
The server process is waiting for some condition defined by an extension module. See Table 28.8. |
IO |
The server process is waiting for an I/O operation to complete. wait_event will identify the specific wait point; see Table 28.9. |
IPC |
The server process is waiting for some interaction with another server process. wait_event will identify the specific wait point; see Table 28.10. |
Lock |
The server process is waiting for a heavyweight lock. Heavyweight locks, also known as lock manager locks or simply locks, primarily protect SQL-visible objects such as tables. However, they are also used to ensure mutual exclusion for certain internal operations such as relation extension. wait_event will identify the type of lock awaited; see Table 28.11. |
LWLock |
The server process is waiting for a lightweight lock. Most such locks protect a particular data structure in shared memory. wait_event will contain a name identifying the purpose of the lightweight lock. (Some locks have specific names; others are part of a group of locks each with a similar purpose.) See Table 28.12. |
Timeout |
The server process is waiting for a timeout to expire. wait_event will identify the specific wait point; see Table 28.13. |
Table 28.5. Wait Events of Type Activity
Activity Wait Event |
Description |
|---|---|
ArchiverMain |
Waiting in main loop of archiver process. |
AutoVacuumMain |
Waiting in main loop of autovacuum launcher process. |
BgWriterHibernate |
Waiting in background writer process, hibernating. |
BgWriterMain |
Waiting in main loop of background writer process. |
CheckpointerMain |
Waiting in main loop of checkpointer process. |
LogicalApplyMain |
Waiting in main loop of logical replication apply process. |
LogicalLauncherMain |
Waiting in main loop of logical replication launcher process. |
RecoveryWalStream |
Waiting in main loop of startup process for WAL to arrive, during streaming recovery. |
SysLoggerMain |
Waiting in main loop of syslogger process. |
WalReceiverMain |