diff --git a/REL_1_STABLE/USER_GUIDE.html b/REL_1_STABLE/USER_GUIDE.html
index e5b08d8..2672ec7 100644
--- a/REL_1_STABLE/USER_GUIDE.html
+++ b/REL_1_STABLE/USER_GUIDE.html
@@ -1442,8 +1442,9 @@ With this information, <code>pg_stat_monitor</code> enables users to track a que
 <p>Type: boolean. Default: 1</p>
 <p>This parameter controls whether utility commands are tracked by the module. Utility commands are all those other than <code>SELECT</code>, <code>INSERT</code>, <code>UPDATE</code>, and <code>DELETE</code>.</p>
 <h5 id="pg_stat_monitorpgsm_normalized_query">pg_stat_monitor.pgsm_normalized_query<a class="headerlink" href="#pg_stat_monitorpgsm_normalized_query" title="Permanent link">&para;</a></h5>
-<p>Type: boolean. Default: 1</p>
-<p>By default, the query shows the actual parameter instead of the placeholder. It is quite useful when users want to use that query and try to run that query to check the abnormalities. But in most cases users like the queries with a placeholder. This parameter is used to toggle between the two said options.</p>
+<p>Type: boolean. Default: 0</p>
+<p>By default, the query shows the actual parameter instead of the placeholder. It is quite useful when users want to use that query and try to run that query to check the abnormalities. Users should be aware, however, that running queries with disabled normalization can expose some sensitive data. </p>
+<p>But in most cases users like the queries with a placeholder. This parameter is used to toggle between the two said options.</p>
 <h5 id="pg_stat_monitorpgsm_max_buckets">pg_stat_monitor.pgsm_max_buckets<a class="headerlink" href="#pg_stat_monitorpgsm_max_buckets" title="Permanent link">&para;</a></h5>
 <p>Values:
 - Min: 1
diff --git a/REL_1_STABLE/search/search_index.json b/REL_1_STABLE/search/search_index.json
index 9d192c1..05b857f 100644
--- a/REL_1_STABLE/search/search_index.json
+++ b/REL_1_STABLE/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"index.html","text":"Welcome \u00b6 The pg_stat_monitor is a Query Performance Monitoring tool for PostgreSQL. It collects performance stats and provides query performance insights in a single view. These insights allow database users to understand query origins, execution, planning statistics and details, query information, and metadata. This significantly improves observability, enabling users to debug and tune query performance. How pg_stat_monitor works? \u00b6 pg_stat_monitor is developed on the basis of pg_stat_statements as its more advanced replacement. While pg_stat_statements provides ever-increasing metrics, pg_stat_monitor aggregates the collected data, saving user efforts for doing it themselves. pg_stat_monitor stores statistics in configurable time-based units \u2013 buckets . Such bucket-based data collection allows focusing on statistics generated for shorter time periods and makes query timing information such as max/min/mean time more accurate. Features \u00b6 Time Interval Grouping: Instead of supplying one set of ever-increasing counts, pg_stat_monitor computes stats for a configured number of time intervals - time buckets. This allows for much better data accuracy, especially in the case of high resolution or unreliable networks. Multi-Dimensional Grouping: While pg_stat_statements groups counters by userid, dbid, queryid, pg_stat_monitor uses a more detailed group for higher precision. This allows a user to drill down into the performance of queries. Capture Actual Parameters in the Queries: pg_stat_monitor allows you to choose if you want to see queries with placeholders for parameters or actual parameter data. This simplifies debugging and analysis processes by enabling users to execute the same query. Query Plan: Each SQL is now accompanied by its actual plan that was constructed for its execution. That\u2019s a huge advantage if you want to understand why a particular query is slower than expected. Tables Access Statistics for a Statement: This allows us to easily identify all queries that accessed a given table. This set is at par with the information provided by the pg_stat_statements . Histogram: Visual representation is very helpful as it can help identify issues. With the help of the histogram function, one can now view a timing/calling data histogram in response to an SQL query. And yes, it even works in psql. Availability \u00b6 pg_stat_monitor supports PostgreSQL versions 11 and above. It is compatible with both PostgreSQL provided by PostgreSQL Global Development Group (PGDG) and Percona Distribution for PostgreSQL . Supported versions \u00b6 The pg_stat_monitor should work on the latest version of both Percona Distribution for PostgreSQL and PostgreSQL, but is only tested with these versions: Distribution Version Provider Percona Distribution for PostgreSQL 11 , 12 , 13 and 14 Percona PostgreSQL 11, 12, 13 and 14 PostgreSQL Global Development Group (PGDG) The RPM (for RHEL and CentOS) and the DEB (for Debian and Ubuntu) packages are available from Percona repositories for PostgreSQL versions 11 , 12 , 13 and 14 . The RPM packages are also available in the official PostgreSQL (PGDG) yum repositories. Get started \u00b6 Use the installation guidelines to install and set up pg_stat_monitor . Refer to the User guide for details about available features and functions, usage examples and configuration parameters. Get engaged \u00b6 Use the contributing guide to learn how to become a contributor. Use the forum to discuss a topic with the community. Read more \u00b6 pg_stat_monitor view reference pg_stat_monitor and pg_stat_statements comparison","title":"Welcome"},{"location":"index.html#welcome","text":"The pg_stat_monitor is a Query Performance Monitoring tool for PostgreSQL. It collects performance stats and provides query performance insights in a single view. These insights allow database users to understand query origins, execution, planning statistics and details, query information, and metadata. This significantly improves observability, enabling users to debug and tune query performance.","title":"Welcome"},{"location":"index.html#how-pg_stat_monitor-works","text":"pg_stat_monitor is developed on the basis of pg_stat_statements as its more advanced replacement. While pg_stat_statements provides ever-increasing metrics, pg_stat_monitor aggregates the collected data, saving user efforts for doing it themselves. pg_stat_monitor stores statistics in configurable time-based units \u2013 buckets . Such bucket-based data collection allows focusing on statistics generated for shorter time periods and makes query timing information such as max/min/mean time more accurate.","title":"How pg_stat_monitor works?"},{"location":"index.html#features","text":"Time Interval Grouping: Instead of supplying one set of ever-increasing counts, pg_stat_monitor computes stats for a configured number of time intervals - time buckets. This allows for much better data accuracy, especially in the case of high resolution or unreliable networks. Multi-Dimensional Grouping: While pg_stat_statements groups counters by userid, dbid, queryid, pg_stat_monitor uses a more detailed group for higher precision. This allows a user to drill down into the performance of queries. Capture Actual Parameters in the Queries: pg_stat_monitor allows you to choose if you want to see queries with placeholders for parameters or actual parameter data. This simplifies debugging and analysis processes by enabling users to execute the same query. Query Plan: Each SQL is now accompanied by its actual plan that was constructed for its execution. That\u2019s a huge advantage if you want to understand why a particular query is slower than expected. Tables Access Statistics for a Statement: This allows us to easily identify all queries that accessed a given table. This set is at par with the information provided by the pg_stat_statements . Histogram: Visual representation is very helpful as it can help identify issues. With the help of the histogram function, one can now view a timing/calling data histogram in response to an SQL query. And yes, it even works in psql.","title":"Features"},{"location":"index.html#availability","text":"pg_stat_monitor supports PostgreSQL versions 11 and above. It is compatible with both PostgreSQL provided by PostgreSQL Global Development Group (PGDG) and Percona Distribution for PostgreSQL .","title":"Availability"},{"location":"index.html#supported-versions","text":"The pg_stat_monitor should work on the latest version of both Percona Distribution for PostgreSQL and PostgreSQL, but is only tested with these versions: Distribution Version Provider Percona Distribution for PostgreSQL 11 , 12 , 13 and 14 Percona PostgreSQL 11, 12, 13 and 14 PostgreSQL Global Development Group (PGDG) The RPM (for RHEL and CentOS) and the DEB (for Debian and Ubuntu) packages are available from Percona repositories for PostgreSQL versions 11 , 12 , 13 and 14 . The RPM packages are also available in the official PostgreSQL (PGDG) yum repositories.","title":"Supported  versions"},{"location":"index.html#get-started","text":"Use the installation guidelines to install and set up pg_stat_monitor . Refer to the User guide for details about available features and functions, usage examples and configuration parameters.","title":"Get started"},{"location":"index.html#get-engaged","text":"Use the contributing guide to learn how to become a contributor. Use the forum to discuss a topic with the community.","title":"Get engaged"},{"location":"index.html#read-more","text":"pg_stat_monitor view reference pg_stat_monitor and pg_stat_statements comparison","title":"Read more"},{"location":"COMPARISON.html","text":"Comparing pg_stat_monitor and pg_stat_statements \u00b6 The pg_stat_monitor extension is developed on the basis of pg_stat_statements as its more advanced replacement. Thus, pg_stat_monitor inherits the columns available in pg_stat_statements plus provides additional ones. Note that pg_stat_monitor and pg_stat_statements process statistics data differently . Because of these differences, memory blocks and WAL (Write Ahead Logs) related statistics data are displayed inconsistently when both extensions are used together. To see all available columns, run the following command from the psql terminal: postgres =# \\ d pg_stat_monitor ; The following table compares the pg_stat_monitor view with that of pg_stat_statements . Note that the column names differ depending on the PostgreSQL version you are running. Column name for PostgreSQL 13 and above Column name for PostgreSQL 11 and 12 pg_stat_monitor pg_stat_statements bucket bucket bucket_start_time bucket_start_time userid userid datname datname toplevel 1 client_ip client_ip queryid queryid planid planid query_plan query_plan top_query top_query top_queryid top_queryid query query application_name application_name relations relations cmd_type cmd_type elevel elevel sqlcode sqlcode message message plans_calls plans_calls total_plan_time min_plan_time max_plan_time mean_plan_time stddev_plan_time calls calls total_exec_time total_time min_exec_time min_time max_exec_time max_time mean_exec_time mean_time stddev_exec_time stddev_time rows_retrieved rows_retrieved shared_blks_hit shared_blks_hit shared_blks_read shared_blks_read shared_blks_dirtied shared_blks_dirtied shared_blks_written shared_blks_written local_blks_hit local_blks_hit local_blks_read local_blks_read local_blks_dirtied local_blks_dirtied local_blks_written local_blks_written temp_blks_read temp_blks_read temp_blks_written temp_blks_written blk_read_time blk_read_time blk_write_time blk_write_time resp_calls resp_calls cpu_user_time cpu_user_time cpu_sys_time cpu_sys_time wal_records wal_records wal_fpi wal_fpi wal_bytes wal_bytes state_code state_code state state To learn more about the features in pg_stat_monitor , please see the User guide . Additional reading: pg_stat_statements Available starting from PostgreSQL 14 and above \u21a9","title":"Comparing pg_stat_monitor and pg_stat_statements"},{"location":"COMPARISON.html#comparing-pg_stat_monitor-and-pg_stat_statements","text":"The pg_stat_monitor extension is developed on the basis of pg_stat_statements as its more advanced replacement. Thus, pg_stat_monitor inherits the columns available in pg_stat_statements plus provides additional ones. Note that pg_stat_monitor and pg_stat_statements process statistics data differently . Because of these differences, memory blocks and WAL (Write Ahead Logs) related statistics data are displayed inconsistently when both extensions are used together. To see all available columns, run the following command from the psql terminal: postgres =# \\ d pg_stat_monitor ; The following table compares the pg_stat_monitor view with that of pg_stat_statements . Note that the column names differ depending on the PostgreSQL version you are running. Column name for PostgreSQL 13 and above Column name for PostgreSQL 11 and 12 pg_stat_monitor pg_stat_statements bucket bucket bucket_start_time bucket_start_time userid userid datname datname toplevel 1 client_ip client_ip queryid queryid planid planid query_plan query_plan top_query top_query top_queryid top_queryid query query application_name application_name relations relations cmd_type cmd_type elevel elevel sqlcode sqlcode message message plans_calls plans_calls total_plan_time min_plan_time max_plan_time mean_plan_time stddev_plan_time calls calls total_exec_time total_time min_exec_time min_time max_exec_time max_time mean_exec_time mean_time stddev_exec_time stddev_time rows_retrieved rows_retrieved shared_blks_hit shared_blks_hit shared_blks_read shared_blks_read shared_blks_dirtied shared_blks_dirtied shared_blks_written shared_blks_written local_blks_hit local_blks_hit local_blks_read local_blks_read local_blks_dirtied local_blks_dirtied local_blks_written local_blks_written temp_blks_read temp_blks_read temp_blks_written temp_blks_written blk_read_time blk_read_time blk_write_time blk_write_time resp_calls resp_calls cpu_user_time cpu_user_time cpu_sys_time cpu_sys_time wal_records wal_records wal_fpi wal_fpi wal_bytes wal_bytes state_code state_code state state To learn more about the features in pg_stat_monitor , please see the User guide . Additional reading: pg_stat_statements Available starting from PostgreSQL 14 and above \u21a9","title":"Comparing pg_stat_monitor and pg_stat_statements"},{"location":"REFERENCE.html","text":"pg_stat_monitor view reference \u00b6 pg_stat_monitor provides a view where the statistics data is displayed. To see all available columns, run the following command from psql : postgres =# \\ d pg_stat_monitor Depending on the PostgreSQL version, some column names may differ. The following table describes the pg_stat_monitor view for PostgreSQL 14 and higher versions. Column Type Description bucket integer Data collection unit. The number shows what bucket in a chain a record belongs to bucket_start_time timestamp with time zone The start time of the bucket userid regrole An ID of the user who run a query datname name The name of a database where the query was executed toplevel bool True means that a query was executed as a top-level statement client_ip inet The IP address of a client that run the query queryid text The internal hash code serving to identify every query in a statement planid text An internally generated ID of a query plan query_plan text The sequence of steps used to execute a query. This parameter is available only when the pgsm_enable_query_plan is enabled. top_query text Shows the top query used in a statement query text The actual text of the query application_name text Shows the name of the application connected to the database relations text[] The list of tables involved in the query cmd_type integer Type of the query executed cmd_type_text text[] The description of the query executed elevel integer Shows the error level of a query (WARNING, ERROR, LOG) sqlcode integer SQL error code message text The error message plans_calls bigint The number of times the statement was planned total_plan_time double precision The total time (in ms) spent on planning the statement min_plan_time double precision Minimum time (in ms) spent on planning the statement max_plan_time double precision Maximum time (in ms) spent on planning the statement mean_plan_time double precision The mean (average) time (in ms) spent on planning the statement stddev_plan_time double precision The standard deviation of time (in ms) spent on planning the statement calls bigint The number of times a particular query was executed total_exec_time double precision The total time (in ms) spent on executing a query min_exec_time double precision The minimum time (in ms) it took to execute a query max_exec_time double precision The maximum time (in ms) it took to execute a query mean_time double precision The mean (average) time (in ms) it took to execute a query stddev_exec_time double precision The standard deviation of time (in ms) spent on executing a query rows_retrieved bigint The number of rows retrieved when executing a query shared_blks_hit bigint Shows the total number of shared memory blocks returned from the cache shared_blks_read bigint Shows the total number of shared blocks returned not from the cache shared_blks_dirtied bigint Shows the number of shared memory blocks \u201cdirtied\u201d by the query execution (i.e. a query modified at least one tuple in a block and this block must be written to a drive) shared_blks_written bigint Shows the number of shared memory blocks written simultaneously to a drive during the query execution local_blks_hit bigint The number of blocks which are considered as local by the backend and thus are used for temporary tables local_blks_read bigint Total number of local blocks read during the query execution local_blks_dirtied bigint Total number of local blocks \u201cdirtied\u201d during the query execution (i.e. a query modified at least one tuple in a block and this block must be written to a drive) local_blks_written bigint Total number of local blocks written simultaneously to a drive during the query execution temp_blks_read bigint Total number of blocks of temporary files read from a drive. Temporary files are used when there\u2019s not enough memory to execute a query temp_blks_written bigint Total number of blocks of temporary files written to a drive blk_read_time double precision Total waiting time (in ms) for reading blocks blk_write_time double precision Total waiting time (in ms) for writing blocks to a drive resp_calls text[] Call histogram cpu_user_time double precision The time (in ms) the CPU spent on running the query cpu_sys_time double precision The time (in ms) the CPU spent on executing the kernel code wal_records bigint The total number of WAL (Write Ahead Logs) generated by the query wal_fpi bigint The total number of WAL FPI (Full Page Images) generated by the query wal_bytes numeric Total number of bytes used for the WAL generated by the query state_code bigint Shows the state code of a query state text The state message","title":"`pg_stat_monitor` view reference"},{"location":"REFERENCE.html#pg_stat_monitor-view-reference","text":"pg_stat_monitor provides a view where the statistics data is displayed. To see all available columns, run the following command from psql : postgres =# \\ d pg_stat_monitor Depending on the PostgreSQL version, some column names may differ. The following table describes the pg_stat_monitor view for PostgreSQL 14 and higher versions. Column Type Description bucket integer Data collection unit. The number shows what bucket in a chain a record belongs to bucket_start_time timestamp with time zone The start time of the bucket userid regrole An ID of the user who run a query datname name The name of a database where the query was executed toplevel bool True means that a query was executed as a top-level statement client_ip inet The IP address of a client that run the query queryid text The internal hash code serving to identify every query in a statement planid text An internally generated ID of a query plan query_plan text The sequence of steps used to execute a query. This parameter is available only when the pgsm_enable_query_plan is enabled. top_query text Shows the top query used in a statement query text The actual text of the query application_name text Shows the name of the application connected to the database relations text[] The list of tables involved in the query cmd_type integer Type of the query executed cmd_type_text text[] The description of the query executed elevel integer Shows the error level of a query (WARNING, ERROR, LOG) sqlcode integer SQL error code message text The error message plans_calls bigint The number of times the statement was planned total_plan_time double precision The total time (in ms) spent on planning the statement min_plan_time double precision Minimum time (in ms) spent on planning the statement max_plan_time double precision Maximum time (in ms) spent on planning the statement mean_plan_time double precision The mean (average) time (in ms) spent on planning the statement stddev_plan_time double precision The standard deviation of time (in ms) spent on planning the statement calls bigint The number of times a particular query was executed total_exec_time double precision The total time (in ms) spent on executing a query min_exec_time double precision The minimum time (in ms) it took to execute a query max_exec_time double precision The maximum time (in ms) it took to execute a query mean_time double precision The mean (average) time (in ms) it took to execute a query stddev_exec_time double precision The standard deviation of time (in ms) spent on executing a query rows_retrieved bigint The number of rows retrieved when executing a query shared_blks_hit bigint Shows the total number of shared memory blocks returned from the cache shared_blks_read bigint Shows the total number of shared blocks returned not from the cache shared_blks_dirtied bigint Shows the number of shared memory blocks \u201cdirtied\u201d by the query execution (i.e. a query modified at least one tuple in a block and this block must be written to a drive) shared_blks_written bigint Shows the number of shared memory blocks written simultaneously to a drive during the query execution local_blks_hit bigint The number of blocks which are considered as local by the backend and thus are used for temporary tables local_blks_read bigint Total number of local blocks read during the query execution local_blks_dirtied bigint Total number of local blocks \u201cdirtied\u201d during the query execution (i.e. a query modified at least one tuple in a block and this block must be written to a drive) local_blks_written bigint Total number of local blocks written simultaneously to a drive during the query execution temp_blks_read bigint Total number of blocks of temporary files read from a drive. Temporary files are used when there\u2019s not enough memory to execute a query temp_blks_written bigint Total number of blocks of temporary files written to a drive blk_read_time double precision Total waiting time (in ms) for reading blocks blk_write_time double precision Total waiting time (in ms) for writing blocks to a drive resp_calls text[] Call histogram cpu_user_time double precision The time (in ms) the CPU spent on running the query cpu_sys_time double precision The time (in ms) the CPU spent on executing the kernel code wal_records bigint The total number of WAL (Write Ahead Logs) generated by the query wal_fpi bigint The total number of WAL FPI (Full Page Images) generated by the query wal_bytes numeric Total number of bytes used for the WAL generated by the query state_code bigint Shows the state code of a query state text The state message","title":"pg_stat_monitor view reference"},{"location":"RELEASE_NOTES.html","text":"Release Notes \u00b6 Below is the complete list of release notes for every version of pg_stat_monitor . 1.0.1 \u00b6 Bugs Fixed \u00b6 PG-382 : Histogram default settings changed to prevent the PostgreSQL server to crash PG-417 : Addressed security vulnerabilities to prevent an attacker from precreating functions DISTPG-427 : Fixed the issue with the extensions not working when pg_stat_monitor is enabled by replacing the return with goto exit for the pgsm_emit_log_hook function 1.0.0 \u00b6 Bump version from 1.0.0-rc.2 to 1.0.0. 1.0.0-rc.2 \u00b6 Improvements \u00b6 PG-331 : Changed the default value for the pg_stat_monitor.pgsm_query_max_len parameter from 1024 to 2048 for better data presentation in PMM PG-355 : Changed the collection of sys_time and user_time metrics so that they are now presented as an accumulative value PG-286 : Improved pg_stat_monitor performance by decreasing the overhead by more than 50%. PG-267 : Added test case to verify histogram feature PG-359 : Documentation: updated the pg_stat_monitor_settings view reference. PG-344 : Documentation: Updated the extensions order and behavior with data collection for PostgreSQL 14. PG-358 : Documentation: data display of ** blk ** and ** wal ** columns when both pg_stat_monitor and pg_stat_statements are loaded together. Bugs Fixed \u00b6 PG-350 : Fixed bucket time overflow PG-338 : Fixed query calls count by setting the default value for pg_stat_monitor.pgsm_track to top . PG-291 : Fixed calls count. PG-325 : Fixed deadlock that occurred when the query length exceeded the pgsm_query_max_len value. PG-326 : Added validation for pgsm_histogram_min and pgsm_histogram_max ranges PG-329 : Fixed creation of pg_stat_monitor_errors view on SQL files. PG-296 : Fixed issue with the application name not displaying in the view when changed. PG-290 : Fixed issue with PostgreSQL crashing after enabling debug log level and when pg_stat_monitor is enabled. PG-166 : Fixed issue with displaying the actual system time values instead of NULL PG-369 : Fixed issue with incorrect wal_bytes values for PostgreSQL 11 and 12 that caused Query Analytics failure in PMM by ignoring the WalUsage variable value for these versions. 1.0.0-rc.1 \u00b6 Improvements \u00b6 PG-165 : Recycle expired buckets PG-167 : Make SQL error codes readable by updating their data types PG-193 : Create a comment based tags to identify different parameters PG-199 : Documentation: Add the integration with PMM section in User Guide PG-210 : Documentation: Update column names per POstgreSQL version to match the upstream ones Bugs Fixed \u00b6 PG-177 : Fixed the error in histogram ranges PG-214 : Fixed the issue with the display of the error message as part of the query column in pg_stat_monitor view PG-246 : Fixed the issue with significant CPU and memory resource usage when pg_stat_monitor.pgsm_enable_query_plan parameter is enabled PG-262 : Fixed the way the comments are extracted in pg_stat_monitor view PG-271 : Fixed the issue with enabling the pg_stat_monitor.pgsm_overflow_target configuration parameter. PG-272 : Fixed the server crash when calling the pg_stat_monitor_reset() function by using the correct PGSM_MAX_BUCKETS GUC as the limit to the loop REL0_9_0_STABLE \u00b6 Improvements \u00b6 PG-186 : Add support to monitor query execution plan PG-147 : Store top query, instead of parent query. PG-188 : Added a new column to monitor the query state i.e PARSING/PLANNING/ACTIVE/FINISHED. PG-180 : Schema Qualified table/relations names. Regression Test Suite. Bugs Fixed \u00b6 PG-189 : Regression crash in case of PostgreSQL 11. PG-187 : Compilation Error for PostgreSQL 11 and PostgreSQL 12. PG-186 : Add support to monitor query execution plan. PG-182 : Added a new option for the query buffer overflow. PG-181 : Segmentation fault in case of track_utility is ON. Some Code refactoring. REL0_8_1 \u00b6 PG-147 : Stored Procedure Support add parentid to track caller. PG-177 : Error in Histogram ranges. REL0_8_0_STABLE \u00b6 Improvements \u00b6 Column userid (int64) was removed. Column dbid (int64) was removed. Column user (string) was added (replacement for userid). Column datname (string) was added (replacement for dbid). PG-176 : Extract fully qualified relations name. PG-175 : Only Superuser / Privileged user can view IP address. PG-174 : Code cleanup. PG-173 : Added new WAL usage statistics. PG-172 : Exponential histogram for time buckets. PG-164 : Query timing will be four decimal places instead of two. PG-167 : SQLERRCODE must be in readable format. Bugs Fixed \u00b6 PG-169 : Fixing message buffer overrun and incorrect index access to fix the server crash. PG-168 : \u201ccalls\u201d and histogram parameter does not match. PG-166 : Display actual system time instead of null. PG-165 : Recycle expired buckets. PG-150 : Error while logging CMD Type like SELECT, UPDATE, INSERT, DELETE. REL0_7_2 \u00b6 PG-165 : Recycle expired buckets. PG-164 : Query timing will be four decimal places instead of two. PG-161 : Miscellaneous small issues. REL0_7_1 \u00b6 PG-158 : Segmentation fault while using pgbench with clients > 1. PG-159 : Bucket start time (bucket_start_time) should be aligned with bucket_time. PG-160 : Integration with PGXN. REL0_7_0_STABLE \u00b6 Improvements \u00b6 PG-153 : Capture and record the application_name executing the query. PG-145 : Add a new View/Query to show the actual Database name and Username. PG-110 ; Aggregate the number of warnings. PG-109 : Log failed queries or queries with warning messages. PG-150 : Differentiate different types of queries such as SELECT, UPDATE, INSERT or DELETE. Bugs Fixed \u00b6 PG-111 Show information for incomplete buckets. PG-148 Loss of query statistics/monitoring due to not enough \u201cslots\u201d available. v0.6.0 \u00b6 Initial Release. Master \u00b6 Improvements \u00b6 PG-156 : Adding a placeholder replacement function for the prepared statement","title":"Release notes"},{"location":"RELEASE_NOTES.html#release-notes","text":"Below is the complete list of release notes for every version of pg_stat_monitor .","title":"Release Notes"},{"location":"RELEASE_NOTES.html#101","text":"","title":"1.0.1"},{"location":"RELEASE_NOTES.html#bugs-fixed","text":"PG-382 : Histogram default settings changed to prevent the PostgreSQL server to crash PG-417 : Addressed security vulnerabilities to prevent an attacker from precreating functions DISTPG-427 : Fixed the issue with the extensions not working when pg_stat_monitor is enabled by replacing the return with goto exit for the pgsm_emit_log_hook function","title":"Bugs Fixed"},{"location":"RELEASE_NOTES.html#100","text":"Bump version from 1.0.0-rc.2 to 1.0.0.","title":"1.0.0"},{"location":"RELEASE_NOTES.html#100-rc2","text":"","title":"1.0.0-rc.2"},{"location":"RELEASE_NOTES.html#improvements","text":"PG-331 : Changed the default value for the pg_stat_monitor.pgsm_query_max_len parameter from 1024 to 2048 for better data presentation in PMM PG-355 : Changed the collection of sys_time and user_time metrics so that they are now presented as an accumulative value PG-286 : Improved pg_stat_monitor performance by decreasing the overhead by more than 50%. PG-267 : Added test case to verify histogram feature PG-359 : Documentation: updated the pg_stat_monitor_settings view reference. PG-344 : Documentation: Updated the extensions order and behavior with data collection for PostgreSQL 14. PG-358 : Documentation: data display of ** blk ** and ** wal ** columns when both pg_stat_monitor and pg_stat_statements are loaded together.","title":"Improvements"},{"location":"RELEASE_NOTES.html#bugs-fixed_1","text":"PG-350 : Fixed bucket time overflow PG-338 : Fixed query calls count by setting the default value for pg_stat_monitor.pgsm_track to top . PG-291 : Fixed calls count. PG-325 : Fixed deadlock that occurred when the query length exceeded the pgsm_query_max_len value. PG-326 : Added validation for pgsm_histogram_min and pgsm_histogram_max ranges PG-329 : Fixed creation of pg_stat_monitor_errors view on SQL files. PG-296 : Fixed issue with the application name not displaying in the view when changed. PG-290 : Fixed issue with PostgreSQL crashing after enabling debug log level and when pg_stat_monitor is enabled. PG-166 : Fixed issue with displaying the actual system time values instead of NULL PG-369 : Fixed issue with incorrect wal_bytes values for PostgreSQL 11 and 12 that caused Query Analytics failure in PMM by ignoring the WalUsage variable value for these versions.","title":"Bugs Fixed"},{"location":"RELEASE_NOTES.html#100-rc1","text":"","title":"1.0.0-rc.1"},{"location":"RELEASE_NOTES.html#improvements_1","text":"PG-165 : Recycle expired buckets PG-167 : Make SQL error codes readable by updating their data types PG-193 : Create a comment based tags to identify different parameters PG-199 : Documentation: Add the integration with PMM section in User Guide PG-210 : Documentation: Update column names per POstgreSQL version to match the upstream ones","title":"Improvements"},{"location":"RELEASE_NOTES.html#bugs-fixed_2","text":"PG-177 : Fixed the error in histogram ranges PG-214 : Fixed the issue with the display of the error message as part of the query column in pg_stat_monitor view PG-246 : Fixed the issue with significant CPU and memory resource usage when pg_stat_monitor.pgsm_enable_query_plan parameter is enabled PG-262 : Fixed the way the comments are extracted in pg_stat_monitor view PG-271 : Fixed the issue with enabling the pg_stat_monitor.pgsm_overflow_target configuration parameter. PG-272 : Fixed the server crash when calling the pg_stat_monitor_reset() function by using the correct PGSM_MAX_BUCKETS GUC as the limit to the loop","title":"Bugs Fixed"},{"location":"RELEASE_NOTES.html#rel0_9_0_stable","text":"","title":"REL0_9_0_STABLE"},{"location":"RELEASE_NOTES.html#improvements_2","text":"PG-186 : Add support to monitor query execution plan PG-147 : Store top query, instead of parent query. PG-188 : Added a new column to monitor the query state i.e PARSING/PLANNING/ACTIVE/FINISHED. PG-180 : Schema Qualified table/relations names. Regression Test Suite.","title":"Improvements"},{"location":"RELEASE_NOTES.html#bugs-fixed_3","text":"PG-189 : Regression crash in case of PostgreSQL 11. PG-187 : Compilation Error for PostgreSQL 11 and PostgreSQL 12. PG-186 : Add support to monitor query execution plan. PG-182 : Added a new option for the query buffer overflow. PG-181 : Segmentation fault in case of track_utility is ON. Some Code refactoring.","title":"Bugs Fixed"},{"location":"RELEASE_NOTES.html#rel0_8_1","text":"PG-147 : Stored Procedure Support add parentid to track caller. PG-177 : Error in Histogram ranges.","title":"REL0_8_1"},{"location":"RELEASE_NOTES.html#rel0_8_0_stable","text":"","title":"REL0_8_0_STABLE"},{"location":"RELEASE_NOTES.html#improvements_3","text":"Column userid (int64) was removed. Column dbid (int64) was removed. Column user (string) was added (replacement for userid). Column datname (string) was added (replacement for dbid). PG-176 : Extract fully qualified relations name. PG-175 : Only Superuser / Privileged user can view IP address. PG-174 : Code cleanup. PG-173 : Added new WAL usage statistics. PG-172 : Exponential histogram for time buckets. PG-164 : Query timing will be four decimal places instead of two. PG-167 : SQLERRCODE must be in readable format.","title":"Improvements"},{"location":"RELEASE_NOTES.html#bugs-fixed_4","text":"PG-169 : Fixing message buffer overrun and incorrect index access to fix the server crash. PG-168 : \u201ccalls\u201d and histogram parameter does not match. PG-166 : Display actual system time instead of null. PG-165 : Recycle expired buckets. PG-150 : Error while logging CMD Type like SELECT, UPDATE, INSERT, DELETE.","title":"Bugs Fixed"},{"location":"RELEASE_NOTES.html#rel0_7_2","text":"PG-165 : Recycle expired buckets. PG-164 : Query timing will be four decimal places instead of two. PG-161 : Miscellaneous small issues.","title":"REL0_7_2"},{"location":"RELEASE_NOTES.html#rel0_7_1","text":"PG-158 : Segmentation fault while using pgbench with clients > 1. PG-159 : Bucket start time (bucket_start_time) should be aligned with bucket_time. PG-160 : Integration with PGXN.","title":"REL0_7_1"},{"location":"RELEASE_NOTES.html#rel0_7_0_stable","text":"","title":"REL0_7_0_STABLE"},{"location":"RELEASE_NOTES.html#improvements_4","text":"PG-153 : Capture and record the application_name executing the query. PG-145 : Add a new View/Query to show the actual Database name and Username. PG-110 ; Aggregate the number of warnings. PG-109 : Log failed queries or queries with warning messages. PG-150 : Differentiate different types of queries such as SELECT, UPDATE, INSERT or DELETE.","title":"Improvements"},{"location":"RELEASE_NOTES.html#bugs-fixed_5","text":"PG-111 Show information for incomplete buckets. PG-148 Loss of query statistics/monitoring due to not enough \u201cslots\u201d available.","title":"Bugs Fixed"},{"location":"RELEASE_NOTES.html#v060","text":"Initial Release.","title":"v0.6.0"},{"location":"RELEASE_NOTES.html#master","text":"","title":"Master"},{"location":"RELEASE_NOTES.html#improvements_5","text":"PG-156 : Adding a placeholder replacement function for the prepared statement","title":"Improvements"},{"location":"USER_GUIDE.html","text":"User Guide \u00b6 Introduction Features Views Functions Configuration Usage examples Introduction \u00b6 This document describes the features, functions and configuration of the pg_stat_monitor extension and gives some usage examples. For how to install and set up pg_stat_monitor , see Setting up . Features \u00b6 The following are the key features of pg_stat_monitor: Time buckets , Table and index access statistics per statement , Query statistics: Query and client information , Query timing information , Query execution plan information , Use of actual data or parameters placeholders in queries , Query type filtering , Query metadata supporting Google\u2019s Sqlcommentor , Top query tracking , Relations - showing tables involved in a query, Monitoring of queries terminated with ERROR, WARNING and LOG error levels , Integration with Percona Monitoring and Management (PMM) tool , Histograms - visual representation of query performance. Time buckets \u00b6 Instead of supplying one set of ever-increasing counts, pg_stat_monitor computes stats for a configured number of time intervals; time buckets. This allows for much better data accuracy, especially in the case of high-resolution or unreliable networks. Starting with release 1.1.0, buckets have fixed and consistent time windows. This enables external applications such as PMM to easily consume and chart the statistics data. To make this happen, the bucket start time is rounded down to the nearest bucket time size. Note, however, that if you disable / enable the pg_stat_monitor at runtime, the first bucket may not contain all the data. For example, if pg_stat_monitor is enabled at 03:58:30, a 60-second bucket start time is set to 03:58:00 and this bucket may not contain the data for queries made between 03:58:00 and 03:58:30. To learn more about the bucket start time and size, see pg_stat_monitor.pgsm_bucket_time . Table and index access statistics per statement \u00b6 pg_stat_monitor collects the information about what tables were accessed by a statement. This allows you to identify all queries which access a given table easily. Query and client information \u00b6 pg_stat_monitor provides additional metrics for detailed analysis of query performance from various perspectives, including client connection details like user name, application name, IP address to name a few relevant columns. With this information, pg_stat_monitor enables users to track a query to the originating application. More details about the application or query may be incorporated in the SQL query in a Google\u2019s Sqlcommenter format. To see how it works, refer to the usage example Query timing information \u00b6 Understanding query execution time stats helps you identify what affects query performance and take measures to optimize it. pg_stat_monitor collects the total, min, max and average (mean) time it took to execute a particular query and provides this data in separate columns. See the Query timing information example for the sample output. Query execution plan information \u00b6 Every query has a plan that was constructed for its executing. Collecting the query plan information as well as monitoring query plan timing helps you understand how you can modify the query to optimize its execution. It also helps make communication about the query clearer when discussing query performance with other DBAs and application developers. See the Query execution plan example for the sample output. Use of actual data or parameters placeholders in queries \u00b6 You can select whether to see queries with parameters placeholders or actual query data. The benefit of having the full query example is in being able to run the EXPLAIN command on it to see how its execution was planned. As a result, you can modify the query to make it run better. Query type filtering \u00b6 pg_stat_monitor monitors queries per type ( SELECT , INSERT , UPDATE or DELETE ) and classifies them accordingly in the cmd_type column. This way you can separate the queries you are interested in and focus on identifying the issues and optimizing query performance. See the Query type filtering example for the sample output. Query metadata \u00b6 Google\u2019s Sqlcommenter is a useful tool that in a way bridges that gap between ORM libraries and understanding database performance. And pg_stat_monitor supports it. So, you can now put any key-value data (like what client executed a query or if it is testing vs production query) in the comments in /* \u2026 */ syntax in your SQL statements, and the information will be parsed by pg_stat_monitor and made available in the comments column in the pg_stat_monitor view. For details on the comments\u2019 syntax, see Sqlcommenter documentation . To see how it works, see the Query metadata example. Top query tracking \u00b6 Using functions is common. While running, functions can execute queries internally. pg_stat_monitor not only keeps track of all executed queries within a function, but also marks that function as top query. Top query indicates the main query. To illustrate, for the SELECT query that is invoked within a function, the top query is calling this function. This enables you to backtrack to the originating function and thus simplifies the tracking and analysis. Find more details in the usage example . Relations \u00b6 pg_stat_monitor provides the list of tables involved in the query in the relations column. This reduces time on identifying the tables and simplifies the analysis. To learn more, see the usage examples Monitoring queries terminated with ERROR, WARNING and LOG error levels \u00b6 Monitoring queries that terminate with ERROR, WARNING, LOG states can give useful information to debug an issue. Such messages have the error level ( elevel ), error code ( sqlcode ), and error message ( message ). pg_stat_monitor collects all this information and aggregates it so that you can measure performance for successful and failed queries separately, as well as understand why a particular query failed to execute successfully. Find details in the usage example Integration with PMM \u00b6 To timely identify and react on issues, performance should be automated and alerts should be sent when an issue occurs. There are many monitoring tools available for PostgreSQL, some of them (like Nagios) supporting custom metrics provided via extensions. Though you can integrate pg_stat_monitor with these tools, it natively supports integration with Percona Management and Monitoring (PMM). This integration allows you to enjoy all the features provided by both solutions: advanced statistics data provided by pg_stat_monitor and automated monitoring with data visualization on dashboards, security threat checks and alerting, available in PMM out of the box. To learn how to integrate pg_stat_monitor with PMM, see Configure pg_stat_monitor in PMM Histogram \u00b6 Histogram (the resp_calls parameter) provides a visual representation of query performance. With the help of the histogram function, you can view a timing/calling data histogram in response to an SQL query. Learn more about using histograms from the usage example . Views \u00b6 pg_stat_monitor provides the following views: * pg_stat_monitor is the view where statistics data is presented. * pg_stat_monitor_settings view shows available configuration options which you can change. pg_stat_monitor view \u00b6 The statistics gathered by the module are made available via the view named pg_stat_monitor . This view contains one row for each distinct combination of metrics and whether it is a top-level statement or not (up to the maximum number of distinct statements that the module can track). For details about available counters, refer to the pg_stat_monitor view reference . The following are the primary keys for pg_stat_monitor: bucket userid datname queryid client_ip planid application_name toplevel . NOTE : The toplevel key is considered starting with PostgreSQL 14 and above. For PostgreSQL 13 and earlier versions, the toplevel value is set to 1 by default, and thus, ignored. A new row is created for each key in the pg_stat_monitor view. pg_stat_monitor inherits the metrics available in pg_stat_statements , plus provides additional ones. See the pg_stat_monitor vs pg_stat_statements comparison for details. For security reasons, only superusers and members of the pg_read_all_stats role are allowed to see the SQL text and queryid of queries executed by other users. Other users can see the statistics, however, if the view has been installed in their database. pg_stat_monitor_settings view \u00b6 The pg_stat_monitor_settings view shows one row per pg_stat_monitor configuration parameter. It displays configuration parameter name, value, default value, description, minimum and maximum values, and whether a restart is required for a change in value to be effective. Functions \u00b6 pg_stat_monitor_reset() \u00b6 This function resets all the statistics and clears the view. Eventually, the function will delete all the previous data. pg_stat_monitor_version() \u00b6 This function provides the build version of pg_stat_monitor version. postgres=# select pg_stat_monitor_version(); pg_stat_monitor_version ------------------------- devel (1 row) histogram(bucket id, query id) \u00b6 It is used to generate the histogram, you can refer to histogram sections. Configuration \u00b6 Use the following command to view available configuration parameters in the pg_stat_monitor_settings view: SELECT * FROM pg_stat_monitor_settings ; To amend the pg_stat_monitor configuration, use the General Configuration Unit (GCU) system. Some configuration parameters require the server restart and should be set before the server startup. These must be set in the postgresql.conf file. Other parameters do not require server restart and can be set permanently either in the postgresql.conf or from the client ( psql ) using the SET or ALTER SYSTEM SET commands. The following table shows setup options for each configuration parameter and whether the server restart is required to apply the parameter\u2019s value: Parameter Name postgresql.conf SET ALTER SYSTEM SET server restart configuration reload pg_stat_monitor.pgsm_max pg_stat_monitor.pgsm_query_max_len pg_stat_monitor.pgsm_track_utility pg_stat_monitor.pgsm_normalized_query pg_stat_monitor.pgsm_max_buckets pg_stat_monitor.pgsm_bucket_time pg_stat_monitor.pgsm_histogram_min pg_stat_monitor.pgsm_histogram_max pg_stat_monitor.pgsm_histogram_buckets pg_stat_monitor.pgsm_query_shared_buffer pg_stat_monitor.pgsm_overflow_target pg_stat_monitor.pgsm_enable_query_plan pg_stat_monitor.track pg_stat_monitor.extract_comments pg_stat_monitor.pgsm_track_planning Parameters description: \u00b6 pg_stat_monitor.pgsm_max \u00b6 Values: - Min: 1 - Max: 1000 - Default: 100 This parameter defines the limit of shared memory (in MB) for pg_stat_monitor . This memory is used by buckets in a circular manner. The memory is divided between the buckets equally, at the start of the PostgreSQL. Requires the server restart. pg_stat_monitor.pgsm_query_max_len \u00b6 Values: - Min: 1024 - Max: 2147483647 - Default: 1024 Sets the maximum size of the query. This parameter can only be set at the start of PostgreSQL. For long queries, the query is truncated to that particular length. This is to avoid unnecessary usage of shared memory. Requires the server restart. pg_stat_monitor.pgsm_track_utility \u00b6 Type: boolean. Default: 1 This parameter controls whether utility commands are tracked by the module. Utility commands are all those other than SELECT , INSERT , UPDATE , and DELETE . pg_stat_monitor.pgsm_normalized_query \u00b6 Type: boolean. Default: 1 By default, the query shows the actual parameter instead of the placeholder. It is quite useful when users want to use that query and try to run that query to check the abnormalities. But in most cases users like the queries with a placeholder. This parameter is used to toggle between the two said options. pg_stat_monitor.pgsm_max_buckets \u00b6 Values: - Min: 1 - Max: 10 - Default: 10 pg_stat_monitor accumulates the information in the form of buckets. All the aggregated information is bucket based. This parameter is used to set the number of buckets the system can have. For example, if this parameter is set to 2, then the system will create two buckets. First, the system will add all the information into the first bucket. After its lifetime (defined in the pg_stat_monitor.pgsm_bucket_time parameter) expires, it will switch to the second bucket, reset all the counters and repeat the process. Requires the server restart. pg_stat_monitor.pgsm_bucket_time \u00b6 Values: - Min: 1 - Max: 2147483647 - Default: 60 This parameter sets the lifetime of the bucket. The system switches between buckets on the basis of pg_stat_monitor.pgsm_bucket_time . Starting with release 1.1.0, the behavior of setting the bucket start time has changed. Previously, the bucket start time was aligned with the time of the first query arrived to that bucket. Now the bucket start time is rounded down to the bucket time size. To illustrate, if the first query arrives to a 60 second bucket at 03:01:15, the bucket start time is set to 03:01:00. With this new behavior, buckets have now consistent time windows so that external applications such as PMM can easily consume the data in buckets. Note that if you disable / enable the pg_stat_monitor at runtime, the first bucket may not contain all the data. Thus, if pg_stat_monitor is enabled at 03:58:30, the bucket start time is set to 03:58:00 but it will not contain the data for queries made between 03:58:00 and 03:58:30. The parameter requires the server restart. pg_stat_monitor.pgsm_histogram_min \u00b6 Values: - Min: 0 - Max: 2147483647 - Default: 0 pg_stat_monitor also stores the execution time histogram. This parameter is used to set the lower bound of the histogram (in ms). Requires the server restart. pg_stat_monitor.pgsm_histogram_max \u00b6 Values: - Min: 10 - Max: 2147483647 - Default: 100000 This parameter sets the upper bound of the execution time histogram (in ms). Requires the server restart. pg_stat_monitor.pgsm_histogram_buckets \u00b6 Values: - Min: 2 - Max: 2147483647 - Default: 10 This parameter sets the maximum number of histogram buckets. Requires the server restart. pg_stat_monitor.pgsm_query_shared_buffer \u00b6 Values: - Min: 1 - Max: 10000 - Default: 20 This parameter defines the shared memory limit (in MB) allocated for a query tracked by pg_stat_monitor . Requires the server restart. pg_stat_monitor.pgsm_overflow_target \u00b6 Type: boolean. Default: 1 Sets the overflow target for the pg_stat_monitor . Requires the server restart. pg_stat_monitor.pgsm_enable_query_plan \u00b6 Type: boolean. Default: 1 Enables or disables query plan monitoring. When the pgsm_enable_query_plan is disabled (0), the query plan will not be captured by pg_stat_monitor . Enabling it may adversely affect the database performance. Requires the server restart. pg_stat_monitor.track \u00b6 This parameter controls which statements are tracked by pg_stat_monitor . Values: top : Default, track only top level queries (those issued directly by clients) and excludes listing nested statements (those called within a function). all : Track top along with sub/nested queries. As a result, some SELECT statement may be shown as duplicates. none : Disable query monitoring. The module is still loaded and is using shared memory, etc. It only silently ignores the capturing of data. pg_stat_monitor.extract_comments \u00b6 Type: boolean. Default: 0 This parameter controls whether to enable or disable extracting comments from queries. pg_stat_monitor.pgsm_track_planning \u00b6 Type: boolean. Default: 0 This parameter instructs pg_stat_monitor to monitor query planning statistics. Requires the server restart. Usage examples \u00b6 Note that the column names differ depending on the PostgreSQL version you are using. The following usage examples are provided for PostgreSQL version 13. For versions 11 and 12, please consult the pg_stat_monitor reference . Querying buckets \u00b6 postgres =# select bucket , bucket_start_time , query , calls from pg_stat_monitor order by bucket ; - [ RECORD 1 ] -----+------------------------------------------------------------------------------------ bucket | 0 bucket_start_time | 2021 - 10 - 22 11 : 10 : 00 query | select bucket , bucket_start_time , query , calls from pg_stat_monitor order by bucket ; calls | 1 The bucket parameter shows the number of a bucket for which a given record belongs. The bucket_start_time shows the start time of the bucket. query shows the actual query text. calls shows how many times a given query was called. Query information \u00b6 Example 1: Shows the usename, database name, unique queryid hash, query, and the total number of calls of that query. postgres =# SELECT userid , datname , queryid , substr ( query , 0 , 50 ) AS query , calls FROM pg_stat_monitor ; userid | datname | queryid | query | calls ---------+----------+------------------+---------------------------------------------------+------- vagrant | postgres | 939 C2F56E1F6A174 | END | 561 vagrant | postgres | 2 A4437C4905E0E23 | SELECT abalance FROM pgbench_accounts WHERE aid = | 561 vagrant | postgres | 4 EE9ED0CDF143477 | SELECT userid , datname , queryid , substr ( query , $ 1 | 1 vagrant | postgres | 8867 FEEB8A5388AC | vacuum pgbench_branches | 1 vagrant | postgres | 41 D1168FB0733CAB | select count ( * ) from pgbench_branches | 1 vagrant | postgres | E5A889A8FF37C2B1 | UPDATE pgbench_accounts SET abalance = abalance + | 561 vagrant | postgres | 4876 BBA9A8FCFCF9 | truncate pgbench_history | 1 vagrant | postgres | 22 B76AE84689E4DC | INSERT INTO pgbench_history ( tid , bid , aid , delta | 561 vagrant | postgres | F6DA9838660825CA | vacuum pgbench_tellers | 1 vagrant | postgres | 214646 CE6F9B1A85 | BEGIN | 561 vagrant | postgres | 27462943 E814C5B5 | UPDATE pgbench_tellers SET tbalance = tbalance + | 561 vagrant | postgres | 4 F66D46F3D4151E | SELECT userid , dbid , queryid , substr ( query , 0 , 50 | 1 vagrant | postgres | 6 A02C123488B95DB | UPDATE pgbench_branches SET bbalance = bbalance + | 561 ( 13 rows ) Example 2: Shows the connected application details. postgres =# SELECT application_name , client_ip , substr ( query , 0 , 100 ) as query FROM pg_stat_monitor ; application_name | client_ip | query ------------------+-----------+----------------------------------------------------------------------------------------------------- pgbench | 127 . 0 . 0 . 1 | truncate pgbench_history pgbench | 127 . 0 . 0 . 1 | SELECT abalance FROM pgbench_accounts WHERE aid = $ 1 pgbench | 127 . 0 . 0 . 1 | UPDATE pgbench_accounts SET abalance = abalance + $ 1 WHERE aid = $ 2 pgbench | 127 . 0 . 0 . 1 | BEGIN ; pgbench | 127 . 0 . 0 . 1 | INSERT INTO pgbench_history ( tid , bid , aid , delta , mtime ) VALUES ( $ 1 , $ 2 , $ 3 , $ 4 , CURRENT_TIMESTAMP pgbench | 127 . 0 . 0 . 1 | END ; pgbench | 127 . 0 . 0 . 1 | vacuum pgbench_branches pgbench | 127 . 0 . 0 . 1 | UPDATE pgbench_tellers SET tbalance = tbalance + $ 1 WHERE tid = $ 2 pgbench | 127 . 0 . 0 . 1 | vacuum pgbench_tellers pgbench | 127 . 0 . 0 . 1 | UPDATE pgbench_branches SET bbalance = bbalance + $ 1 WHERE bid = $ 2 pgbench | 127 . 0 . 0 . 1 | select o . n , p . partstrat , pg_catalog . count ( i . inhparent ) from pg_catalog . pg_class as c join pg_catalo psql | 127 . 0 . 0 . 1 | SELECT application_name , client_ip , substr ( query , $ 1 , $ 2 ) as query FROM pg_stat_monitor pgbench | 127 . 0 . 0 . 1 | select count ( * ) from pgbench_branches ( 13 rows ) Query timing information \u00b6 SELECT userid , total_time , min_time , max_time , mean_time , query FROM pg_stat_monitor ; userid | total_time | min_time | max_time | mean_time | query --------+--------------------+--------------------+--------------------+--------------------+------------------------------------------------------------------ 10 | 0 . 14 | 0 . 14 | 0 . 14 | 0 . 14 | select * from pg_stat_monitor_reset () 10 | 0 . 19 | 0 . 19 | 0 . 19 | 0 . 19 | select userid , dbid , queryid , query from pg_stat_monitor 10 | 0 . 30 | 0 . 13 | 0 . 16 | 0 . 15 | select bucket , bucket_start_time , query from pg_stat_monitor 10 | 0 . 29 | 0 . 29 | 0 . 29 | 0 . 29 | select userid , dbid , queryid , query , calls from pg_stat_monitor 10 | 11277 . 79 | 11277 . 79 | 11277 . 79 | Query execution plan \u00b6 postgres =# SELECT substr ( query , 0 , 50 ), query_plan from pg_stat_monitor limit 10 ; substr | query_plan ---------------------------------------------------+--------------------------------------------------------------------------------------------------------------- select o . n , p . partstrat , pg_catalog . count ( i . inhpa | Limit + | -> GroupAggregate + | Group Key : ( array_position ( current_schemas ( true ), n . nspname )), p . partstrat + | -> Sort + | Sort Key : ( array_position ( current_schemas ( true ), n . nspname )), p . partstrat + | -> Nested Loop Left Join + | -> Nested Loop Left Join + | -> Nested Loop + | Join Filter : ( c . relnamespace = n . oid ) + | -> Index Scan using pg_class_relname_nsp_index on pg_class c + | Index Cond : ( relname = 'pgbench_accounts' :: name ) + | -> Seq Scan on pg_namespace n + | Filter : ( array_position ( current_schemas ( true ), nspname ) IS NOT NULL ) + | -> Index Scan using pg_partitioned_table_partrelid_index on pg_partitioned_table p + | Index Cond : ( partrelid = c . oid ) + | -> Bitmap Heap Scan on pg_inherits i + | R SELECT abalance FROM pgbench_accounts WHERE aid = | Index Scan using pgbench_accounts_pkey on pgbench_accounts + | Index Cond : ( aid = 102232 ) BEGIN ; | END ; | SELECT substr ( query , $ 1 , $ 2 ), query_plan from pg_st | SELECT substr ( query , $ 1 , $ 2 ), calls , planid , query_pl | Limit + | -> Subquery Scan on pg_stat_monitor + | -> Result + | -> Sort + | Sort Key : p . bucket_start_time + | -> Hash Join + | Hash Cond : ( p . dbid = d . oid ) + | -> Function Scan on pg_stat_monitor_internal p + | -> Hash + | -> Seq Scan on pg_database d + | SubPlan 1 + | -> Function Scan on pg_stat_monitor_internal s + | Filter : ( queryid = p . top_queryid ) select count ( * ) from pgbench_branches | Aggregate + | -> Seq Scan on pgbench_branches UPDATE pgbench_tellers SET tbalance = tbalance + | vacuum pgbench_tellers | UPDATE pgbench_accounts SET abalance = abalance + | ( 10 rows ) The plan column does not contain costing, width and other values. This is an expected behavior as each row is an accumulation of statistics based on plan and amongst other key columns. Plan is only available when the pgsm_enable_query_plan configuration parameter is enabled. Query type filtering \u00b6 pg_stat_monitor monitors queries per type (SELECT, INSERT, UPDATE OR DELETE) and classifies them accordingly in the cmd_type column thus reducing your efforts. postgres =# SELECT bucket , substr ( query , 0 , 50 ) AS query , cmd_type FROM pg_stat_monitor WHERE elevel = 0 ; bucket | query | cmd_type --------+---------------------------------------------------+---------- 4 | END | 4 | SELECT abalance FROM pgbench_accounts WHERE aid = | SELECT 4 | vacuum pgbench_branches | 4 | select count ( * ) from pgbench_branches | SELECT 4 | UPDATE pgbench_accounts SET abalance = abalance + | UPDATE 4 | truncate pgbench_history | 4 | INSERT INTO pgbench_history ( tid , bid , aid , delta | INSERT 5 | SELECT relations query FROM pg_stat_monitor | SELECT 9 | SELECT bucket , substr ( query , $ 1 , $ 2 ) AS query , cmd | 4 | vacuum pgbench_tellers | 4 | BEGIN | 5 | SELECT relations , query FROM pg_stat_monitor | SELECT 4 | UPDATE pgbench_tellers SET tbalance = tbalance + | UPDATE 4 | UPDATE pgbench_branches SET bbalance = bbalance + | UPDATE ( 14 rows ) Query metadata \u00b6 The comments column contains any text wrapped in \u201c/*\u201d and \u201c*/\u201d comment tags. The pg_stat_monitor extension picks up these comments and makes them available in the comments column. Please note that only the latest comment value is preserved per row. The comments may be put in any format that can be parsed by a tool. CREATE EXTENSION hstore ; CREATE FUNCTION text_to_hstore ( s text ) RETURNS hstore AS $$ BEGIN RETURN hstore ( s :: text []); EXCEPTION WHEN OTHERS THEN RETURN NULL ; END ; $$ LANGUAGE plpgsql STRICT ; postgres =# SELECT 1 AS num /* { \"application\", java_app, \"real_ip\", 192.168.1.1} */ ; num ----- 1 ( 1 row ) postgres =# SELECT 1 AS num1 , 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ ; num1 | num2 ------+------ 1 | 2 ( 1 row ) postgres =# SELECT 1 AS num1 , 2 AS num2 , 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ ; num1 | num2 | num3 ------+------+------ 1 | 2 | 3 ( 1 row ) postgres =# SELECT 1 AS num1 , 2 AS num2 , 3 AS num3 , 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ ; num1 | num2 | num3 | num4 ------+------+------+------ 1 | 2 | 3 | 4 ( 1 row ) postgres =# select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; query | comments_tags ---------------------------------------------------------------------------------------------------------------+----------------------------------------------------- SELECT $ 1 AS num /* { \"application\", psql_app, \"real_ip\", 192.168.1.3) */ | \"real_ip\" => \"192.168.1.1\" , \"application\" => \"java_app\" SELECT pg_stat_monitor_reset (); | select query , comments , text_to_hstore ( comments ) from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ | \"real_ip\" => \"192.168.1.3\" , \"application\" => \"java_app\" select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ | \"real_ip\" => \"192.168.1.2\" , \"application\" => \"java_app\" SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 , $ 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ | \"real_ip\" => \"192.168.1.3\" , \"application\" => \"psql_app\" ( 7 rows ) postgres =# select query , text_to_hstore ( comments ) -> 'application' as application_name from pg_stat_monitor ; query | application_name ---------------------------------------------------------------------------------------------------------------+---------- SELECT $ 1 AS num /* { \"application\", psql_app, \"real_ip\", 192.168.1.3) */ | java_app SELECT pg_stat_monitor_reset (); | select query , text_to_hstore ( comments ) -> \"real_ip\" as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> $ 1 from pg_stat_monitor | select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> \"application\" as comments_tags from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ | java_app SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ | java_app select query , comments , text_to_hstore ( comments ) from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 , $ 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ | psql_app ( 10 rows ) postgres =# select query , text_to_hstore ( comments ) -> 'real_ip' as real_ip from pg_stat_monitor ; query | real_ip ---------------------------------------------------------------------------------------------------------------+------------- SELECT $ 1 AS num /* { \"application\", psql_app, \"real_ip\", 192.168.1.3) */ | 192 . 168 . 1 . 1 SELECT pg_stat_monitor_reset (); | select query , text_to_hstore ( comments ) -> \"real_ip\" as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> $ 1 from pg_stat_monitor | select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> \"application\" as comments_tags from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ | 192 . 168 . 1 . 2 SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ | 192 . 168 . 1 . 3 select query , comments , text_to_hstore ( comments ) from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 , $ 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ | 192 . 168 . 1 . 3 ( 10 rows ) Top query tracking \u00b6 In the following example we create a function add2 that adds one parameter value to another one and call this function to calculate 1+2. CREATE OR REPLACE function add2 ( int , int ) RETURNS int as $$ BEGIN return ( select $ 1 + $ 2 ); END ; $$ language plpgsql ; SELECT add2 ( 1 , 2 ); add2 ----- 3 ( 1 row ) The `` pg_stat_monitor `` view shows all executed queries and shows the very first query in a row - calling the ` add2 ` function . postgres =# SELECT queryid , top_queryid , query , top_query FROM pg_stat_monitor ; queryid | top_queryid | query . | top_query ------------------+------------------+-------------------------------------------------------------------------+------------------- 3408 CA84B2353094 | | select add2 ( $ 1 , $ 2 ) | 762 B99349F6C7F31 | 3408 CA84B2353094 | SELECT ( select $ 1 + $ 2 ) | select add2 ( $ 1 , $ 2 ) ( 2 rows ) Relations \u00b6 Example 1: List all the table names involved in the query. postgres =# SELECT relations , query FROM pg_stat_monitor ; relations | query -------------------------------+------------------------------------------------------------------------------------------------------ | END { public . pgbench_accounts } | SELECT abalance FROM pgbench_accounts WHERE aid = $ 1 | vacuum pgbench_branches { public . pgbench_branches } | select count ( * ) from pgbench_branches { public . pgbench_accounts } | UPDATE pgbench_accounts SET abalance = abalance + $ 1 WHERE aid = $ 2 | truncate pgbench_history { public . pgbench_history } | INSERT INTO pgbench_history ( tid , bid , aid , delta , mtime ) VALUES ( $ 1 , $ 2 , $ 3 , $ 4 , CURRENT_TIMESTAMP ) { public . pg_stat_monitor , pg_catalog . pg_database } | SELECT relations query FROM pg_stat_monitor | vacuum pgbench_tellers | BEGIN { public . pgbench_tellers } | UPDATE pgbench_tellers SET tbalance = tbalance + $ 1 WHERE tid = $ 2 { public . pgbench_branches } | UPDATE pgbench_branches SET bbalance = bbalance + $ 1 WHERE bid = $ 2 ( 12 rows ) Example 2: List all the views and the name of the table in the view. Here we have a view \u201ctest_view\u201d \\ d + test_view View \"public.test_view\" Column | Type | Collation | Nullable | Default | Storage | Description --------+---------+-----------+----------+---------+---------+------------- foo_a | integer | | | | plain | bar_a | integer | | | | plain | View definition : SELECT f . a AS foo_a , b . a AS bar_a FROM foo f , bar b ; Now when we query the pg_stat_monitor , it will show the view name and also all the table names in the view. Note that the view name is followed by an asterisk (*). SELECT relations , query FROM pg_stat_monitor ; relations | query ---------------------+---------------------------------------------------- { test_view * , foo , bar } | select * from test_view { foo , bar } | select * from foo , bar ( 2 rows ) Queries terminated with errors \u00b6 SELECT substr ( query , 0 , 50 ) AS query , decode_error_level ( elevel ) AS elevel , sqlcode , calls , substr ( message , 0 , 50 ) message FROM pg_stat_monitor ; query | elevel | sqlcode | calls | message ---------------------------------------------------+--------+---------+-------+--------------------------------------------------- select substr ( query , $ 1 , $ 2 ) as query , decode_error | | 0 | 1 | select bucket , substr ( query , $ 1 , $ 2 ), decode_error_le | | 0 | 3 | | LOG | 0 | 1 | database system is ready to accept connections select 1 / 0 ; | ERROR | 130 | 1 | division by zero | LOG | 0 | 1 | database system was shut down at 2020 - 11 - 11 11 : 37 select $ 1 / $ 2 | | 0 | 1 | ( 6 rows ) 11277 . 79 | SELECT * FROM foo Histogram \u00b6 Histogram (the resp_calls parameter) provides a visual representation of query performance. With the help of the histogram function, you can view a timing/calling data histogram in response to a SQL query. SELECT resp_calls , query FROM pg_stat_monitor ; resp_calls | query --------------------------------------------------+---------------------------------------------- { 1 , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" } | select client_ip , query from pg_stat_monitor { 3 , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 1\" } | select * from pg_stat_monitor_reset () { 3 , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 1\" } | SELECT * FROM foo postgres =# SELECT * FROM histogram ( 0 , 'F44CD1B4B33A47AF' ) AS a ( range TEXT , freq INT , bar TEXT ); range | freq | bar --------------------+------+-------------------------------- ( 0 - 3 ) } | 2 | \u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0 ( 3 - 10 ) } | 0 | ( 10 - 31 ) } | 1 | \u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0 ( 31 - 100 ) } | 0 | ( 100 - 316 ) } | 0 | ( 316 - 1000 ) } | 0 | ( 1000 - 3162 ) } | 0 | ( 3162 - 10000 ) } | 0 | ( 10000 - 31622 ) } | 0 | ( 31622 - 100000 ) } | 0 | ( 10 rows ) There are 10 time based buckets of the time generated automatically based on total buckets in the field resp_calls . The value in the field shows how many queries run in that period of time.","title":"User guide"},{"location":"USER_GUIDE.html#user-guide","text":"Introduction Features Views Functions Configuration Usage examples","title":"User Guide"},{"location":"USER_GUIDE.html#introduction","text":"This document describes the features, functions and configuration of the pg_stat_monitor extension and gives some usage examples. For how to install and set up pg_stat_monitor , see Setting up .","title":"Introduction"},{"location":"USER_GUIDE.html#features","text":"The following are the key features of pg_stat_monitor: Time buckets , Table and index access statistics per statement , Query statistics: Query and client information , Query timing information , Query execution plan information , Use of actual data or parameters placeholders in queries , Query type filtering , Query metadata supporting Google\u2019s Sqlcommentor , Top query tracking , Relations - showing tables involved in a query, Monitoring of queries terminated with ERROR, WARNING and LOG error levels , Integration with Percona Monitoring and Management (PMM) tool , Histograms - visual representation of query performance.","title":"Features"},{"location":"USER_GUIDE.html#time-buckets","text":"Instead of supplying one set of ever-increasing counts, pg_stat_monitor computes stats for a configured number of time intervals; time buckets. This allows for much better data accuracy, especially in the case of high-resolution or unreliable networks. Starting with release 1.1.0, buckets have fixed and consistent time windows. This enables external applications such as PMM to easily consume and chart the statistics data. To make this happen, the bucket start time is rounded down to the nearest bucket time size. Note, however, that if you disable / enable the pg_stat_monitor at runtime, the first bucket may not contain all the data. For example, if pg_stat_monitor is enabled at 03:58:30, a 60-second bucket start time is set to 03:58:00 and this bucket may not contain the data for queries made between 03:58:00 and 03:58:30. To learn more about the bucket start time and size, see pg_stat_monitor.pgsm_bucket_time .","title":"Time buckets"},{"location":"USER_GUIDE.html#table-and-index-access-statistics-per-statement","text":"pg_stat_monitor collects the information about what tables were accessed by a statement. This allows you to identify all queries which access a given table easily.","title":"Table and index access statistics per statement"},{"location":"USER_GUIDE.html#query-and-client-information","text":"pg_stat_monitor provides additional metrics for detailed analysis of query performance from various perspectives, including client connection details like user name, application name, IP address to name a few relevant columns. With this information, pg_stat_monitor enables users to track a query to the originating application. More details about the application or query may be incorporated in the SQL query in a Google\u2019s Sqlcommenter format. To see how it works, refer to the usage example","title":"Query and client information"},{"location":"USER_GUIDE.html#query-timing-information","text":"Understanding query execution time stats helps you identify what affects query performance and take measures to optimize it. pg_stat_monitor collects the total, min, max and average (mean) time it took to execute a particular query and provides this data in separate columns. See the Query timing information example for the sample output.","title":"Query timing information"},{"location":"USER_GUIDE.html#query-execution-plan-information","text":"Every query has a plan that was constructed for its executing. Collecting the query plan information as well as monitoring query plan timing helps you understand how you can modify the query to optimize its execution. It also helps make communication about the query clearer when discussing query performance with other DBAs and application developers. See the Query execution plan example for the sample output.","title":"Query execution plan information"},{"location":"USER_GUIDE.html#use-of-actual-data-or-parameters-placeholders-in-queries","text":"You can select whether to see queries with parameters placeholders or actual query data. The benefit of having the full query example is in being able to run the EXPLAIN command on it to see how its execution was planned. As a result, you can modify the query to make it run better.","title":"Use of actual data or parameters placeholders in queries"},{"location":"USER_GUIDE.html#query-type-filtering","text":"pg_stat_monitor monitors queries per type ( SELECT , INSERT , UPDATE or DELETE ) and classifies them accordingly in the cmd_type column. This way you can separate the queries you are interested in and focus on identifying the issues and optimizing query performance. See the Query type filtering example for the sample output.","title":"Query type filtering"},{"location":"USER_GUIDE.html#query-metadata","text":"Google\u2019s Sqlcommenter is a useful tool that in a way bridges that gap between ORM libraries and understanding database performance. And pg_stat_monitor supports it. So, you can now put any key-value data (like what client executed a query or if it is testing vs production query) in the comments in /* \u2026 */ syntax in your SQL statements, and the information will be parsed by pg_stat_monitor and made available in the comments column in the pg_stat_monitor view. For details on the comments\u2019 syntax, see Sqlcommenter documentation . To see how it works, see the Query metadata example.","title":"Query metadata"},{"location":"USER_GUIDE.html#top-query-tracking","text":"Using functions is common. While running, functions can execute queries internally. pg_stat_monitor not only keeps track of all executed queries within a function, but also marks that function as top query. Top query indicates the main query. To illustrate, for the SELECT query that is invoked within a function, the top query is calling this function. This enables you to backtrack to the originating function and thus simplifies the tracking and analysis. Find more details in the usage example .","title":"Top query tracking"},{"location":"USER_GUIDE.html#relations","text":"pg_stat_monitor provides the list of tables involved in the query in the relations column. This reduces time on identifying the tables and simplifies the analysis. To learn more, see the usage examples","title":"Relations"},{"location":"USER_GUIDE.html#monitoring-queries-terminated-with-error-warning-and-log-error-levels","text":"Monitoring queries that terminate with ERROR, WARNING, LOG states can give useful information to debug an issue. Such messages have the error level ( elevel ), error code ( sqlcode ), and error message ( message ). pg_stat_monitor collects all this information and aggregates it so that you can measure performance for successful and failed queries separately, as well as understand why a particular query failed to execute successfully. Find details in the usage example","title":"Monitoring queries terminated with ERROR, WARNING and LOG error levels"},{"location":"USER_GUIDE.html#integration-with-pmm","text":"To timely identify and react on issues, performance should be automated and alerts should be sent when an issue occurs. There are many monitoring tools available for PostgreSQL, some of them (like Nagios) supporting custom metrics provided via extensions. Though you can integrate pg_stat_monitor with these tools, it natively supports integration with Percona Management and Monitoring (PMM). This integration allows you to enjoy all the features provided by both solutions: advanced statistics data provided by pg_stat_monitor and automated monitoring with data visualization on dashboards, security threat checks and alerting, available in PMM out of the box. To learn how to integrate pg_stat_monitor with PMM, see Configure pg_stat_monitor in PMM","title":"Integration with PMM"},{"location":"USER_GUIDE.html#histogram","text":"Histogram (the resp_calls parameter) provides a visual representation of query performance. With the help of the histogram function, you can view a timing/calling data histogram in response to an SQL query. Learn more about using histograms from the usage example .","title":"Histogram"},{"location":"USER_GUIDE.html#views","text":"pg_stat_monitor provides the following views: * pg_stat_monitor is the view where statistics data is presented. * pg_stat_monitor_settings view shows available configuration options which you can change.","title":"Views"},{"location":"USER_GUIDE.html#pg_stat_monitor-view","text":"The statistics gathered by the module are made available via the view named pg_stat_monitor . This view contains one row for each distinct combination of metrics and whether it is a top-level statement or not (up to the maximum number of distinct statements that the module can track). For details about available counters, refer to the pg_stat_monitor view reference . The following are the primary keys for pg_stat_monitor: bucket userid datname queryid client_ip planid application_name toplevel . NOTE : The toplevel key is considered starting with PostgreSQL 14 and above. For PostgreSQL 13 and earlier versions, the toplevel value is set to 1 by default, and thus, ignored. A new row is created for each key in the pg_stat_monitor view. pg_stat_monitor inherits the metrics available in pg_stat_statements , plus provides additional ones. See the pg_stat_monitor vs pg_stat_statements comparison for details. For security reasons, only superusers and members of the pg_read_all_stats role are allowed to see the SQL text and queryid of queries executed by other users. Other users can see the statistics, however, if the view has been installed in their database.","title":"pg_stat_monitor view"},{"location":"USER_GUIDE.html#pg_stat_monitor_settings-view","text":"The pg_stat_monitor_settings view shows one row per pg_stat_monitor configuration parameter. It displays configuration parameter name, value, default value, description, minimum and maximum values, and whether a restart is required for a change in value to be effective.","title":"pg_stat_monitor_settings view"},{"location":"USER_GUIDE.html#functions","text":"","title":"Functions"},{"location":"USER_GUIDE.html#pg_stat_monitor_reset","text":"This function resets all the statistics and clears the view. Eventually, the function will delete all the previous data.","title":"pg_stat_monitor_reset()"},{"location":"USER_GUIDE.html#pg_stat_monitor_version","text":"This function provides the build version of pg_stat_monitor version. postgres=# select pg_stat_monitor_version(); pg_stat_monitor_version ------------------------- devel (1 row)","title":"pg_stat_monitor_version()"},{"location":"USER_GUIDE.html#histogrambucket-id-query-id","text":"It is used to generate the histogram, you can refer to histogram sections.","title":"histogram(bucket id, query id)"},{"location":"USER_GUIDE.html#configuration","text":"Use the following command to view available configuration parameters in the pg_stat_monitor_settings view: SELECT * FROM pg_stat_monitor_settings ; To amend the pg_stat_monitor configuration, use the General Configuration Unit (GCU) system. Some configuration parameters require the server restart and should be set before the server startup. These must be set in the postgresql.conf file. Other parameters do not require server restart and can be set permanently either in the postgresql.conf or from the client ( psql ) using the SET or ALTER SYSTEM SET commands. The following table shows setup options for each configuration parameter and whether the server restart is required to apply the parameter\u2019s value: Parameter Name postgresql.conf SET ALTER SYSTEM SET server restart configuration reload pg_stat_monitor.pgsm_max pg_stat_monitor.pgsm_query_max_len pg_stat_monitor.pgsm_track_utility pg_stat_monitor.pgsm_normalized_query pg_stat_monitor.pgsm_max_buckets pg_stat_monitor.pgsm_bucket_time pg_stat_monitor.pgsm_histogram_min pg_stat_monitor.pgsm_histogram_max pg_stat_monitor.pgsm_histogram_buckets pg_stat_monitor.pgsm_query_shared_buffer pg_stat_monitor.pgsm_overflow_target pg_stat_monitor.pgsm_enable_query_plan pg_stat_monitor.track pg_stat_monitor.extract_comments pg_stat_monitor.pgsm_track_planning","title":"Configuration"},{"location":"USER_GUIDE.html#parameters-description","text":"","title":"Parameters description:"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_max","text":"Values: - Min: 1 - Max: 1000 - Default: 100 This parameter defines the limit of shared memory (in MB) for pg_stat_monitor . This memory is used by buckets in a circular manner. The memory is divided between the buckets equally, at the start of the PostgreSQL. Requires the server restart.","title":"pg_stat_monitor.pgsm_max"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_query_max_len","text":"Values: - Min: 1024 - Max: 2147483647 - Default: 1024 Sets the maximum size of the query. This parameter can only be set at the start of PostgreSQL. For long queries, the query is truncated to that particular length. This is to avoid unnecessary usage of shared memory. Requires the server restart.","title":"pg_stat_monitor.pgsm_query_max_len"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_track_utility","text":"Type: boolean. Default: 1 This parameter controls whether utility commands are tracked by the module. Utility commands are all those other than SELECT , INSERT , UPDATE , and DELETE .","title":"pg_stat_monitor.pgsm_track_utility"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_normalized_query","text":"Type: boolean. Default: 1 By default, the query shows the actual parameter instead of the placeholder. It is quite useful when users want to use that query and try to run that query to check the abnormalities. But in most cases users like the queries with a placeholder. This parameter is used to toggle between the two said options.","title":"pg_stat_monitor.pgsm_normalized_query"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_max_buckets","text":"Values: - Min: 1 - Max: 10 - Default: 10 pg_stat_monitor accumulates the information in the form of buckets. All the aggregated information is bucket based. This parameter is used to set the number of buckets the system can have. For example, if this parameter is set to 2, then the system will create two buckets. First, the system will add all the information into the first bucket. After its lifetime (defined in the pg_stat_monitor.pgsm_bucket_time parameter) expires, it will switch to the second bucket, reset all the counters and repeat the process. Requires the server restart.","title":"pg_stat_monitor.pgsm_max_buckets"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_bucket_time","text":"Values: - Min: 1 - Max: 2147483647 - Default: 60 This parameter sets the lifetime of the bucket. The system switches between buckets on the basis of pg_stat_monitor.pgsm_bucket_time . Starting with release 1.1.0, the behavior of setting the bucket start time has changed. Previously, the bucket start time was aligned with the time of the first query arrived to that bucket. Now the bucket start time is rounded down to the bucket time size. To illustrate, if the first query arrives to a 60 second bucket at 03:01:15, the bucket start time is set to 03:01:00. With this new behavior, buckets have now consistent time windows so that external applications such as PMM can easily consume the data in buckets. Note that if you disable / enable the pg_stat_monitor at runtime, the first bucket may not contain all the data. Thus, if pg_stat_monitor is enabled at 03:58:30, the bucket start time is set to 03:58:00 but it will not contain the data for queries made between 03:58:00 and 03:58:30. The parameter requires the server restart.","title":"pg_stat_monitor.pgsm_bucket_time"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_histogram_min","text":"Values: - Min: 0 - Max: 2147483647 - Default: 0 pg_stat_monitor also stores the execution time histogram. This parameter is used to set the lower bound of the histogram (in ms). Requires the server restart.","title":"pg_stat_monitor.pgsm_histogram_min"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_histogram_max","text":"Values: - Min: 10 - Max: 2147483647 - Default: 100000 This parameter sets the upper bound of the execution time histogram (in ms). Requires the server restart.","title":"pg_stat_monitor.pgsm_histogram_max"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_histogram_buckets","text":"Values: - Min: 2 - Max: 2147483647 - Default: 10 This parameter sets the maximum number of histogram buckets. Requires the server restart.","title":"pg_stat_monitor.pgsm_histogram_buckets"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_query_shared_buffer","text":"Values: - Min: 1 - Max: 10000 - Default: 20 This parameter defines the shared memory limit (in MB) allocated for a query tracked by pg_stat_monitor . Requires the server restart.","title":"pg_stat_monitor.pgsm_query_shared_buffer"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_overflow_target","text":"Type: boolean. Default: 1 Sets the overflow target for the pg_stat_monitor . Requires the server restart.","title":"pg_stat_monitor.pgsm_overflow_target"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_enable_query_plan","text":"Type: boolean. Default: 1 Enables or disables query plan monitoring. When the pgsm_enable_query_plan is disabled (0), the query plan will not be captured by pg_stat_monitor . Enabling it may adversely affect the database performance. Requires the server restart.","title":"pg_stat_monitor.pgsm_enable_query_plan"},{"location":"USER_GUIDE.html#pg_stat_monitortrack","text":"This parameter controls which statements are tracked by pg_stat_monitor . Values: top : Default, track only top level queries (those issued directly by clients) and excludes listing nested statements (those called within a function). all : Track top along with sub/nested queries. As a result, some SELECT statement may be shown as duplicates. none : Disable query monitoring. The module is still loaded and is using shared memory, etc. It only silently ignores the capturing of data.","title":"pg_stat_monitor.track"},{"location":"USER_GUIDE.html#pg_stat_monitorextract_comments","text":"Type: boolean. Default: 0 This parameter controls whether to enable or disable extracting comments from queries.","title":"pg_stat_monitor.extract_comments"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_track_planning","text":"Type: boolean. Default: 0 This parameter instructs pg_stat_monitor to monitor query planning statistics. Requires the server restart.","title":"pg_stat_monitor.pgsm_track_planning"},{"location":"USER_GUIDE.html#usage-examples","text":"Note that the column names differ depending on the PostgreSQL version you are using. The following usage examples are provided for PostgreSQL version 13. For versions 11 and 12, please consult the pg_stat_monitor reference .","title":"Usage examples"},{"location":"USER_GUIDE.html#querying-buckets","text":"postgres =# select bucket , bucket_start_time , query , calls from pg_stat_monitor order by bucket ; - [ RECORD 1 ] -----+------------------------------------------------------------------------------------ bucket | 0 bucket_start_time | 2021 - 10 - 22 11 : 10 : 00 query | select bucket , bucket_start_time , query , calls from pg_stat_monitor order by bucket ; calls | 1 The bucket parameter shows the number of a bucket for which a given record belongs. The bucket_start_time shows the start time of the bucket. query shows the actual query text. calls shows how many times a given query was called.","title":"Querying buckets"},{"location":"USER_GUIDE.html#query-information","text":"Example 1: Shows the usename, database name, unique queryid hash, query, and the total number of calls of that query. postgres =# SELECT userid , datname , queryid , substr ( query , 0 , 50 ) AS query , calls FROM pg_stat_monitor ; userid | datname | queryid | query | calls ---------+----------+------------------+---------------------------------------------------+------- vagrant | postgres | 939 C2F56E1F6A174 | END | 561 vagrant | postgres | 2 A4437C4905E0E23 | SELECT abalance FROM pgbench_accounts WHERE aid = | 561 vagrant | postgres | 4 EE9ED0CDF143477 | SELECT userid , datname , queryid , substr ( query , $ 1 | 1 vagrant | postgres | 8867 FEEB8A5388AC | vacuum pgbench_branches | 1 vagrant | postgres | 41 D1168FB0733CAB | select count ( * ) from pgbench_branches | 1 vagrant | postgres | E5A889A8FF37C2B1 | UPDATE pgbench_accounts SET abalance = abalance + | 561 vagrant | postgres | 4876 BBA9A8FCFCF9 | truncate pgbench_history | 1 vagrant | postgres | 22 B76AE84689E4DC | INSERT INTO pgbench_history ( tid , bid , aid , delta | 561 vagrant | postgres | F6DA9838660825CA | vacuum pgbench_tellers | 1 vagrant | postgres | 214646 CE6F9B1A85 | BEGIN | 561 vagrant | postgres | 27462943 E814C5B5 | UPDATE pgbench_tellers SET tbalance = tbalance + | 561 vagrant | postgres | 4 F66D46F3D4151E | SELECT userid , dbid , queryid , substr ( query , 0 , 50 | 1 vagrant | postgres | 6 A02C123488B95DB | UPDATE pgbench_branches SET bbalance = bbalance + | 561 ( 13 rows ) Example 2: Shows the connected application details. postgres =# SELECT application_name , client_ip , substr ( query , 0 , 100 ) as query FROM pg_stat_monitor ; application_name | client_ip | query ------------------+-----------+----------------------------------------------------------------------------------------------------- pgbench | 127 . 0 . 0 . 1 | truncate pgbench_history pgbench | 127 . 0 . 0 . 1 | SELECT abalance FROM pgbench_accounts WHERE aid = $ 1 pgbench | 127 . 0 . 0 . 1 | UPDATE pgbench_accounts SET abalance = abalance + $ 1 WHERE aid = $ 2 pgbench | 127 . 0 . 0 . 1 | BEGIN ; pgbench | 127 . 0 . 0 . 1 | INSERT INTO pgbench_history ( tid , bid , aid , delta , mtime ) VALUES ( $ 1 , $ 2 , $ 3 , $ 4 , CURRENT_TIMESTAMP pgbench | 127 . 0 . 0 . 1 | END ; pgbench | 127 . 0 . 0 . 1 | vacuum pgbench_branches pgbench | 127 . 0 . 0 . 1 | UPDATE pgbench_tellers SET tbalance = tbalance + $ 1 WHERE tid = $ 2 pgbench | 127 . 0 . 0 . 1 | vacuum pgbench_tellers pgbench | 127 . 0 . 0 . 1 | UPDATE pgbench_branches SET bbalance = bbalance + $ 1 WHERE bid = $ 2 pgbench | 127 . 0 . 0 . 1 | select o . n , p . partstrat , pg_catalog . count ( i . inhparent ) from pg_catalog . pg_class as c join pg_catalo psql | 127 . 0 . 0 . 1 | SELECT application_name , client_ip , substr ( query , $ 1 , $ 2 ) as query FROM pg_stat_monitor pgbench | 127 . 0 . 0 . 1 | select count ( * ) from pgbench_branches ( 13 rows )","title":"Query information"},{"location":"USER_GUIDE.html#query-timing-information_1","text":"SELECT userid , total_time , min_time , max_time , mean_time , query FROM pg_stat_monitor ; userid | total_time | min_time | max_time | mean_time | query --------+--------------------+--------------------+--------------------+--------------------+------------------------------------------------------------------ 10 | 0 . 14 | 0 . 14 | 0 . 14 | 0 . 14 | select * from pg_stat_monitor_reset () 10 | 0 . 19 | 0 . 19 | 0 . 19 | 0 . 19 | select userid , dbid , queryid , query from pg_stat_monitor 10 | 0 . 30 | 0 . 13 | 0 . 16 | 0 . 15 | select bucket , bucket_start_time , query from pg_stat_monitor 10 | 0 . 29 | 0 . 29 | 0 . 29 | 0 . 29 | select userid , dbid , queryid , query , calls from pg_stat_monitor 10 | 11277 . 79 | 11277 . 79 | 11277 . 79 |","title":"Query timing information"},{"location":"USER_GUIDE.html#query-execution-plan","text":"postgres =# SELECT substr ( query , 0 , 50 ), query_plan from pg_stat_monitor limit 10 ; substr | query_plan ---------------------------------------------------+--------------------------------------------------------------------------------------------------------------- select o . n , p . partstrat , pg_catalog . count ( i . inhpa | Limit + | -> GroupAggregate + | Group Key : ( array_position ( current_schemas ( true ), n . nspname )), p . partstrat + | -> Sort + | Sort Key : ( array_position ( current_schemas ( true ), n . nspname )), p . partstrat + | -> Nested Loop Left Join + | -> Nested Loop Left Join + | -> Nested Loop + | Join Filter : ( c . relnamespace = n . oid ) + | -> Index Scan using pg_class_relname_nsp_index on pg_class c + | Index Cond : ( relname = 'pgbench_accounts' :: name ) + | -> Seq Scan on pg_namespace n + | Filter : ( array_position ( current_schemas ( true ), nspname ) IS NOT NULL ) + | -> Index Scan using pg_partitioned_table_partrelid_index on pg_partitioned_table p + | Index Cond : ( partrelid = c . oid ) + | -> Bitmap Heap Scan on pg_inherits i + | R SELECT abalance FROM pgbench_accounts WHERE aid = | Index Scan using pgbench_accounts_pkey on pgbench_accounts + | Index Cond : ( aid = 102232 ) BEGIN ; | END ; | SELECT substr ( query , $ 1 , $ 2 ), query_plan from pg_st | SELECT substr ( query , $ 1 , $ 2 ), calls , planid , query_pl | Limit + | -> Subquery Scan on pg_stat_monitor + | -> Result + | -> Sort + | Sort Key : p . bucket_start_time + | -> Hash Join + | Hash Cond : ( p . dbid = d . oid ) + | -> Function Scan on pg_stat_monitor_internal p + | -> Hash + | -> Seq Scan on pg_database d + | SubPlan 1 + | -> Function Scan on pg_stat_monitor_internal s + | Filter : ( queryid = p . top_queryid ) select count ( * ) from pgbench_branches | Aggregate + | -> Seq Scan on pgbench_branches UPDATE pgbench_tellers SET tbalance = tbalance + | vacuum pgbench_tellers | UPDATE pgbench_accounts SET abalance = abalance + | ( 10 rows ) The plan column does not contain costing, width and other values. This is an expected behavior as each row is an accumulation of statistics based on plan and amongst other key columns. Plan is only available when the pgsm_enable_query_plan configuration parameter is enabled.","title":"Query execution plan"},{"location":"USER_GUIDE.html#query-type-filtering_1","text":"pg_stat_monitor monitors queries per type (SELECT, INSERT, UPDATE OR DELETE) and classifies them accordingly in the cmd_type column thus reducing your efforts. postgres =# SELECT bucket , substr ( query , 0 , 50 ) AS query , cmd_type FROM pg_stat_monitor WHERE elevel = 0 ; bucket | query | cmd_type --------+---------------------------------------------------+---------- 4 | END | 4 | SELECT abalance FROM pgbench_accounts WHERE aid = | SELECT 4 | vacuum pgbench_branches | 4 | select count ( * ) from pgbench_branches | SELECT 4 | UPDATE pgbench_accounts SET abalance = abalance + | UPDATE 4 | truncate pgbench_history | 4 | INSERT INTO pgbench_history ( tid , bid , aid , delta | INSERT 5 | SELECT relations query FROM pg_stat_monitor | SELECT 9 | SELECT bucket , substr ( query , $ 1 , $ 2 ) AS query , cmd | 4 | vacuum pgbench_tellers | 4 | BEGIN | 5 | SELECT relations , query FROM pg_stat_monitor | SELECT 4 | UPDATE pgbench_tellers SET tbalance = tbalance + | UPDATE 4 | UPDATE pgbench_branches SET bbalance = bbalance + | UPDATE ( 14 rows )","title":"Query type filtering"},{"location":"USER_GUIDE.html#query-metadata_1","text":"The comments column contains any text wrapped in \u201c/*\u201d and \u201c*/\u201d comment tags. The pg_stat_monitor extension picks up these comments and makes them available in the comments column. Please note that only the latest comment value is preserved per row. The comments may be put in any format that can be parsed by a tool. CREATE EXTENSION hstore ; CREATE FUNCTION text_to_hstore ( s text ) RETURNS hstore AS $$ BEGIN RETURN hstore ( s :: text []); EXCEPTION WHEN OTHERS THEN RETURN NULL ; END ; $$ LANGUAGE plpgsql STRICT ; postgres =# SELECT 1 AS num /* { \"application\", java_app, \"real_ip\", 192.168.1.1} */ ; num ----- 1 ( 1 row ) postgres =# SELECT 1 AS num1 , 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ ; num1 | num2 ------+------ 1 | 2 ( 1 row ) postgres =# SELECT 1 AS num1 , 2 AS num2 , 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ ; num1 | num2 | num3 ------+------+------ 1 | 2 | 3 ( 1 row ) postgres =# SELECT 1 AS num1 , 2 AS num2 , 3 AS num3 , 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ ; num1 | num2 | num3 | num4 ------+------+------+------ 1 | 2 | 3 | 4 ( 1 row ) postgres =# select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; query | comments_tags ---------------------------------------------------------------------------------------------------------------+----------------------------------------------------- SELECT $ 1 AS num /* { \"application\", psql_app, \"real_ip\", 192.168.1.3) */ | \"real_ip\" => \"192.168.1.1\" , \"application\" => \"java_app\" SELECT pg_stat_monitor_reset (); | select query , comments , text_to_hstore ( comments ) from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ | \"real_ip\" => \"192.168.1.3\" , \"application\" => \"java_app\" select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ | \"real_ip\" => \"192.168.1.2\" , \"application\" => \"java_app\" SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 , $ 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ | \"real_ip\" => \"192.168.1.3\" , \"application\" => \"psql_app\" ( 7 rows ) postgres =# select query , text_to_hstore ( comments ) -> 'application' as application_name from pg_stat_monitor ; query | application_name ---------------------------------------------------------------------------------------------------------------+---------- SELECT $ 1 AS num /* { \"application\", psql_app, \"real_ip\", 192.168.1.3) */ | java_app SELECT pg_stat_monitor_reset (); | select query , text_to_hstore ( comments ) -> \"real_ip\" as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> $ 1 from pg_stat_monitor | select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> \"application\" as comments_tags from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ | java_app SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ | java_app select query , comments , text_to_hstore ( comments ) from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 , $ 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ | psql_app ( 10 rows ) postgres =# select query , text_to_hstore ( comments ) -> 'real_ip' as real_ip from pg_stat_monitor ; query | real_ip ---------------------------------------------------------------------------------------------------------------+------------- SELECT $ 1 AS num /* { \"application\", psql_app, \"real_ip\", 192.168.1.3) */ | 192 . 168 . 1 . 1 SELECT pg_stat_monitor_reset (); | select query , text_to_hstore ( comments ) -> \"real_ip\" as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> $ 1 from pg_stat_monitor | select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> \"application\" as comments_tags from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ | 192 . 168 . 1 . 2 SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ | 192 . 168 . 1 . 3 select query , comments , text_to_hstore ( comments ) from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 , $ 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ | 192 . 168 . 1 . 3 ( 10 rows )","title":"Query metadata"},{"location":"USER_GUIDE.html#top-query-tracking_1","text":"In the following example we create a function add2 that adds one parameter value to another one and call this function to calculate 1+2. CREATE OR REPLACE function add2 ( int , int ) RETURNS int as $$ BEGIN return ( select $ 1 + $ 2 ); END ; $$ language plpgsql ; SELECT add2 ( 1 , 2 ); add2 ----- 3 ( 1 row ) The `` pg_stat_monitor `` view shows all executed queries and shows the very first query in a row - calling the ` add2 ` function . postgres =# SELECT queryid , top_queryid , query , top_query FROM pg_stat_monitor ; queryid | top_queryid | query . | top_query ------------------+------------------+-------------------------------------------------------------------------+------------------- 3408 CA84B2353094 | | select add2 ( $ 1 , $ 2 ) | 762 B99349F6C7F31 | 3408 CA84B2353094 | SELECT ( select $ 1 + $ 2 ) | select add2 ( $ 1 , $ 2 ) ( 2 rows )","title":"Top query tracking"},{"location":"USER_GUIDE.html#relations_1","text":"Example 1: List all the table names involved in the query. postgres =# SELECT relations , query FROM pg_stat_monitor ; relations | query -------------------------------+------------------------------------------------------------------------------------------------------ | END { public . pgbench_accounts } | SELECT abalance FROM pgbench_accounts WHERE aid = $ 1 | vacuum pgbench_branches { public . pgbench_branches } | select count ( * ) from pgbench_branches { public . pgbench_accounts } | UPDATE pgbench_accounts SET abalance = abalance + $ 1 WHERE aid = $ 2 | truncate pgbench_history { public . pgbench_history } | INSERT INTO pgbench_history ( tid , bid , aid , delta , mtime ) VALUES ( $ 1 , $ 2 , $ 3 , $ 4 , CURRENT_TIMESTAMP ) { public . pg_stat_monitor , pg_catalog . pg_database } | SELECT relations query FROM pg_stat_monitor | vacuum pgbench_tellers | BEGIN { public . pgbench_tellers } | UPDATE pgbench_tellers SET tbalance = tbalance + $ 1 WHERE tid = $ 2 { public . pgbench_branches } | UPDATE pgbench_branches SET bbalance = bbalance + $ 1 WHERE bid = $ 2 ( 12 rows ) Example 2: List all the views and the name of the table in the view. Here we have a view \u201ctest_view\u201d \\ d + test_view View \"public.test_view\" Column | Type | Collation | Nullable | Default | Storage | Description --------+---------+-----------+----------+---------+---------+------------- foo_a | integer | | | | plain | bar_a | integer | | | | plain | View definition : SELECT f . a AS foo_a , b . a AS bar_a FROM foo f , bar b ; Now when we query the pg_stat_monitor , it will show the view name and also all the table names in the view. Note that the view name is followed by an asterisk (*). SELECT relations , query FROM pg_stat_monitor ; relations | query ---------------------+---------------------------------------------------- { test_view * , foo , bar } | select * from test_view { foo , bar } | select * from foo , bar ( 2 rows )","title":"Relations"},{"location":"USER_GUIDE.html#queries-terminated-with-errors","text":"SELECT substr ( query , 0 , 50 ) AS query , decode_error_level ( elevel ) AS elevel , sqlcode , calls , substr ( message , 0 , 50 ) message FROM pg_stat_monitor ; query | elevel | sqlcode | calls | message ---------------------------------------------------+--------+---------+-------+--------------------------------------------------- select substr ( query , $ 1 , $ 2 ) as query , decode_error | | 0 | 1 | select bucket , substr ( query , $ 1 , $ 2 ), decode_error_le | | 0 | 3 | | LOG | 0 | 1 | database system is ready to accept connections select 1 / 0 ; | ERROR | 130 | 1 | division by zero | LOG | 0 | 1 | database system was shut down at 2020 - 11 - 11 11 : 37 select $ 1 / $ 2 | | 0 | 1 | ( 6 rows ) 11277 . 79 | SELECT * FROM foo","title":"Queries terminated with errors"},{"location":"USER_GUIDE.html#histogram_1","text":"Histogram (the resp_calls parameter) provides a visual representation of query performance. With the help of the histogram function, you can view a timing/calling data histogram in response to a SQL query. SELECT resp_calls , query FROM pg_stat_monitor ; resp_calls | query --------------------------------------------------+---------------------------------------------- { 1 , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" } | select client_ip , query from pg_stat_monitor { 3 , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 1\" } | select * from pg_stat_monitor_reset () { 3 , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 1\" } | SELECT * FROM foo postgres =# SELECT * FROM histogram ( 0 , 'F44CD1B4B33A47AF' ) AS a ( range TEXT , freq INT , bar TEXT ); range | freq | bar --------------------+------+-------------------------------- ( 0 - 3 ) } | 2 | \u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0 ( 3 - 10 ) } | 0 | ( 10 - 31 ) } | 1 | \u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0 ( 31 - 100 ) } | 0 | ( 100 - 316 ) } | 0 | ( 316 - 1000 ) } | 0 | ( 1000 - 3162 ) } | 0 | ( 3162 - 10000 ) } | 0 | ( 10000 - 31622 ) } | 0 | ( 31622 - 100000 ) } | 0 | ( 10 rows ) There are 10 time based buckets of the time generated automatically based on total buckets in the field resp_calls . The value in the field shows how many queries run in that period of time.","title":"Histogram"},{"location":"setup.html","text":"Setting up pg_stat_monitor \u00b6 Supported platforms \u00b6 The PostgreSQL YUM repository supports pg_stat_monitor for all supported versions for the following platforms: Red Hat Enterprise/Rocky/CentOS/Oracle Linux 7 and 8 Fedora 33 and 34 Find the list of supported platforms for pg_stat_monitor within Percona Distribution for PostgreSQL on the Percona Release Lifecycle Overview page. Installation guidelines \u00b6 You can install pg_stat_monitor from the following sources: Percona repositories , PostgreSQL PGDG yum repositories , PGXN and source code . Installing from Percona repositories \u00b6 To install pg_stat_monitor from Percona repositories, you need to use the percona-release repository management tool. Install percona-release following the instructions relevant to your operating system Enable Percona repository: percona-release setup ppgXX Replace XX with the desired PostgreSQL version. For example, to install pg_stat_monitor for PostgreSQL 13, specify ppg13 . Install pg_stat_monitor package For Debian and Ubuntu: apt-get install percona-pg-stat-monitor13 For RHEL and CentOS: yum install percona-pg-stat-monitor13 Installing from PostgreSQL yum repositories \u00b6 Install the PostgreSQL repositories following the instructions in the Linux downloads (Red Hat family) chapter in PostgreSQL documentation. Install pg_stat_monitor : dnf install -y pg_stat_monitor_<VERSION> Replace the VERSION variable with the PostgreSQL version you are using (e.g. specify pg_stat_monitor_13 for PostgreSQL 13) Installing from PGXN \u00b6 You can install pg_stat_monitor from PGXN (PostgreSQL Extensions Network) using the PGXN client . Use the following command: pgxn install pg_stat_monitor Building from source \u00b6 To build pg_stat_monitor from source code, you require the following: git make gcc pg_config You can download the source code of the latest release of pg_stat_monitor from the releases page on GitHub or using git: git clone git://github.com/Percona/pg_stat_monitor.git Compile and install the extension cd pg_stat_monitor make USE_PGXS=1 make USE_PGXS=1 install Setup \u00b6 You can enable pg_stat_monitor when your postgresql instance is not running. pg_stat_monitor needs to be loaded at the start time. The extension requires additional shared memory; therefore, add the pg_stat_monitor value for the shared_preload_libraries parameter and restart the postgresql instance. Use the ALTER SYSTEM command from psql terminal to modify the shared_preload_libraries parameter. ALTER SYSTEM SET shared_preload_libraries = 'pg_stat_monitor' ; NOTE : If you\u2019ve added other modules to the shared_preload_libraries parameter (for example, pg_stat_statements ), list all of them separated by commas for the ALTER SYSTEM command. For PostgreSQL 13 and earlier versions, pg_stat_monitor must follow pg_stat_statements . For example, ALTER SYSTEM SET shared_preload_libraries = 'foo, pg_stat_statements, pg_stat_monitor' . In PostgreSQL 14, you can specify pg_stat_statements and pg_stat_monitor in any order. However, due to the extensions\u2019 architecture, if both pg_stat_statements and pg_stat_monitor are loaded, only the last listed extension captures utility queries, CREATE TABLE, Analyze, etc. The first listed extension captures most common queries like SELECT, UPDATE, INSERT, but does not capture utility queries. Thus, to collect the whole statistics with pg_stat_monitor, we recommend to specify the extensions as follows: ALTER SYSTEM SET shared_preload_libraries = \u2018pg_stat_statements, pg_stat_monitor\u2019. Start or restart the postgresql instance to apply the changes. On Debian and Ubuntu: sudo systemctl restart postgresql.service On Red Hat Enterprise Linux and CentOS: sudo systemctl restart postgresql-13 Create the extension using the CREATE EXTENSION command. Using this command requires the privileges of a superuser or a database owner. Connect to psql as a superuser for a database and run the following command: CREATE EXTENSION pg_stat_monitor ; This allows you to see the stats collected by pg_stat_monitor . By default, pg_stat_monitor is created for the postgres database. To access the statistics from other databases, you need to create the extension for every database. -- Select some of the query information, like client_ip, username and application_name etc. postgres=# SELECT application_name, userid AS user_name, datname AS database_name, substr(query,0, 50) AS query, calls, client_ip FROM pg_stat_monitor; application_name | user_name | database_name | query | calls | client_ip ------------------+-----------+---------------+---------------------------------------------------+-------+----------- psql | vagrant | postgres | SELECT application_name, userid::regrole AS user_ | 1 | 127.0.0.1 psql | vagrant | postgres | SELECT application_name, userid AS user_name, dat | 3 | 127.0.0.1 psql | vagrant | postgres | SELECT application_name, userid AS user_name, dat | 1 | 127.0.0.1 psql | vagrant | postgres | SELECT application_name, userid AS user_name, dat | 8 | 127.0.0.1 psql | vagrant | postgres | SELECT bucket, substr(query,$1, $2) AS query, cmd | 1 | 127.0.0.1 (5 rows) To learn more about pg_stat_monitor features and usage, see User Guide . To view all other data elements provided by pg_stat_monitor , please see the pg_stat_monitor view reference . Configuration \u00b6 You can find the configuration parameters of the pg_stat_monitor extension in the pg_stat_monitor_settings view. To change the default configuration, specify new values for the desired parameters using the GUC (Grant Unified Configuration) system. To learn more, refer to the Configuration section of the user guide. Remove pg_stat_monitor \u00b6 To uninstall pg_stat_monitor , do the following: Disable statistics collection. Establish the psql session and run the following command : ALTER SYSTEM SET pg_stat_monitor . pgsm_enable = 0 ; Drop pg_stat_monitor extension: DROP EXTENSION pg_stat_monitor ; Remove pg_stat_monitor from the shared_preload_libraries configuration parameter: ALTER SYSTEM SET shared_preload_libraries = '' ; Important If the shared_preload_libraries parameter includes other modules, specify them all for the ALTER SYSTEM SET command to keep using them. Restart the postgresql instance to apply the changes. The following command restarts PostgreSQL 13. Replace the version value with the one you are using. On Debian and Ubuntu: sudo systemctl restart postgresql.service On Red Hat Enterprise Linux and CentOS: sudo systemctl restart postgresql-13","title":"Setting up `pg_stat_monitor`"},{"location":"setup.html#setting-up-pg_stat_monitor","text":"","title":"Setting up pg_stat_monitor"},{"location":"setup.html#supported-platforms","text":"The PostgreSQL YUM repository supports pg_stat_monitor for all supported versions for the following platforms: Red Hat Enterprise/Rocky/CentOS/Oracle Linux 7 and 8 Fedora 33 and 34 Find the list of supported platforms for pg_stat_monitor within Percona Distribution for PostgreSQL on the Percona Release Lifecycle Overview page.","title":"Supported platforms"},{"location":"setup.html#installation-guidelines","text":"You can install pg_stat_monitor from the following sources: Percona repositories , PostgreSQL PGDG yum repositories , PGXN and source code .","title":"Installation guidelines"},{"location":"setup.html#installing-from-percona-repositories","text":"To install pg_stat_monitor from Percona repositories, you need to use the percona-release repository management tool. Install percona-release following the instructions relevant to your operating system Enable Percona repository: percona-release setup ppgXX Replace XX with the desired PostgreSQL version. For example, to install pg_stat_monitor for PostgreSQL 13, specify ppg13 . Install pg_stat_monitor package For Debian and Ubuntu: apt-get install percona-pg-stat-monitor13 For RHEL and CentOS: yum install percona-pg-stat-monitor13","title":"Installing from Percona repositories"},{"location":"setup.html#installing-from-postgresql-yum-repositories","text":"Install the PostgreSQL repositories following the instructions in the Linux downloads (Red Hat family) chapter in PostgreSQL documentation. Install pg_stat_monitor : dnf install -y pg_stat_monitor_<VERSION> Replace the VERSION variable with the PostgreSQL version you are using (e.g. specify pg_stat_monitor_13 for PostgreSQL 13)","title":"Installing from PostgreSQL yum repositories"},{"location":"setup.html#installing-from-pgxn","text":"You can install pg_stat_monitor from PGXN (PostgreSQL Extensions Network) using the PGXN client . Use the following command: pgxn install pg_stat_monitor","title":"Installing from PGXN"},{"location":"setup.html#building-from-source","text":"To build pg_stat_monitor from source code, you require the following: git make gcc pg_config You can download the source code of the latest release of pg_stat_monitor from the releases page on GitHub or using git: git clone git://github.com/Percona/pg_stat_monitor.git Compile and install the extension cd pg_stat_monitor make USE_PGXS=1 make USE_PGXS=1 install","title":"Building from source"},{"location":"setup.html#setup","text":"You can enable pg_stat_monitor when your postgresql instance is not running. pg_stat_monitor needs to be loaded at the start time. The extension requires additional shared memory; therefore, add the pg_stat_monitor value for the shared_preload_libraries parameter and restart the postgresql instance. Use the ALTER SYSTEM command from psql terminal to modify the shared_preload_libraries parameter. ALTER SYSTEM SET shared_preload_libraries = 'pg_stat_monitor' ; NOTE : If you\u2019ve added other modules to the shared_preload_libraries parameter (for example, pg_stat_statements ), list all of them separated by commas for the ALTER SYSTEM command. For PostgreSQL 13 and earlier versions, pg_stat_monitor must follow pg_stat_statements . For example, ALTER SYSTEM SET shared_preload_libraries = 'foo, pg_stat_statements, pg_stat_monitor' . In PostgreSQL 14, you can specify pg_stat_statements and pg_stat_monitor in any order. However, due to the extensions\u2019 architecture, if both pg_stat_statements and pg_stat_monitor are loaded, only the last listed extension captures utility queries, CREATE TABLE, Analyze, etc. The first listed extension captures most common queries like SELECT, UPDATE, INSERT, but does not capture utility queries. Thus, to collect the whole statistics with pg_stat_monitor, we recommend to specify the extensions as follows: ALTER SYSTEM SET shared_preload_libraries = \u2018pg_stat_statements, pg_stat_monitor\u2019. Start or restart the postgresql instance to apply the changes. On Debian and Ubuntu: sudo systemctl restart postgresql.service On Red Hat Enterprise Linux and CentOS: sudo systemctl restart postgresql-13 Create the extension using the CREATE EXTENSION command. Using this command requires the privileges of a superuser or a database owner. Connect to psql as a superuser for a database and run the following command: CREATE EXTENSION pg_stat_monitor ; This allows you to see the stats collected by pg_stat_monitor . By default, pg_stat_monitor is created for the postgres database. To access the statistics from other databases, you need to create the extension for every database. -- Select some of the query information, like client_ip, username and application_name etc. postgres=# SELECT application_name, userid AS user_name, datname AS database_name, substr(query,0, 50) AS query, calls, client_ip FROM pg_stat_monitor; application_name | user_name | database_name | query | calls | client_ip ------------------+-----------+---------------+---------------------------------------------------+-------+----------- psql | vagrant | postgres | SELECT application_name, userid::regrole AS user_ | 1 | 127.0.0.1 psql | vagrant | postgres | SELECT application_name, userid AS user_name, dat | 3 | 127.0.0.1 psql | vagrant | postgres | SELECT application_name, userid AS user_name, dat | 1 | 127.0.0.1 psql | vagrant | postgres | SELECT application_name, userid AS user_name, dat | 8 | 127.0.0.1 psql | vagrant | postgres | SELECT bucket, substr(query,$1, $2) AS query, cmd | 1 | 127.0.0.1 (5 rows) To learn more about pg_stat_monitor features and usage, see User Guide . To view all other data elements provided by pg_stat_monitor , please see the pg_stat_monitor view reference .","title":"Setup"},{"location":"setup.html#configuration","text":"You can find the configuration parameters of the pg_stat_monitor extension in the pg_stat_monitor_settings view. To change the default configuration, specify new values for the desired parameters using the GUC (Grant Unified Configuration) system. To learn more, refer to the Configuration section of the user guide.","title":"Configuration"},{"location":"setup.html#remove-pg_stat_monitor","text":"To uninstall pg_stat_monitor , do the following: Disable statistics collection. Establish the psql session and run the following command : ALTER SYSTEM SET pg_stat_monitor . pgsm_enable = 0 ; Drop pg_stat_monitor extension: DROP EXTENSION pg_stat_monitor ; Remove pg_stat_monitor from the shared_preload_libraries configuration parameter: ALTER SYSTEM SET shared_preload_libraries = '' ; Important If the shared_preload_libraries parameter includes other modules, specify them all for the ALTER SYSTEM SET command to keep using them. Restart the postgresql instance to apply the changes. The following command restarts PostgreSQL 13. Replace the version value with the one you are using. On Debian and Ubuntu: sudo systemctl restart postgresql.service On Red Hat Enterprise Linux and CentOS: sudo systemctl restart postgresql-13","title":"Remove pg_stat_monitor"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"index.html","text":"Welcome \u00b6 The pg_stat_monitor is a Query Performance Monitoring tool for PostgreSQL. It collects performance stats and provides query performance insights in a single view. These insights allow database users to understand query origins, execution, planning statistics and details, query information, and metadata. This significantly improves observability, enabling users to debug and tune query performance. How pg_stat_monitor works? \u00b6 pg_stat_monitor is developed on the basis of pg_stat_statements as its more advanced replacement. While pg_stat_statements provides ever-increasing metrics, pg_stat_monitor aggregates the collected data, saving user efforts for doing it themselves. pg_stat_monitor stores statistics in configurable time-based units \u2013 buckets . Such bucket-based data collection allows focusing on statistics generated for shorter time periods and makes query timing information such as max/min/mean time more accurate. Features \u00b6 Time Interval Grouping: Instead of supplying one set of ever-increasing counts, pg_stat_monitor computes stats for a configured number of time intervals - time buckets. This allows for much better data accuracy, especially in the case of high resolution or unreliable networks. Multi-Dimensional Grouping: While pg_stat_statements groups counters by userid, dbid, queryid, pg_stat_monitor uses a more detailed group for higher precision. This allows a user to drill down into the performance of queries. Capture Actual Parameters in the Queries: pg_stat_monitor allows you to choose if you want to see queries with placeholders for parameters or actual parameter data. This simplifies debugging and analysis processes by enabling users to execute the same query. Query Plan: Each SQL is now accompanied by its actual plan that was constructed for its execution. That\u2019s a huge advantage if you want to understand why a particular query is slower than expected. Tables Access Statistics for a Statement: This allows us to easily identify all queries that accessed a given table. This set is at par with the information provided by the pg_stat_statements . Histogram: Visual representation is very helpful as it can help identify issues. With the help of the histogram function, one can now view a timing/calling data histogram in response to an SQL query. And yes, it even works in psql. Availability \u00b6 pg_stat_monitor supports PostgreSQL versions 11 and above. It is compatible with both PostgreSQL provided by PostgreSQL Global Development Group (PGDG) and Percona Distribution for PostgreSQL . Supported versions \u00b6 The pg_stat_monitor should work on the latest version of both Percona Distribution for PostgreSQL and PostgreSQL, but is only tested with these versions: Distribution Version Provider Percona Distribution for PostgreSQL 11 , 12 , 13 and 14 Percona PostgreSQL 11, 12, 13 and 14 PostgreSQL Global Development Group (PGDG) The RPM (for RHEL and CentOS) and the DEB (for Debian and Ubuntu) packages are available from Percona repositories for PostgreSQL versions 11 , 12 , 13 and 14 . The RPM packages are also available in the official PostgreSQL (PGDG) yum repositories. Get started \u00b6 Use the installation guidelines to install and set up pg_stat_monitor . Refer to the User guide for details about available features and functions, usage examples and configuration parameters. Get engaged \u00b6 Use the contributing guide to learn how to become a contributor. Use the forum to discuss a topic with the community. Read more \u00b6 pg_stat_monitor view reference pg_stat_monitor and pg_stat_statements comparison","title":"Welcome"},{"location":"index.html#welcome","text":"The pg_stat_monitor is a Query Performance Monitoring tool for PostgreSQL. It collects performance stats and provides query performance insights in a single view. These insights allow database users to understand query origins, execution, planning statistics and details, query information, and metadata. This significantly improves observability, enabling users to debug and tune query performance.","title":"Welcome"},{"location":"index.html#how-pg_stat_monitor-works","text":"pg_stat_monitor is developed on the basis of pg_stat_statements as its more advanced replacement. While pg_stat_statements provides ever-increasing metrics, pg_stat_monitor aggregates the collected data, saving user efforts for doing it themselves. pg_stat_monitor stores statistics in configurable time-based units \u2013 buckets . Such bucket-based data collection allows focusing on statistics generated for shorter time periods and makes query timing information such as max/min/mean time more accurate.","title":"How pg_stat_monitor works?"},{"location":"index.html#features","text":"Time Interval Grouping: Instead of supplying one set of ever-increasing counts, pg_stat_monitor computes stats for a configured number of time intervals - time buckets. This allows for much better data accuracy, especially in the case of high resolution or unreliable networks. Multi-Dimensional Grouping: While pg_stat_statements groups counters by userid, dbid, queryid, pg_stat_monitor uses a more detailed group for higher precision. This allows a user to drill down into the performance of queries. Capture Actual Parameters in the Queries: pg_stat_monitor allows you to choose if you want to see queries with placeholders for parameters or actual parameter data. This simplifies debugging and analysis processes by enabling users to execute the same query. Query Plan: Each SQL is now accompanied by its actual plan that was constructed for its execution. That\u2019s a huge advantage if you want to understand why a particular query is slower than expected. Tables Access Statistics for a Statement: This allows us to easily identify all queries that accessed a given table. This set is at par with the information provided by the pg_stat_statements . Histogram: Visual representation is very helpful as it can help identify issues. With the help of the histogram function, one can now view a timing/calling data histogram in response to an SQL query. And yes, it even works in psql.","title":"Features"},{"location":"index.html#availability","text":"pg_stat_monitor supports PostgreSQL versions 11 and above. It is compatible with both PostgreSQL provided by PostgreSQL Global Development Group (PGDG) and Percona Distribution for PostgreSQL .","title":"Availability"},{"location":"index.html#supported-versions","text":"The pg_stat_monitor should work on the latest version of both Percona Distribution for PostgreSQL and PostgreSQL, but is only tested with these versions: Distribution Version Provider Percona Distribution for PostgreSQL 11 , 12 , 13 and 14 Percona PostgreSQL 11, 12, 13 and 14 PostgreSQL Global Development Group (PGDG) The RPM (for RHEL and CentOS) and the DEB (for Debian and Ubuntu) packages are available from Percona repositories for PostgreSQL versions 11 , 12 , 13 and 14 . The RPM packages are also available in the official PostgreSQL (PGDG) yum repositories.","title":"Supported  versions"},{"location":"index.html#get-started","text":"Use the installation guidelines to install and set up pg_stat_monitor . Refer to the User guide for details about available features and functions, usage examples and configuration parameters.","title":"Get started"},{"location":"index.html#get-engaged","text":"Use the contributing guide to learn how to become a contributor. Use the forum to discuss a topic with the community.","title":"Get engaged"},{"location":"index.html#read-more","text":"pg_stat_monitor view reference pg_stat_monitor and pg_stat_statements comparison","title":"Read more"},{"location":"COMPARISON.html","text":"Comparing pg_stat_monitor and pg_stat_statements \u00b6 The pg_stat_monitor extension is developed on the basis of pg_stat_statements as its more advanced replacement. Thus, pg_stat_monitor inherits the columns available in pg_stat_statements plus provides additional ones. Note that pg_stat_monitor and pg_stat_statements process statistics data differently . Because of these differences, memory blocks and WAL (Write Ahead Logs) related statistics data are displayed inconsistently when both extensions are used together. To see all available columns, run the following command from the psql terminal: postgres =# \\ d pg_stat_monitor ; The following table compares the pg_stat_monitor view with that of pg_stat_statements . Note that the column names differ depending on the PostgreSQL version you are running. Column name for PostgreSQL 13 and above Column name for PostgreSQL 11 and 12 pg_stat_monitor pg_stat_statements bucket bucket bucket_start_time bucket_start_time userid userid datname datname toplevel 1 client_ip client_ip queryid queryid planid planid query_plan query_plan top_query top_query top_queryid top_queryid query query application_name application_name relations relations cmd_type cmd_type elevel elevel sqlcode sqlcode message message plans_calls plans_calls total_plan_time min_plan_time max_plan_time mean_plan_time stddev_plan_time calls calls total_exec_time total_time min_exec_time min_time max_exec_time max_time mean_exec_time mean_time stddev_exec_time stddev_time rows_retrieved rows_retrieved shared_blks_hit shared_blks_hit shared_blks_read shared_blks_read shared_blks_dirtied shared_blks_dirtied shared_blks_written shared_blks_written local_blks_hit local_blks_hit local_blks_read local_blks_read local_blks_dirtied local_blks_dirtied local_blks_written local_blks_written temp_blks_read temp_blks_read temp_blks_written temp_blks_written blk_read_time blk_read_time blk_write_time blk_write_time resp_calls resp_calls cpu_user_time cpu_user_time cpu_sys_time cpu_sys_time wal_records wal_records wal_fpi wal_fpi wal_bytes wal_bytes state_code state_code state state To learn more about the features in pg_stat_monitor , please see the User guide . Additional reading: pg_stat_statements Available starting from PostgreSQL 14 and above \u21a9","title":"Comparing pg_stat_monitor and pg_stat_statements"},{"location":"COMPARISON.html#comparing-pg_stat_monitor-and-pg_stat_statements","text":"The pg_stat_monitor extension is developed on the basis of pg_stat_statements as its more advanced replacement. Thus, pg_stat_monitor inherits the columns available in pg_stat_statements plus provides additional ones. Note that pg_stat_monitor and pg_stat_statements process statistics data differently . Because of these differences, memory blocks and WAL (Write Ahead Logs) related statistics data are displayed inconsistently when both extensions are used together. To see all available columns, run the following command from the psql terminal: postgres =# \\ d pg_stat_monitor ; The following table compares the pg_stat_monitor view with that of pg_stat_statements . Note that the column names differ depending on the PostgreSQL version you are running. Column name for PostgreSQL 13 and above Column name for PostgreSQL 11 and 12 pg_stat_monitor pg_stat_statements bucket bucket bucket_start_time bucket_start_time userid userid datname datname toplevel 1 client_ip client_ip queryid queryid planid planid query_plan query_plan top_query top_query top_queryid top_queryid query query application_name application_name relations relations cmd_type cmd_type elevel elevel sqlcode sqlcode message message plans_calls plans_calls total_plan_time min_plan_time max_plan_time mean_plan_time stddev_plan_time calls calls total_exec_time total_time min_exec_time min_time max_exec_time max_time mean_exec_time mean_time stddev_exec_time stddev_time rows_retrieved rows_retrieved shared_blks_hit shared_blks_hit shared_blks_read shared_blks_read shared_blks_dirtied shared_blks_dirtied shared_blks_written shared_blks_written local_blks_hit local_blks_hit local_blks_read local_blks_read local_blks_dirtied local_blks_dirtied local_blks_written local_blks_written temp_blks_read temp_blks_read temp_blks_written temp_blks_written blk_read_time blk_read_time blk_write_time blk_write_time resp_calls resp_calls cpu_user_time cpu_user_time cpu_sys_time cpu_sys_time wal_records wal_records wal_fpi wal_fpi wal_bytes wal_bytes state_code state_code state state To learn more about the features in pg_stat_monitor , please see the User guide . Additional reading: pg_stat_statements Available starting from PostgreSQL 14 and above \u21a9","title":"Comparing pg_stat_monitor and pg_stat_statements"},{"location":"REFERENCE.html","text":"pg_stat_monitor view reference \u00b6 pg_stat_monitor provides a view where the statistics data is displayed. To see all available columns, run the following command from psql : postgres =# \\ d pg_stat_monitor Depending on the PostgreSQL version, some column names may differ. The following table describes the pg_stat_monitor view for PostgreSQL 14 and higher versions. Column Type Description bucket integer Data collection unit. The number shows what bucket in a chain a record belongs to bucket_start_time timestamp with time zone The start time of the bucket userid regrole An ID of the user who run a query datname name The name of a database where the query was executed toplevel bool True means that a query was executed as a top-level statement client_ip inet The IP address of a client that run the query queryid text The internal hash code serving to identify every query in a statement planid text An internally generated ID of a query plan query_plan text The sequence of steps used to execute a query. This parameter is available only when the pgsm_enable_query_plan is enabled. top_query text Shows the top query used in a statement query text The actual text of the query application_name text Shows the name of the application connected to the database relations text[] The list of tables involved in the query cmd_type integer Type of the query executed cmd_type_text text[] The description of the query executed elevel integer Shows the error level of a query (WARNING, ERROR, LOG) sqlcode integer SQL error code message text The error message plans_calls bigint The number of times the statement was planned total_plan_time double precision The total time (in ms) spent on planning the statement min_plan_time double precision Minimum time (in ms) spent on planning the statement max_plan_time double precision Maximum time (in ms) spent on planning the statement mean_plan_time double precision The mean (average) time (in ms) spent on planning the statement stddev_plan_time double precision The standard deviation of time (in ms) spent on planning the statement calls bigint The number of times a particular query was executed total_exec_time double precision The total time (in ms) spent on executing a query min_exec_time double precision The minimum time (in ms) it took to execute a query max_exec_time double precision The maximum time (in ms) it took to execute a query mean_time double precision The mean (average) time (in ms) it took to execute a query stddev_exec_time double precision The standard deviation of time (in ms) spent on executing a query rows_retrieved bigint The number of rows retrieved when executing a query shared_blks_hit bigint Shows the total number of shared memory blocks returned from the cache shared_blks_read bigint Shows the total number of shared blocks returned not from the cache shared_blks_dirtied bigint Shows the number of shared memory blocks \u201cdirtied\u201d by the query execution (i.e. a query modified at least one tuple in a block and this block must be written to a drive) shared_blks_written bigint Shows the number of shared memory blocks written simultaneously to a drive during the query execution local_blks_hit bigint The number of blocks which are considered as local by the backend and thus are used for temporary tables local_blks_read bigint Total number of local blocks read during the query execution local_blks_dirtied bigint Total number of local blocks \u201cdirtied\u201d during the query execution (i.e. a query modified at least one tuple in a block and this block must be written to a drive) local_blks_written bigint Total number of local blocks written simultaneously to a drive during the query execution temp_blks_read bigint Total number of blocks of temporary files read from a drive. Temporary files are used when there\u2019s not enough memory to execute a query temp_blks_written bigint Total number of blocks of temporary files written to a drive blk_read_time double precision Total waiting time (in ms) for reading blocks blk_write_time double precision Total waiting time (in ms) for writing blocks to a drive resp_calls text[] Call histogram cpu_user_time double precision The time (in ms) the CPU spent on running the query cpu_sys_time double precision The time (in ms) the CPU spent on executing the kernel code wal_records bigint The total number of WAL (Write Ahead Logs) generated by the query wal_fpi bigint The total number of WAL FPI (Full Page Images) generated by the query wal_bytes numeric Total number of bytes used for the WAL generated by the query state_code bigint Shows the state code of a query state text The state message","title":"`pg_stat_monitor` view reference"},{"location":"REFERENCE.html#pg_stat_monitor-view-reference","text":"pg_stat_monitor provides a view where the statistics data is displayed. To see all available columns, run the following command from psql : postgres =# \\ d pg_stat_monitor Depending on the PostgreSQL version, some column names may differ. The following table describes the pg_stat_monitor view for PostgreSQL 14 and higher versions. Column Type Description bucket integer Data collection unit. The number shows what bucket in a chain a record belongs to bucket_start_time timestamp with time zone The start time of the bucket userid regrole An ID of the user who run a query datname name The name of a database where the query was executed toplevel bool True means that a query was executed as a top-level statement client_ip inet The IP address of a client that run the query queryid text The internal hash code serving to identify every query in a statement planid text An internally generated ID of a query plan query_plan text The sequence of steps used to execute a query. This parameter is available only when the pgsm_enable_query_plan is enabled. top_query text Shows the top query used in a statement query text The actual text of the query application_name text Shows the name of the application connected to the database relations text[] The list of tables involved in the query cmd_type integer Type of the query executed cmd_type_text text[] The description of the query executed elevel integer Shows the error level of a query (WARNING, ERROR, LOG) sqlcode integer SQL error code message text The error message plans_calls bigint The number of times the statement was planned total_plan_time double precision The total time (in ms) spent on planning the statement min_plan_time double precision Minimum time (in ms) spent on planning the statement max_plan_time double precision Maximum time (in ms) spent on planning the statement mean_plan_time double precision The mean (average) time (in ms) spent on planning the statement stddev_plan_time double precision The standard deviation of time (in ms) spent on planning the statement calls bigint The number of times a particular query was executed total_exec_time double precision The total time (in ms) spent on executing a query min_exec_time double precision The minimum time (in ms) it took to execute a query max_exec_time double precision The maximum time (in ms) it took to execute a query mean_time double precision The mean (average) time (in ms) it took to execute a query stddev_exec_time double precision The standard deviation of time (in ms) spent on executing a query rows_retrieved bigint The number of rows retrieved when executing a query shared_blks_hit bigint Shows the total number of shared memory blocks returned from the cache shared_blks_read bigint Shows the total number of shared blocks returned not from the cache shared_blks_dirtied bigint Shows the number of shared memory blocks \u201cdirtied\u201d by the query execution (i.e. a query modified at least one tuple in a block and this block must be written to a drive) shared_blks_written bigint Shows the number of shared memory blocks written simultaneously to a drive during the query execution local_blks_hit bigint The number of blocks which are considered as local by the backend and thus are used for temporary tables local_blks_read bigint Total number of local blocks read during the query execution local_blks_dirtied bigint Total number of local blocks \u201cdirtied\u201d during the query execution (i.e. a query modified at least one tuple in a block and this block must be written to a drive) local_blks_written bigint Total number of local blocks written simultaneously to a drive during the query execution temp_blks_read bigint Total number of blocks of temporary files read from a drive. Temporary files are used when there\u2019s not enough memory to execute a query temp_blks_written bigint Total number of blocks of temporary files written to a drive blk_read_time double precision Total waiting time (in ms) for reading blocks blk_write_time double precision Total waiting time (in ms) for writing blocks to a drive resp_calls text[] Call histogram cpu_user_time double precision The time (in ms) the CPU spent on running the query cpu_sys_time double precision The time (in ms) the CPU spent on executing the kernel code wal_records bigint The total number of WAL (Write Ahead Logs) generated by the query wal_fpi bigint The total number of WAL FPI (Full Page Images) generated by the query wal_bytes numeric Total number of bytes used for the WAL generated by the query state_code bigint Shows the state code of a query state text The state message","title":"pg_stat_monitor view reference"},{"location":"RELEASE_NOTES.html","text":"Release Notes \u00b6 Below is the complete list of release notes for every version of pg_stat_monitor . 1.0.1 \u00b6 Bugs Fixed \u00b6 PG-382 : Histogram default settings changed to prevent the PostgreSQL server to crash PG-417 : Addressed security vulnerabilities to prevent an attacker from precreating functions DISTPG-427 : Fixed the issue with the extensions not working when pg_stat_monitor is enabled by replacing the return with goto exit for the pgsm_emit_log_hook function 1.0.0 \u00b6 Bump version from 1.0.0-rc.2 to 1.0.0. 1.0.0-rc.2 \u00b6 Improvements \u00b6 PG-331 : Changed the default value for the pg_stat_monitor.pgsm_query_max_len parameter from 1024 to 2048 for better data presentation in PMM PG-355 : Changed the collection of sys_time and user_time metrics so that they are now presented as an accumulative value PG-286 : Improved pg_stat_monitor performance by decreasing the overhead by more than 50%. PG-267 : Added test case to verify histogram feature PG-359 : Documentation: updated the pg_stat_monitor_settings view reference. PG-344 : Documentation: Updated the extensions order and behavior with data collection for PostgreSQL 14. PG-358 : Documentation: data display of ** blk ** and ** wal ** columns when both pg_stat_monitor and pg_stat_statements are loaded together. Bugs Fixed \u00b6 PG-350 : Fixed bucket time overflow PG-338 : Fixed query calls count by setting the default value for pg_stat_monitor.pgsm_track to top . PG-291 : Fixed calls count. PG-325 : Fixed deadlock that occurred when the query length exceeded the pgsm_query_max_len value. PG-326 : Added validation for pgsm_histogram_min and pgsm_histogram_max ranges PG-329 : Fixed creation of pg_stat_monitor_errors view on SQL files. PG-296 : Fixed issue with the application name not displaying in the view when changed. PG-290 : Fixed issue with PostgreSQL crashing after enabling debug log level and when pg_stat_monitor is enabled. PG-166 : Fixed issue with displaying the actual system time values instead of NULL PG-369 : Fixed issue with incorrect wal_bytes values for PostgreSQL 11 and 12 that caused Query Analytics failure in PMM by ignoring the WalUsage variable value for these versions. 1.0.0-rc.1 \u00b6 Improvements \u00b6 PG-165 : Recycle expired buckets PG-167 : Make SQL error codes readable by updating their data types PG-193 : Create a comment based tags to identify different parameters PG-199 : Documentation: Add the integration with PMM section in User Guide PG-210 : Documentation: Update column names per POstgreSQL version to match the upstream ones Bugs Fixed \u00b6 PG-177 : Fixed the error in histogram ranges PG-214 : Fixed the issue with the display of the error message as part of the query column in pg_stat_monitor view PG-246 : Fixed the issue with significant CPU and memory resource usage when pg_stat_monitor.pgsm_enable_query_plan parameter is enabled PG-262 : Fixed the way the comments are extracted in pg_stat_monitor view PG-271 : Fixed the issue with enabling the pg_stat_monitor.pgsm_overflow_target configuration parameter. PG-272 : Fixed the server crash when calling the pg_stat_monitor_reset() function by using the correct PGSM_MAX_BUCKETS GUC as the limit to the loop REL0_9_0_STABLE \u00b6 Improvements \u00b6 PG-186 : Add support to monitor query execution plan PG-147 : Store top query, instead of parent query. PG-188 : Added a new column to monitor the query state i.e PARSING/PLANNING/ACTIVE/FINISHED. PG-180 : Schema Qualified table/relations names. Regression Test Suite. Bugs Fixed \u00b6 PG-189 : Regression crash in case of PostgreSQL 11. PG-187 : Compilation Error for PostgreSQL 11 and PostgreSQL 12. PG-186 : Add support to monitor query execution plan. PG-182 : Added a new option for the query buffer overflow. PG-181 : Segmentation fault in case of track_utility is ON. Some Code refactoring. REL0_8_1 \u00b6 PG-147 : Stored Procedure Support add parentid to track caller. PG-177 : Error in Histogram ranges. REL0_8_0_STABLE \u00b6 Improvements \u00b6 Column userid (int64) was removed. Column dbid (int64) was removed. Column user (string) was added (replacement for userid). Column datname (string) was added (replacement for dbid). PG-176 : Extract fully qualified relations name. PG-175 : Only Superuser / Privileged user can view IP address. PG-174 : Code cleanup. PG-173 : Added new WAL usage statistics. PG-172 : Exponential histogram for time buckets. PG-164 : Query timing will be four decimal places instead of two. PG-167 : SQLERRCODE must be in readable format. Bugs Fixed \u00b6 PG-169 : Fixing message buffer overrun and incorrect index access to fix the server crash. PG-168 : \u201ccalls\u201d and histogram parameter does not match. PG-166 : Display actual system time instead of null. PG-165 : Recycle expired buckets. PG-150 : Error while logging CMD Type like SELECT, UPDATE, INSERT, DELETE. REL0_7_2 \u00b6 PG-165 : Recycle expired buckets. PG-164 : Query timing will be four decimal places instead of two. PG-161 : Miscellaneous small issues. REL0_7_1 \u00b6 PG-158 : Segmentation fault while using pgbench with clients > 1. PG-159 : Bucket start time (bucket_start_time) should be aligned with bucket_time. PG-160 : Integration with PGXN. REL0_7_0_STABLE \u00b6 Improvements \u00b6 PG-153 : Capture and record the application_name executing the query. PG-145 : Add a new View/Query to show the actual Database name and Username. PG-110 ; Aggregate the number of warnings. PG-109 : Log failed queries or queries with warning messages. PG-150 : Differentiate different types of queries such as SELECT, UPDATE, INSERT or DELETE. Bugs Fixed \u00b6 PG-111 Show information for incomplete buckets. PG-148 Loss of query statistics/monitoring due to not enough \u201cslots\u201d available. v0.6.0 \u00b6 Initial Release. Master \u00b6 Improvements \u00b6 PG-156 : Adding a placeholder replacement function for the prepared statement","title":"Release notes"},{"location":"RELEASE_NOTES.html#release-notes","text":"Below is the complete list of release notes for every version of pg_stat_monitor .","title":"Release Notes"},{"location":"RELEASE_NOTES.html#101","text":"","title":"1.0.1"},{"location":"RELEASE_NOTES.html#bugs-fixed","text":"PG-382 : Histogram default settings changed to prevent the PostgreSQL server to crash PG-417 : Addressed security vulnerabilities to prevent an attacker from precreating functions DISTPG-427 : Fixed the issue with the extensions not working when pg_stat_monitor is enabled by replacing the return with goto exit for the pgsm_emit_log_hook function","title":"Bugs Fixed"},{"location":"RELEASE_NOTES.html#100","text":"Bump version from 1.0.0-rc.2 to 1.0.0.","title":"1.0.0"},{"location":"RELEASE_NOTES.html#100-rc2","text":"","title":"1.0.0-rc.2"},{"location":"RELEASE_NOTES.html#improvements","text":"PG-331 : Changed the default value for the pg_stat_monitor.pgsm_query_max_len parameter from 1024 to 2048 for better data presentation in PMM PG-355 : Changed the collection of sys_time and user_time metrics so that they are now presented as an accumulative value PG-286 : Improved pg_stat_monitor performance by decreasing the overhead by more than 50%. PG-267 : Added test case to verify histogram feature PG-359 : Documentation: updated the pg_stat_monitor_settings view reference. PG-344 : Documentation: Updated the extensions order and behavior with data collection for PostgreSQL 14. PG-358 : Documentation: data display of ** blk ** and ** wal ** columns when both pg_stat_monitor and pg_stat_statements are loaded together.","title":"Improvements"},{"location":"RELEASE_NOTES.html#bugs-fixed_1","text":"PG-350 : Fixed bucket time overflow PG-338 : Fixed query calls count by setting the default value for pg_stat_monitor.pgsm_track to top . PG-291 : Fixed calls count. PG-325 : Fixed deadlock that occurred when the query length exceeded the pgsm_query_max_len value. PG-326 : Added validation for pgsm_histogram_min and pgsm_histogram_max ranges PG-329 : Fixed creation of pg_stat_monitor_errors view on SQL files. PG-296 : Fixed issue with the application name not displaying in the view when changed. PG-290 : Fixed issue with PostgreSQL crashing after enabling debug log level and when pg_stat_monitor is enabled. PG-166 : Fixed issue with displaying the actual system time values instead of NULL PG-369 : Fixed issue with incorrect wal_bytes values for PostgreSQL 11 and 12 that caused Query Analytics failure in PMM by ignoring the WalUsage variable value for these versions.","title":"Bugs Fixed"},{"location":"RELEASE_NOTES.html#100-rc1","text":"","title":"1.0.0-rc.1"},{"location":"RELEASE_NOTES.html#improvements_1","text":"PG-165 : Recycle expired buckets PG-167 : Make SQL error codes readable by updating their data types PG-193 : Create a comment based tags to identify different parameters PG-199 : Documentation: Add the integration with PMM section in User Guide PG-210 : Documentation: Update column names per POstgreSQL version to match the upstream ones","title":"Improvements"},{"location":"RELEASE_NOTES.html#bugs-fixed_2","text":"PG-177 : Fixed the error in histogram ranges PG-214 : Fixed the issue with the display of the error message as part of the query column in pg_stat_monitor view PG-246 : Fixed the issue with significant CPU and memory resource usage when pg_stat_monitor.pgsm_enable_query_plan parameter is enabled PG-262 : Fixed the way the comments are extracted in pg_stat_monitor view PG-271 : Fixed the issue with enabling the pg_stat_monitor.pgsm_overflow_target configuration parameter. PG-272 : Fixed the server crash when calling the pg_stat_monitor_reset() function by using the correct PGSM_MAX_BUCKETS GUC as the limit to the loop","title":"Bugs Fixed"},{"location":"RELEASE_NOTES.html#rel0_9_0_stable","text":"","title":"REL0_9_0_STABLE"},{"location":"RELEASE_NOTES.html#improvements_2","text":"PG-186 : Add support to monitor query execution plan PG-147 : Store top query, instead of parent query. PG-188 : Added a new column to monitor the query state i.e PARSING/PLANNING/ACTIVE/FINISHED. PG-180 : Schema Qualified table/relations names. Regression Test Suite.","title":"Improvements"},{"location":"RELEASE_NOTES.html#bugs-fixed_3","text":"PG-189 : Regression crash in case of PostgreSQL 11. PG-187 : Compilation Error for PostgreSQL 11 and PostgreSQL 12. PG-186 : Add support to monitor query execution plan. PG-182 : Added a new option for the query buffer overflow. PG-181 : Segmentation fault in case of track_utility is ON. Some Code refactoring.","title":"Bugs Fixed"},{"location":"RELEASE_NOTES.html#rel0_8_1","text":"PG-147 : Stored Procedure Support add parentid to track caller. PG-177 : Error in Histogram ranges.","title":"REL0_8_1"},{"location":"RELEASE_NOTES.html#rel0_8_0_stable","text":"","title":"REL0_8_0_STABLE"},{"location":"RELEASE_NOTES.html#improvements_3","text":"Column userid (int64) was removed. Column dbid (int64) was removed. Column user (string) was added (replacement for userid). Column datname (string) was added (replacement for dbid). PG-176 : Extract fully qualified relations name. PG-175 : Only Superuser / Privileged user can view IP address. PG-174 : Code cleanup. PG-173 : Added new WAL usage statistics. PG-172 : Exponential histogram for time buckets. PG-164 : Query timing will be four decimal places instead of two. PG-167 : SQLERRCODE must be in readable format.","title":"Improvements"},{"location":"RELEASE_NOTES.html#bugs-fixed_4","text":"PG-169 : Fixing message buffer overrun and incorrect index access to fix the server crash. PG-168 : \u201ccalls\u201d and histogram parameter does not match. PG-166 : Display actual system time instead of null. PG-165 : Recycle expired buckets. PG-150 : Error while logging CMD Type like SELECT, UPDATE, INSERT, DELETE.","title":"Bugs Fixed"},{"location":"RELEASE_NOTES.html#rel0_7_2","text":"PG-165 : Recycle expired buckets. PG-164 : Query timing will be four decimal places instead of two. PG-161 : Miscellaneous small issues.","title":"REL0_7_2"},{"location":"RELEASE_NOTES.html#rel0_7_1","text":"PG-158 : Segmentation fault while using pgbench with clients > 1. PG-159 : Bucket start time (bucket_start_time) should be aligned with bucket_time. PG-160 : Integration with PGXN.","title":"REL0_7_1"},{"location":"RELEASE_NOTES.html#rel0_7_0_stable","text":"","title":"REL0_7_0_STABLE"},{"location":"RELEASE_NOTES.html#improvements_4","text":"PG-153 : Capture and record the application_name executing the query. PG-145 : Add a new View/Query to show the actual Database name and Username. PG-110 ; Aggregate the number of warnings. PG-109 : Log failed queries or queries with warning messages. PG-150 : Differentiate different types of queries such as SELECT, UPDATE, INSERT or DELETE.","title":"Improvements"},{"location":"RELEASE_NOTES.html#bugs-fixed_5","text":"PG-111 Show information for incomplete buckets. PG-148 Loss of query statistics/monitoring due to not enough \u201cslots\u201d available.","title":"Bugs Fixed"},{"location":"RELEASE_NOTES.html#v060","text":"Initial Release.","title":"v0.6.0"},{"location":"RELEASE_NOTES.html#master","text":"","title":"Master"},{"location":"RELEASE_NOTES.html#improvements_5","text":"PG-156 : Adding a placeholder replacement function for the prepared statement","title":"Improvements"},{"location":"USER_GUIDE.html","text":"User Guide \u00b6 Introduction Features Views Functions Configuration Usage examples Introduction \u00b6 This document describes the features, functions and configuration of the pg_stat_monitor extension and gives some usage examples. For how to install and set up pg_stat_monitor , see Setting up . Features \u00b6 The following are the key features of pg_stat_monitor: Time buckets , Table and index access statistics per statement , Query statistics: Query and client information , Query timing information , Query execution plan information , Use of actual data or parameters placeholders in queries , Query type filtering , Query metadata supporting Google\u2019s Sqlcommentor , Top query tracking , Relations - showing tables involved in a query, Monitoring of queries terminated with ERROR, WARNING and LOG error levels , Integration with Percona Monitoring and Management (PMM) tool , Histograms - visual representation of query performance. Time buckets \u00b6 Instead of supplying one set of ever-increasing counts, pg_stat_monitor computes stats for a configured number of time intervals; time buckets. This allows for much better data accuracy, especially in the case of high-resolution or unreliable networks. Starting with release 1.1.0, buckets have fixed and consistent time windows. This enables external applications such as PMM to easily consume and chart the statistics data. To make this happen, the bucket start time is rounded down to the nearest bucket time size. Note, however, that if you disable / enable the pg_stat_monitor at runtime, the first bucket may not contain all the data. For example, if pg_stat_monitor is enabled at 03:58:30, a 60-second bucket start time is set to 03:58:00 and this bucket may not contain the data for queries made between 03:58:00 and 03:58:30. To learn more about the bucket start time and size, see pg_stat_monitor.pgsm_bucket_time . Table and index access statistics per statement \u00b6 pg_stat_monitor collects the information about what tables were accessed by a statement. This allows you to identify all queries which access a given table easily. Query and client information \u00b6 pg_stat_monitor provides additional metrics for detailed analysis of query performance from various perspectives, including client connection details like user name, application name, IP address to name a few relevant columns. With this information, pg_stat_monitor enables users to track a query to the originating application. More details about the application or query may be incorporated in the SQL query in a Google\u2019s Sqlcommenter format. To see how it works, refer to the usage example Query timing information \u00b6 Understanding query execution time stats helps you identify what affects query performance and take measures to optimize it. pg_stat_monitor collects the total, min, max and average (mean) time it took to execute a particular query and provides this data in separate columns. See the Query timing information example for the sample output. Query execution plan information \u00b6 Every query has a plan that was constructed for its executing. Collecting the query plan information as well as monitoring query plan timing helps you understand how you can modify the query to optimize its execution. It also helps make communication about the query clearer when discussing query performance with other DBAs and application developers. See the Query execution plan example for the sample output. Use of actual data or parameters placeholders in queries \u00b6 You can select whether to see queries with parameters placeholders or actual query data. The benefit of having the full query example is in being able to run the EXPLAIN command on it to see how its execution was planned. As a result, you can modify the query to make it run better. Query type filtering \u00b6 pg_stat_monitor monitors queries per type ( SELECT , INSERT , UPDATE or DELETE ) and classifies them accordingly in the cmd_type column. This way you can separate the queries you are interested in and focus on identifying the issues and optimizing query performance. See the Query type filtering example for the sample output. Query metadata \u00b6 Google\u2019s Sqlcommenter is a useful tool that in a way bridges that gap between ORM libraries and understanding database performance. And pg_stat_monitor supports it. So, you can now put any key-value data (like what client executed a query or if it is testing vs production query) in the comments in /* \u2026 */ syntax in your SQL statements, and the information will be parsed by pg_stat_monitor and made available in the comments column in the pg_stat_monitor view. For details on the comments\u2019 syntax, see Sqlcommenter documentation . To see how it works, see the Query metadata example. Top query tracking \u00b6 Using functions is common. While running, functions can execute queries internally. pg_stat_monitor not only keeps track of all executed queries within a function, but also marks that function as top query. Top query indicates the main query. To illustrate, for the SELECT query that is invoked within a function, the top query is calling this function. This enables you to backtrack to the originating function and thus simplifies the tracking and analysis. Find more details in the usage example . Relations \u00b6 pg_stat_monitor provides the list of tables involved in the query in the relations column. This reduces time on identifying the tables and simplifies the analysis. To learn more, see the usage examples Monitoring queries terminated with ERROR, WARNING and LOG error levels \u00b6 Monitoring queries that terminate with ERROR, WARNING, LOG states can give useful information to debug an issue. Such messages have the error level ( elevel ), error code ( sqlcode ), and error message ( message ). pg_stat_monitor collects all this information and aggregates it so that you can measure performance for successful and failed queries separately, as well as understand why a particular query failed to execute successfully. Find details in the usage example Integration with PMM \u00b6 To timely identify and react on issues, performance should be automated and alerts should be sent when an issue occurs. There are many monitoring tools available for PostgreSQL, some of them (like Nagios) supporting custom metrics provided via extensions. Though you can integrate pg_stat_monitor with these tools, it natively supports integration with Percona Management and Monitoring (PMM). This integration allows you to enjoy all the features provided by both solutions: advanced statistics data provided by pg_stat_monitor and automated monitoring with data visualization on dashboards, security threat checks and alerting, available in PMM out of the box. To learn how to integrate pg_stat_monitor with PMM, see Configure pg_stat_monitor in PMM Histogram \u00b6 Histogram (the resp_calls parameter) provides a visual representation of query performance. With the help of the histogram function, you can view a timing/calling data histogram in response to an SQL query. Learn more about using histograms from the usage example . Views \u00b6 pg_stat_monitor provides the following views: * pg_stat_monitor is the view where statistics data is presented. * pg_stat_monitor_settings view shows available configuration options which you can change. pg_stat_monitor view \u00b6 The statistics gathered by the module are made available via the view named pg_stat_monitor . This view contains one row for each distinct combination of metrics and whether it is a top-level statement or not (up to the maximum number of distinct statements that the module can track). For details about available counters, refer to the pg_stat_monitor view reference . The following are the primary keys for pg_stat_monitor: bucket userid datname queryid client_ip planid application_name toplevel . NOTE : The toplevel key is considered starting with PostgreSQL 14 and above. For PostgreSQL 13 and earlier versions, the toplevel value is set to 1 by default, and thus, ignored. A new row is created for each key in the pg_stat_monitor view. pg_stat_monitor inherits the metrics available in pg_stat_statements , plus provides additional ones. See the pg_stat_monitor vs pg_stat_statements comparison for details. For security reasons, only superusers and members of the pg_read_all_stats role are allowed to see the SQL text and queryid of queries executed by other users. Other users can see the statistics, however, if the view has been installed in their database. pg_stat_monitor_settings view \u00b6 The pg_stat_monitor_settings view shows one row per pg_stat_monitor configuration parameter. It displays configuration parameter name, value, default value, description, minimum and maximum values, and whether a restart is required for a change in value to be effective. Functions \u00b6 pg_stat_monitor_reset() \u00b6 This function resets all the statistics and clears the view. Eventually, the function will delete all the previous data. pg_stat_monitor_version() \u00b6 This function provides the build version of pg_stat_monitor version. postgres=# select pg_stat_monitor_version(); pg_stat_monitor_version ------------------------- devel (1 row) histogram(bucket id, query id) \u00b6 It is used to generate the histogram, you can refer to histogram sections. Configuration \u00b6 Use the following command to view available configuration parameters in the pg_stat_monitor_settings view: SELECT * FROM pg_stat_monitor_settings ; To amend the pg_stat_monitor configuration, use the General Configuration Unit (GCU) system. Some configuration parameters require the server restart and should be set before the server startup. These must be set in the postgresql.conf file. Other parameters do not require server restart and can be set permanently either in the postgresql.conf or from the client ( psql ) using the SET or ALTER SYSTEM SET commands. The following table shows setup options for each configuration parameter and whether the server restart is required to apply the parameter\u2019s value: Parameter Name postgresql.conf SET ALTER SYSTEM SET server restart configuration reload pg_stat_monitor.pgsm_max pg_stat_monitor.pgsm_query_max_len pg_stat_monitor.pgsm_track_utility pg_stat_monitor.pgsm_normalized_query pg_stat_monitor.pgsm_max_buckets pg_stat_monitor.pgsm_bucket_time pg_stat_monitor.pgsm_histogram_min pg_stat_monitor.pgsm_histogram_max pg_stat_monitor.pgsm_histogram_buckets pg_stat_monitor.pgsm_query_shared_buffer pg_stat_monitor.pgsm_overflow_target pg_stat_monitor.pgsm_enable_query_plan pg_stat_monitor.track pg_stat_monitor.extract_comments pg_stat_monitor.pgsm_track_planning Parameters description: \u00b6 pg_stat_monitor.pgsm_max \u00b6 Values: - Min: 1 - Max: 1000 - Default: 100 This parameter defines the limit of shared memory (in MB) for pg_stat_monitor . This memory is used by buckets in a circular manner. The memory is divided between the buckets equally, at the start of the PostgreSQL. Requires the server restart. pg_stat_monitor.pgsm_query_max_len \u00b6 Values: - Min: 1024 - Max: 2147483647 - Default: 1024 Sets the maximum size of the query. This parameter can only be set at the start of PostgreSQL. For long queries, the query is truncated to that particular length. This is to avoid unnecessary usage of shared memory. Requires the server restart. pg_stat_monitor.pgsm_track_utility \u00b6 Type: boolean. Default: 1 This parameter controls whether utility commands are tracked by the module. Utility commands are all those other than SELECT , INSERT , UPDATE , and DELETE . pg_stat_monitor.pgsm_normalized_query \u00b6 Type: boolean. Default: 0 By default, the query shows the actual parameter instead of the placeholder. It is quite useful when users want to use that query and try to run that query to check the abnormalities. Users should be aware, however, that running queries with disabled normalization can expose some sensitive data. But in most cases users like the queries with a placeholder. This parameter is used to toggle between the two said options. pg_stat_monitor.pgsm_max_buckets \u00b6 Values: - Min: 1 - Max: 10 - Default: 10 pg_stat_monitor accumulates the information in the form of buckets. All the aggregated information is bucket based. This parameter is used to set the number of buckets the system can have. For example, if this parameter is set to 2, then the system will create two buckets. First, the system will add all the information into the first bucket. After its lifetime (defined in the pg_stat_monitor.pgsm_bucket_time parameter) expires, it will switch to the second bucket, reset all the counters and repeat the process. Requires the server restart. pg_stat_monitor.pgsm_bucket_time \u00b6 Values: - Min: 1 - Max: 2147483647 - Default: 60 This parameter sets the lifetime of the bucket. The system switches between buckets on the basis of pg_stat_monitor.pgsm_bucket_time . Starting with release 1.1.0, the behavior of setting the bucket start time has changed. Previously, the bucket start time was aligned with the time of the first query arrived to that bucket. Now the bucket start time is rounded down to the bucket time size. To illustrate, if the first query arrives to a 60 second bucket at 03:01:15, the bucket start time is set to 03:01:00. With this new behavior, buckets have now consistent time windows so that external applications such as PMM can easily consume the data in buckets. Note that if you disable / enable the pg_stat_monitor at runtime, the first bucket may not contain all the data. Thus, if pg_stat_monitor is enabled at 03:58:30, the bucket start time is set to 03:58:00 but it will not contain the data for queries made between 03:58:00 and 03:58:30. The parameter requires the server restart. pg_stat_monitor.pgsm_histogram_min \u00b6 Values: - Min: 0 - Max: 2147483647 - Default: 0 pg_stat_monitor also stores the execution time histogram. This parameter is used to set the lower bound of the histogram (in ms). Requires the server restart. pg_stat_monitor.pgsm_histogram_max \u00b6 Values: - Min: 10 - Max: 2147483647 - Default: 100000 This parameter sets the upper bound of the execution time histogram (in ms). Requires the server restart. pg_stat_monitor.pgsm_histogram_buckets \u00b6 Values: - Min: 2 - Max: 2147483647 - Default: 10 This parameter sets the maximum number of histogram buckets. Requires the server restart. pg_stat_monitor.pgsm_query_shared_buffer \u00b6 Values: - Min: 1 - Max: 10000 - Default: 20 This parameter defines the shared memory limit (in MB) allocated for a query tracked by pg_stat_monitor . Requires the server restart. pg_stat_monitor.pgsm_overflow_target \u00b6 Type: boolean. Default: 1 Sets the overflow target for the pg_stat_monitor . Requires the server restart. pg_stat_monitor.pgsm_enable_query_plan \u00b6 Type: boolean. Default: 1 Enables or disables query plan monitoring. When the pgsm_enable_query_plan is disabled (0), the query plan will not be captured by pg_stat_monitor . Enabling it may adversely affect the database performance. Requires the server restart. pg_stat_monitor.track \u00b6 This parameter controls which statements are tracked by pg_stat_monitor . Values: top : Default, track only top level queries (those issued directly by clients) and excludes listing nested statements (those called within a function). all : Track top along with sub/nested queries. As a result, some SELECT statement may be shown as duplicates. none : Disable query monitoring. The module is still loaded and is using shared memory, etc. It only silently ignores the capturing of data. pg_stat_monitor.extract_comments \u00b6 Type: boolean. Default: 0 This parameter controls whether to enable or disable extracting comments from queries. pg_stat_monitor.pgsm_track_planning \u00b6 Type: boolean. Default: 0 This parameter instructs pg_stat_monitor to monitor query planning statistics. Requires the server restart. Usage examples \u00b6 Note that the column names differ depending on the PostgreSQL version you are using. The following usage examples are provided for PostgreSQL version 13. For versions 11 and 12, please consult the pg_stat_monitor reference . Querying buckets \u00b6 postgres =# select bucket , bucket_start_time , query , calls from pg_stat_monitor order by bucket ; - [ RECORD 1 ] -----+------------------------------------------------------------------------------------ bucket | 0 bucket_start_time | 2021 - 10 - 22 11 : 10 : 00 query | select bucket , bucket_start_time , query , calls from pg_stat_monitor order by bucket ; calls | 1 The bucket parameter shows the number of a bucket for which a given record belongs. The bucket_start_time shows the start time of the bucket. query shows the actual query text. calls shows how many times a given query was called. Query information \u00b6 Example 1: Shows the usename, database name, unique queryid hash, query, and the total number of calls of that query. postgres =# SELECT userid , datname , queryid , substr ( query , 0 , 50 ) AS query , calls FROM pg_stat_monitor ; userid | datname | queryid | query | calls ---------+----------+------------------+---------------------------------------------------+------- vagrant | postgres | 939 C2F56E1F6A174 | END | 561 vagrant | postgres | 2 A4437C4905E0E23 | SELECT abalance FROM pgbench_accounts WHERE aid = | 561 vagrant | postgres | 4 EE9ED0CDF143477 | SELECT userid , datname , queryid , substr ( query , $ 1 | 1 vagrant | postgres | 8867 FEEB8A5388AC | vacuum pgbench_branches | 1 vagrant | postgres | 41 D1168FB0733CAB | select count ( * ) from pgbench_branches | 1 vagrant | postgres | E5A889A8FF37C2B1 | UPDATE pgbench_accounts SET abalance = abalance + | 561 vagrant | postgres | 4876 BBA9A8FCFCF9 | truncate pgbench_history | 1 vagrant | postgres | 22 B76AE84689E4DC | INSERT INTO pgbench_history ( tid , bid , aid , delta | 561 vagrant | postgres | F6DA9838660825CA | vacuum pgbench_tellers | 1 vagrant | postgres | 214646 CE6F9B1A85 | BEGIN | 561 vagrant | postgres | 27462943 E814C5B5 | UPDATE pgbench_tellers SET tbalance = tbalance + | 561 vagrant | postgres | 4 F66D46F3D4151E | SELECT userid , dbid , queryid , substr ( query , 0 , 50 | 1 vagrant | postgres | 6 A02C123488B95DB | UPDATE pgbench_branches SET bbalance = bbalance + | 561 ( 13 rows ) Example 2: Shows the connected application details. postgres =# SELECT application_name , client_ip , substr ( query , 0 , 100 ) as query FROM pg_stat_monitor ; application_name | client_ip | query ------------------+-----------+----------------------------------------------------------------------------------------------------- pgbench | 127 . 0 . 0 . 1 | truncate pgbench_history pgbench | 127 . 0 . 0 . 1 | SELECT abalance FROM pgbench_accounts WHERE aid = $ 1 pgbench | 127 . 0 . 0 . 1 | UPDATE pgbench_accounts SET abalance = abalance + $ 1 WHERE aid = $ 2 pgbench | 127 . 0 . 0 . 1 | BEGIN ; pgbench | 127 . 0 . 0 . 1 | INSERT INTO pgbench_history ( tid , bid , aid , delta , mtime ) VALUES ( $ 1 , $ 2 , $ 3 , $ 4 , CURRENT_TIMESTAMP pgbench | 127 . 0 . 0 . 1 | END ; pgbench | 127 . 0 . 0 . 1 | vacuum pgbench_branches pgbench | 127 . 0 . 0 . 1 | UPDATE pgbench_tellers SET tbalance = tbalance + $ 1 WHERE tid = $ 2 pgbench | 127 . 0 . 0 . 1 | vacuum pgbench_tellers pgbench | 127 . 0 . 0 . 1 | UPDATE pgbench_branches SET bbalance = bbalance + $ 1 WHERE bid = $ 2 pgbench | 127 . 0 . 0 . 1 | select o . n , p . partstrat , pg_catalog . count ( i . inhparent ) from pg_catalog . pg_class as c join pg_catalo psql | 127 . 0 . 0 . 1 | SELECT application_name , client_ip , substr ( query , $ 1 , $ 2 ) as query FROM pg_stat_monitor pgbench | 127 . 0 . 0 . 1 | select count ( * ) from pgbench_branches ( 13 rows ) Query timing information \u00b6 SELECT userid , total_time , min_time , max_time , mean_time , query FROM pg_stat_monitor ; userid | total_time | min_time | max_time | mean_time | query --------+--------------------+--------------------+--------------------+--------------------+------------------------------------------------------------------ 10 | 0 . 14 | 0 . 14 | 0 . 14 | 0 . 14 | select * from pg_stat_monitor_reset () 10 | 0 . 19 | 0 . 19 | 0 . 19 | 0 . 19 | select userid , dbid , queryid , query from pg_stat_monitor 10 | 0 . 30 | 0 . 13 | 0 . 16 | 0 . 15 | select bucket , bucket_start_time , query from pg_stat_monitor 10 | 0 . 29 | 0 . 29 | 0 . 29 | 0 . 29 | select userid , dbid , queryid , query , calls from pg_stat_monitor 10 | 11277 . 79 | 11277 . 79 | 11277 . 79 | Query execution plan \u00b6 postgres =# SELECT substr ( query , 0 , 50 ), query_plan from pg_stat_monitor limit 10 ; substr | query_plan ---------------------------------------------------+--------------------------------------------------------------------------------------------------------------- select o . n , p . partstrat , pg_catalog . count ( i . inhpa | Limit + | -> GroupAggregate + | Group Key : ( array_position ( current_schemas ( true ), n . nspname )), p . partstrat + | -> Sort + | Sort Key : ( array_position ( current_schemas ( true ), n . nspname )), p . partstrat + | -> Nested Loop Left Join + | -> Nested Loop Left Join + | -> Nested Loop + | Join Filter : ( c . relnamespace = n . oid ) + | -> Index Scan using pg_class_relname_nsp_index on pg_class c + | Index Cond : ( relname = 'pgbench_accounts' :: name ) + | -> Seq Scan on pg_namespace n + | Filter : ( array_position ( current_schemas ( true ), nspname ) IS NOT NULL ) + | -> Index Scan using pg_partitioned_table_partrelid_index on pg_partitioned_table p + | Index Cond : ( partrelid = c . oid ) + | -> Bitmap Heap Scan on pg_inherits i + | R SELECT abalance FROM pgbench_accounts WHERE aid = | Index Scan using pgbench_accounts_pkey on pgbench_accounts + | Index Cond : ( aid = 102232 ) BEGIN ; | END ; | SELECT substr ( query , $ 1 , $ 2 ), query_plan from pg_st | SELECT substr ( query , $ 1 , $ 2 ), calls , planid , query_pl | Limit + | -> Subquery Scan on pg_stat_monitor + | -> Result + | -> Sort + | Sort Key : p . bucket_start_time + | -> Hash Join + | Hash Cond : ( p . dbid = d . oid ) + | -> Function Scan on pg_stat_monitor_internal p + | -> Hash + | -> Seq Scan on pg_database d + | SubPlan 1 + | -> Function Scan on pg_stat_monitor_internal s + | Filter : ( queryid = p . top_queryid ) select count ( * ) from pgbench_branches | Aggregate + | -> Seq Scan on pgbench_branches UPDATE pgbench_tellers SET tbalance = tbalance + | vacuum pgbench_tellers | UPDATE pgbench_accounts SET abalance = abalance + | ( 10 rows ) The plan column does not contain costing, width and other values. This is an expected behavior as each row is an accumulation of statistics based on plan and amongst other key columns. Plan is only available when the pgsm_enable_query_plan configuration parameter is enabled. Query type filtering \u00b6 pg_stat_monitor monitors queries per type (SELECT, INSERT, UPDATE OR DELETE) and classifies them accordingly in the cmd_type column thus reducing your efforts. postgres =# SELECT bucket , substr ( query , 0 , 50 ) AS query , cmd_type FROM pg_stat_monitor WHERE elevel = 0 ; bucket | query | cmd_type --------+---------------------------------------------------+---------- 4 | END | 4 | SELECT abalance FROM pgbench_accounts WHERE aid = | SELECT 4 | vacuum pgbench_branches | 4 | select count ( * ) from pgbench_branches | SELECT 4 | UPDATE pgbench_accounts SET abalance = abalance + | UPDATE 4 | truncate pgbench_history | 4 | INSERT INTO pgbench_history ( tid , bid , aid , delta | INSERT 5 | SELECT relations query FROM pg_stat_monitor | SELECT 9 | SELECT bucket , substr ( query , $ 1 , $ 2 ) AS query , cmd | 4 | vacuum pgbench_tellers | 4 | BEGIN | 5 | SELECT relations , query FROM pg_stat_monitor | SELECT 4 | UPDATE pgbench_tellers SET tbalance = tbalance + | UPDATE 4 | UPDATE pgbench_branches SET bbalance = bbalance + | UPDATE ( 14 rows ) Query metadata \u00b6 The comments column contains any text wrapped in \u201c/*\u201d and \u201c*/\u201d comment tags. The pg_stat_monitor extension picks up these comments and makes them available in the comments column. Please note that only the latest comment value is preserved per row. The comments may be put in any format that can be parsed by a tool. CREATE EXTENSION hstore ; CREATE FUNCTION text_to_hstore ( s text ) RETURNS hstore AS $$ BEGIN RETURN hstore ( s :: text []); EXCEPTION WHEN OTHERS THEN RETURN NULL ; END ; $$ LANGUAGE plpgsql STRICT ; postgres =# SELECT 1 AS num /* { \"application\", java_app, \"real_ip\", 192.168.1.1} */ ; num ----- 1 ( 1 row ) postgres =# SELECT 1 AS num1 , 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ ; num1 | num2 ------+------ 1 | 2 ( 1 row ) postgres =# SELECT 1 AS num1 , 2 AS num2 , 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ ; num1 | num2 | num3 ------+------+------ 1 | 2 | 3 ( 1 row ) postgres =# SELECT 1 AS num1 , 2 AS num2 , 3 AS num3 , 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ ; num1 | num2 | num3 | num4 ------+------+------+------ 1 | 2 | 3 | 4 ( 1 row ) postgres =# select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; query | comments_tags ---------------------------------------------------------------------------------------------------------------+----------------------------------------------------- SELECT $ 1 AS num /* { \"application\", psql_app, \"real_ip\", 192.168.1.3) */ | \"real_ip\" => \"192.168.1.1\" , \"application\" => \"java_app\" SELECT pg_stat_monitor_reset (); | select query , comments , text_to_hstore ( comments ) from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ | \"real_ip\" => \"192.168.1.3\" , \"application\" => \"java_app\" select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ | \"real_ip\" => \"192.168.1.2\" , \"application\" => \"java_app\" SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 , $ 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ | \"real_ip\" => \"192.168.1.3\" , \"application\" => \"psql_app\" ( 7 rows ) postgres =# select query , text_to_hstore ( comments ) -> 'application' as application_name from pg_stat_monitor ; query | application_name ---------------------------------------------------------------------------------------------------------------+---------- SELECT $ 1 AS num /* { \"application\", psql_app, \"real_ip\", 192.168.1.3) */ | java_app SELECT pg_stat_monitor_reset (); | select query , text_to_hstore ( comments ) -> \"real_ip\" as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> $ 1 from pg_stat_monitor | select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> \"application\" as comments_tags from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ | java_app SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ | java_app select query , comments , text_to_hstore ( comments ) from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 , $ 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ | psql_app ( 10 rows ) postgres =# select query , text_to_hstore ( comments ) -> 'real_ip' as real_ip from pg_stat_monitor ; query | real_ip ---------------------------------------------------------------------------------------------------------------+------------- SELECT $ 1 AS num /* { \"application\", psql_app, \"real_ip\", 192.168.1.3) */ | 192 . 168 . 1 . 1 SELECT pg_stat_monitor_reset (); | select query , text_to_hstore ( comments ) -> \"real_ip\" as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> $ 1 from pg_stat_monitor | select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> \"application\" as comments_tags from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ | 192 . 168 . 1 . 2 SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ | 192 . 168 . 1 . 3 select query , comments , text_to_hstore ( comments ) from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 , $ 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ | 192 . 168 . 1 . 3 ( 10 rows ) Top query tracking \u00b6 In the following example we create a function add2 that adds one parameter value to another one and call this function to calculate 1+2. CREATE OR REPLACE function add2 ( int , int ) RETURNS int as $$ BEGIN return ( select $ 1 + $ 2 ); END ; $$ language plpgsql ; SELECT add2 ( 1 , 2 ); add2 ----- 3 ( 1 row ) The `` pg_stat_monitor `` view shows all executed queries and shows the very first query in a row - calling the ` add2 ` function . postgres =# SELECT queryid , top_queryid , query , top_query FROM pg_stat_monitor ; queryid | top_queryid | query . | top_query ------------------+------------------+-------------------------------------------------------------------------+------------------- 3408 CA84B2353094 | | select add2 ( $ 1 , $ 2 ) | 762 B99349F6C7F31 | 3408 CA84B2353094 | SELECT ( select $ 1 + $ 2 ) | select add2 ( $ 1 , $ 2 ) ( 2 rows ) Relations \u00b6 Example 1: List all the table names involved in the query. postgres =# SELECT relations , query FROM pg_stat_monitor ; relations | query -------------------------------+------------------------------------------------------------------------------------------------------ | END { public . pgbench_accounts } | SELECT abalance FROM pgbench_accounts WHERE aid = $ 1 | vacuum pgbench_branches { public . pgbench_branches } | select count ( * ) from pgbench_branches { public . pgbench_accounts } | UPDATE pgbench_accounts SET abalance = abalance + $ 1 WHERE aid = $ 2 | truncate pgbench_history { public . pgbench_history } | INSERT INTO pgbench_history ( tid , bid , aid , delta , mtime ) VALUES ( $ 1 , $ 2 , $ 3 , $ 4 , CURRENT_TIMESTAMP ) { public . pg_stat_monitor , pg_catalog . pg_database } | SELECT relations query FROM pg_stat_monitor | vacuum pgbench_tellers | BEGIN { public . pgbench_tellers } | UPDATE pgbench_tellers SET tbalance = tbalance + $ 1 WHERE tid = $ 2 { public . pgbench_branches } | UPDATE pgbench_branches SET bbalance = bbalance + $ 1 WHERE bid = $ 2 ( 12 rows ) Example 2: List all the views and the name of the table in the view. Here we have a view \u201ctest_view\u201d \\ d + test_view View \"public.test_view\" Column | Type | Collation | Nullable | Default | Storage | Description --------+---------+-----------+----------+---------+---------+------------- foo_a | integer | | | | plain | bar_a | integer | | | | plain | View definition : SELECT f . a AS foo_a , b . a AS bar_a FROM foo f , bar b ; Now when we query the pg_stat_monitor , it will show the view name and also all the table names in the view. Note that the view name is followed by an asterisk (*). SELECT relations , query FROM pg_stat_monitor ; relations | query ---------------------+---------------------------------------------------- { test_view * , foo , bar } | select * from test_view { foo , bar } | select * from foo , bar ( 2 rows ) Queries terminated with errors \u00b6 SELECT substr ( query , 0 , 50 ) AS query , decode_error_level ( elevel ) AS elevel , sqlcode , calls , substr ( message , 0 , 50 ) message FROM pg_stat_monitor ; query | elevel | sqlcode | calls | message ---------------------------------------------------+--------+---------+-------+--------------------------------------------------- select substr ( query , $ 1 , $ 2 ) as query , decode_error | | 0 | 1 | select bucket , substr ( query , $ 1 , $ 2 ), decode_error_le | | 0 | 3 | | LOG | 0 | 1 | database system is ready to accept connections select 1 / 0 ; | ERROR | 130 | 1 | division by zero | LOG | 0 | 1 | database system was shut down at 2020 - 11 - 11 11 : 37 select $ 1 / $ 2 | | 0 | 1 | ( 6 rows ) 11277 . 79 | SELECT * FROM foo Histogram \u00b6 Histogram (the resp_calls parameter) provides a visual representation of query performance. With the help of the histogram function, you can view a timing/calling data histogram in response to a SQL query. SELECT resp_calls , query FROM pg_stat_monitor ; resp_calls | query --------------------------------------------------+---------------------------------------------- { 1 , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" } | select client_ip , query from pg_stat_monitor { 3 , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 1\" } | select * from pg_stat_monitor_reset () { 3 , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 1\" } | SELECT * FROM foo postgres =# SELECT * FROM histogram ( 0 , 'F44CD1B4B33A47AF' ) AS a ( range TEXT , freq INT , bar TEXT ); range | freq | bar --------------------+------+-------------------------------- ( 0 - 3 ) } | 2 | \u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0 ( 3 - 10 ) } | 0 | ( 10 - 31 ) } | 1 | \u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0 ( 31 - 100 ) } | 0 | ( 100 - 316 ) } | 0 | ( 316 - 1000 ) } | 0 | ( 1000 - 3162 ) } | 0 | ( 3162 - 10000 ) } | 0 | ( 10000 - 31622 ) } | 0 | ( 31622 - 100000 ) } | 0 | ( 10 rows ) There are 10 time based buckets of the time generated automatically based on total buckets in the field resp_calls . The value in the field shows how many queries run in that period of time.","title":"User guide"},{"location":"USER_GUIDE.html#user-guide","text":"Introduction Features Views Functions Configuration Usage examples","title":"User Guide"},{"location":"USER_GUIDE.html#introduction","text":"This document describes the features, functions and configuration of the pg_stat_monitor extension and gives some usage examples. For how to install and set up pg_stat_monitor , see Setting up .","title":"Introduction"},{"location":"USER_GUIDE.html#features","text":"The following are the key features of pg_stat_monitor: Time buckets , Table and index access statistics per statement , Query statistics: Query and client information , Query timing information , Query execution plan information , Use of actual data or parameters placeholders in queries , Query type filtering , Query metadata supporting Google\u2019s Sqlcommentor , Top query tracking , Relations - showing tables involved in a query, Monitoring of queries terminated with ERROR, WARNING and LOG error levels , Integration with Percona Monitoring and Management (PMM) tool , Histograms - visual representation of query performance.","title":"Features"},{"location":"USER_GUIDE.html#time-buckets","text":"Instead of supplying one set of ever-increasing counts, pg_stat_monitor computes stats for a configured number of time intervals; time buckets. This allows for much better data accuracy, especially in the case of high-resolution or unreliable networks. Starting with release 1.1.0, buckets have fixed and consistent time windows. This enables external applications such as PMM to easily consume and chart the statistics data. To make this happen, the bucket start time is rounded down to the nearest bucket time size. Note, however, that if you disable / enable the pg_stat_monitor at runtime, the first bucket may not contain all the data. For example, if pg_stat_monitor is enabled at 03:58:30, a 60-second bucket start time is set to 03:58:00 and this bucket may not contain the data for queries made between 03:58:00 and 03:58:30. To learn more about the bucket start time and size, see pg_stat_monitor.pgsm_bucket_time .","title":"Time buckets"},{"location":"USER_GUIDE.html#table-and-index-access-statistics-per-statement","text":"pg_stat_monitor collects the information about what tables were accessed by a statement. This allows you to identify all queries which access a given table easily.","title":"Table and index access statistics per statement"},{"location":"USER_GUIDE.html#query-and-client-information","text":"pg_stat_monitor provides additional metrics for detailed analysis of query performance from various perspectives, including client connection details like user name, application name, IP address to name a few relevant columns. With this information, pg_stat_monitor enables users to track a query to the originating application. More details about the application or query may be incorporated in the SQL query in a Google\u2019s Sqlcommenter format. To see how it works, refer to the usage example","title":"Query and client information"},{"location":"USER_GUIDE.html#query-timing-information","text":"Understanding query execution time stats helps you identify what affects query performance and take measures to optimize it. pg_stat_monitor collects the total, min, max and average (mean) time it took to execute a particular query and provides this data in separate columns. See the Query timing information example for the sample output.","title":"Query timing information"},{"location":"USER_GUIDE.html#query-execution-plan-information","text":"Every query has a plan that was constructed for its executing. Collecting the query plan information as well as monitoring query plan timing helps you understand how you can modify the query to optimize its execution. It also helps make communication about the query clearer when discussing query performance with other DBAs and application developers. See the Query execution plan example for the sample output.","title":"Query execution plan information"},{"location":"USER_GUIDE.html#use-of-actual-data-or-parameters-placeholders-in-queries","text":"You can select whether to see queries with parameters placeholders or actual query data. The benefit of having the full query example is in being able to run the EXPLAIN command on it to see how its execution was planned. As a result, you can modify the query to make it run better.","title":"Use of actual data or parameters placeholders in queries"},{"location":"USER_GUIDE.html#query-type-filtering","text":"pg_stat_monitor monitors queries per type ( SELECT , INSERT , UPDATE or DELETE ) and classifies them accordingly in the cmd_type column. This way you can separate the queries you are interested in and focus on identifying the issues and optimizing query performance. See the Query type filtering example for the sample output.","title":"Query type filtering"},{"location":"USER_GUIDE.html#query-metadata","text":"Google\u2019s Sqlcommenter is a useful tool that in a way bridges that gap between ORM libraries and understanding database performance. And pg_stat_monitor supports it. So, you can now put any key-value data (like what client executed a query or if it is testing vs production query) in the comments in /* \u2026 */ syntax in your SQL statements, and the information will be parsed by pg_stat_monitor and made available in the comments column in the pg_stat_monitor view. For details on the comments\u2019 syntax, see Sqlcommenter documentation . To see how it works, see the Query metadata example.","title":"Query metadata"},{"location":"USER_GUIDE.html#top-query-tracking","text":"Using functions is common. While running, functions can execute queries internally. pg_stat_monitor not only keeps track of all executed queries within a function, but also marks that function as top query. Top query indicates the main query. To illustrate, for the SELECT query that is invoked within a function, the top query is calling this function. This enables you to backtrack to the originating function and thus simplifies the tracking and analysis. Find more details in the usage example .","title":"Top query tracking"},{"location":"USER_GUIDE.html#relations","text":"pg_stat_monitor provides the list of tables involved in the query in the relations column. This reduces time on identifying the tables and simplifies the analysis. To learn more, see the usage examples","title":"Relations"},{"location":"USER_GUIDE.html#monitoring-queries-terminated-with-error-warning-and-log-error-levels","text":"Monitoring queries that terminate with ERROR, WARNING, LOG states can give useful information to debug an issue. Such messages have the error level ( elevel ), error code ( sqlcode ), and error message ( message ). pg_stat_monitor collects all this information and aggregates it so that you can measure performance for successful and failed queries separately, as well as understand why a particular query failed to execute successfully. Find details in the usage example","title":"Monitoring queries terminated with ERROR, WARNING and LOG error levels"},{"location":"USER_GUIDE.html#integration-with-pmm","text":"To timely identify and react on issues, performance should be automated and alerts should be sent when an issue occurs. There are many monitoring tools available for PostgreSQL, some of them (like Nagios) supporting custom metrics provided via extensions. Though you can integrate pg_stat_monitor with these tools, it natively supports integration with Percona Management and Monitoring (PMM). This integration allows you to enjoy all the features provided by both solutions: advanced statistics data provided by pg_stat_monitor and automated monitoring with data visualization on dashboards, security threat checks and alerting, available in PMM out of the box. To learn how to integrate pg_stat_monitor with PMM, see Configure pg_stat_monitor in PMM","title":"Integration with PMM"},{"location":"USER_GUIDE.html#histogram","text":"Histogram (the resp_calls parameter) provides a visual representation of query performance. With the help of the histogram function, you can view a timing/calling data histogram in response to an SQL query. Learn more about using histograms from the usage example .","title":"Histogram"},{"location":"USER_GUIDE.html#views","text":"pg_stat_monitor provides the following views: * pg_stat_monitor is the view where statistics data is presented. * pg_stat_monitor_settings view shows available configuration options which you can change.","title":"Views"},{"location":"USER_GUIDE.html#pg_stat_monitor-view","text":"The statistics gathered by the module are made available via the view named pg_stat_monitor . This view contains one row for each distinct combination of metrics and whether it is a top-level statement or not (up to the maximum number of distinct statements that the module can track). For details about available counters, refer to the pg_stat_monitor view reference . The following are the primary keys for pg_stat_monitor: bucket userid datname queryid client_ip planid application_name toplevel . NOTE : The toplevel key is considered starting with PostgreSQL 14 and above. For PostgreSQL 13 and earlier versions, the toplevel value is set to 1 by default, and thus, ignored. A new row is created for each key in the pg_stat_monitor view. pg_stat_monitor inherits the metrics available in pg_stat_statements , plus provides additional ones. See the pg_stat_monitor vs pg_stat_statements comparison for details. For security reasons, only superusers and members of the pg_read_all_stats role are allowed to see the SQL text and queryid of queries executed by other users. Other users can see the statistics, however, if the view has been installed in their database.","title":"pg_stat_monitor view"},{"location":"USER_GUIDE.html#pg_stat_monitor_settings-view","text":"The pg_stat_monitor_settings view shows one row per pg_stat_monitor configuration parameter. It displays configuration parameter name, value, default value, description, minimum and maximum values, and whether a restart is required for a change in value to be effective.","title":"pg_stat_monitor_settings view"},{"location":"USER_GUIDE.html#functions","text":"","title":"Functions"},{"location":"USER_GUIDE.html#pg_stat_monitor_reset","text":"This function resets all the statistics and clears the view. Eventually, the function will delete all the previous data.","title":"pg_stat_monitor_reset()"},{"location":"USER_GUIDE.html#pg_stat_monitor_version","text":"This function provides the build version of pg_stat_monitor version. postgres=# select pg_stat_monitor_version(); pg_stat_monitor_version ------------------------- devel (1 row)","title":"pg_stat_monitor_version()"},{"location":"USER_GUIDE.html#histogrambucket-id-query-id","text":"It is used to generate the histogram, you can refer to histogram sections.","title":"histogram(bucket id, query id)"},{"location":"USER_GUIDE.html#configuration","text":"Use the following command to view available configuration parameters in the pg_stat_monitor_settings view: SELECT * FROM pg_stat_monitor_settings ; To amend the pg_stat_monitor configuration, use the General Configuration Unit (GCU) system. Some configuration parameters require the server restart and should be set before the server startup. These must be set in the postgresql.conf file. Other parameters do not require server restart and can be set permanently either in the postgresql.conf or from the client ( psql ) using the SET or ALTER SYSTEM SET commands. The following table shows setup options for each configuration parameter and whether the server restart is required to apply the parameter\u2019s value: Parameter Name postgresql.conf SET ALTER SYSTEM SET server restart configuration reload pg_stat_monitor.pgsm_max pg_stat_monitor.pgsm_query_max_len pg_stat_monitor.pgsm_track_utility pg_stat_monitor.pgsm_normalized_query pg_stat_monitor.pgsm_max_buckets pg_stat_monitor.pgsm_bucket_time pg_stat_monitor.pgsm_histogram_min pg_stat_monitor.pgsm_histogram_max pg_stat_monitor.pgsm_histogram_buckets pg_stat_monitor.pgsm_query_shared_buffer pg_stat_monitor.pgsm_overflow_target pg_stat_monitor.pgsm_enable_query_plan pg_stat_monitor.track pg_stat_monitor.extract_comments pg_stat_monitor.pgsm_track_planning","title":"Configuration"},{"location":"USER_GUIDE.html#parameters-description","text":"","title":"Parameters description:"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_max","text":"Values: - Min: 1 - Max: 1000 - Default: 100 This parameter defines the limit of shared memory (in MB) for pg_stat_monitor . This memory is used by buckets in a circular manner. The memory is divided between the buckets equally, at the start of the PostgreSQL. Requires the server restart.","title":"pg_stat_monitor.pgsm_max"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_query_max_len","text":"Values: - Min: 1024 - Max: 2147483647 - Default: 1024 Sets the maximum size of the query. This parameter can only be set at the start of PostgreSQL. For long queries, the query is truncated to that particular length. This is to avoid unnecessary usage of shared memory. Requires the server restart.","title":"pg_stat_monitor.pgsm_query_max_len"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_track_utility","text":"Type: boolean. Default: 1 This parameter controls whether utility commands are tracked by the module. Utility commands are all those other than SELECT , INSERT , UPDATE , and DELETE .","title":"pg_stat_monitor.pgsm_track_utility"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_normalized_query","text":"Type: boolean. Default: 0 By default, the query shows the actual parameter instead of the placeholder. It is quite useful when users want to use that query and try to run that query to check the abnormalities. Users should be aware, however, that running queries with disabled normalization can expose some sensitive data. But in most cases users like the queries with a placeholder. This parameter is used to toggle between the two said options.","title":"pg_stat_monitor.pgsm_normalized_query"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_max_buckets","text":"Values: - Min: 1 - Max: 10 - Default: 10 pg_stat_monitor accumulates the information in the form of buckets. All the aggregated information is bucket based. This parameter is used to set the number of buckets the system can have. For example, if this parameter is set to 2, then the system will create two buckets. First, the system will add all the information into the first bucket. After its lifetime (defined in the pg_stat_monitor.pgsm_bucket_time parameter) expires, it will switch to the second bucket, reset all the counters and repeat the process. Requires the server restart.","title":"pg_stat_monitor.pgsm_max_buckets"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_bucket_time","text":"Values: - Min: 1 - Max: 2147483647 - Default: 60 This parameter sets the lifetime of the bucket. The system switches between buckets on the basis of pg_stat_monitor.pgsm_bucket_time . Starting with release 1.1.0, the behavior of setting the bucket start time has changed. Previously, the bucket start time was aligned with the time of the first query arrived to that bucket. Now the bucket start time is rounded down to the bucket time size. To illustrate, if the first query arrives to a 60 second bucket at 03:01:15, the bucket start time is set to 03:01:00. With this new behavior, buckets have now consistent time windows so that external applications such as PMM can easily consume the data in buckets. Note that if you disable / enable the pg_stat_monitor at runtime, the first bucket may not contain all the data. Thus, if pg_stat_monitor is enabled at 03:58:30, the bucket start time is set to 03:58:00 but it will not contain the data for queries made between 03:58:00 and 03:58:30. The parameter requires the server restart.","title":"pg_stat_monitor.pgsm_bucket_time"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_histogram_min","text":"Values: - Min: 0 - Max: 2147483647 - Default: 0 pg_stat_monitor also stores the execution time histogram. This parameter is used to set the lower bound of the histogram (in ms). Requires the server restart.","title":"pg_stat_monitor.pgsm_histogram_min"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_histogram_max","text":"Values: - Min: 10 - Max: 2147483647 - Default: 100000 This parameter sets the upper bound of the execution time histogram (in ms). Requires the server restart.","title":"pg_stat_monitor.pgsm_histogram_max"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_histogram_buckets","text":"Values: - Min: 2 - Max: 2147483647 - Default: 10 This parameter sets the maximum number of histogram buckets. Requires the server restart.","title":"pg_stat_monitor.pgsm_histogram_buckets"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_query_shared_buffer","text":"Values: - Min: 1 - Max: 10000 - Default: 20 This parameter defines the shared memory limit (in MB) allocated for a query tracked by pg_stat_monitor . Requires the server restart.","title":"pg_stat_monitor.pgsm_query_shared_buffer"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_overflow_target","text":"Type: boolean. Default: 1 Sets the overflow target for the pg_stat_monitor . Requires the server restart.","title":"pg_stat_monitor.pgsm_overflow_target"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_enable_query_plan","text":"Type: boolean. Default: 1 Enables or disables query plan monitoring. When the pgsm_enable_query_plan is disabled (0), the query plan will not be captured by pg_stat_monitor . Enabling it may adversely affect the database performance. Requires the server restart.","title":"pg_stat_monitor.pgsm_enable_query_plan"},{"location":"USER_GUIDE.html#pg_stat_monitortrack","text":"This parameter controls which statements are tracked by pg_stat_monitor . Values: top : Default, track only top level queries (those issued directly by clients) and excludes listing nested statements (those called within a function). all : Track top along with sub/nested queries. As a result, some SELECT statement may be shown as duplicates. none : Disable query monitoring. The module is still loaded and is using shared memory, etc. It only silently ignores the capturing of data.","title":"pg_stat_monitor.track"},{"location":"USER_GUIDE.html#pg_stat_monitorextract_comments","text":"Type: boolean. Default: 0 This parameter controls whether to enable or disable extracting comments from queries.","title":"pg_stat_monitor.extract_comments"},{"location":"USER_GUIDE.html#pg_stat_monitorpgsm_track_planning","text":"Type: boolean. Default: 0 This parameter instructs pg_stat_monitor to monitor query planning statistics. Requires the server restart.","title":"pg_stat_monitor.pgsm_track_planning"},{"location":"USER_GUIDE.html#usage-examples","text":"Note that the column names differ depending on the PostgreSQL version you are using. The following usage examples are provided for PostgreSQL version 13. For versions 11 and 12, please consult the pg_stat_monitor reference .","title":"Usage examples"},{"location":"USER_GUIDE.html#querying-buckets","text":"postgres =# select bucket , bucket_start_time , query , calls from pg_stat_monitor order by bucket ; - [ RECORD 1 ] -----+------------------------------------------------------------------------------------ bucket | 0 bucket_start_time | 2021 - 10 - 22 11 : 10 : 00 query | select bucket , bucket_start_time , query , calls from pg_stat_monitor order by bucket ; calls | 1 The bucket parameter shows the number of a bucket for which a given record belongs. The bucket_start_time shows the start time of the bucket. query shows the actual query text. calls shows how many times a given query was called.","title":"Querying buckets"},{"location":"USER_GUIDE.html#query-information","text":"Example 1: Shows the usename, database name, unique queryid hash, query, and the total number of calls of that query. postgres =# SELECT userid , datname , queryid , substr ( query , 0 , 50 ) AS query , calls FROM pg_stat_monitor ; userid | datname | queryid | query | calls ---------+----------+------------------+---------------------------------------------------+------- vagrant | postgres | 939 C2F56E1F6A174 | END | 561 vagrant | postgres | 2 A4437C4905E0E23 | SELECT abalance FROM pgbench_accounts WHERE aid = | 561 vagrant | postgres | 4 EE9ED0CDF143477 | SELECT userid , datname , queryid , substr ( query , $ 1 | 1 vagrant | postgres | 8867 FEEB8A5388AC | vacuum pgbench_branches | 1 vagrant | postgres | 41 D1168FB0733CAB | select count ( * ) from pgbench_branches | 1 vagrant | postgres | E5A889A8FF37C2B1 | UPDATE pgbench_accounts SET abalance = abalance + | 561 vagrant | postgres | 4876 BBA9A8FCFCF9 | truncate pgbench_history | 1 vagrant | postgres | 22 B76AE84689E4DC | INSERT INTO pgbench_history ( tid , bid , aid , delta | 561 vagrant | postgres | F6DA9838660825CA | vacuum pgbench_tellers | 1 vagrant | postgres | 214646 CE6F9B1A85 | BEGIN | 561 vagrant | postgres | 27462943 E814C5B5 | UPDATE pgbench_tellers SET tbalance = tbalance + | 561 vagrant | postgres | 4 F66D46F3D4151E | SELECT userid , dbid , queryid , substr ( query , 0 , 50 | 1 vagrant | postgres | 6 A02C123488B95DB | UPDATE pgbench_branches SET bbalance = bbalance + | 561 ( 13 rows ) Example 2: Shows the connected application details. postgres =# SELECT application_name , client_ip , substr ( query , 0 , 100 ) as query FROM pg_stat_monitor ; application_name | client_ip | query ------------------+-----------+----------------------------------------------------------------------------------------------------- pgbench | 127 . 0 . 0 . 1 | truncate pgbench_history pgbench | 127 . 0 . 0 . 1 | SELECT abalance FROM pgbench_accounts WHERE aid = $ 1 pgbench | 127 . 0 . 0 . 1 | UPDATE pgbench_accounts SET abalance = abalance + $ 1 WHERE aid = $ 2 pgbench | 127 . 0 . 0 . 1 | BEGIN ; pgbench | 127 . 0 . 0 . 1 | INSERT INTO pgbench_history ( tid , bid , aid , delta , mtime ) VALUES ( $ 1 , $ 2 , $ 3 , $ 4 , CURRENT_TIMESTAMP pgbench | 127 . 0 . 0 . 1 | END ; pgbench | 127 . 0 . 0 . 1 | vacuum pgbench_branches pgbench | 127 . 0 . 0 . 1 | UPDATE pgbench_tellers SET tbalance = tbalance + $ 1 WHERE tid = $ 2 pgbench | 127 . 0 . 0 . 1 | vacuum pgbench_tellers pgbench | 127 . 0 . 0 . 1 | UPDATE pgbench_branches SET bbalance = bbalance + $ 1 WHERE bid = $ 2 pgbench | 127 . 0 . 0 . 1 | select o . n , p . partstrat , pg_catalog . count ( i . inhparent ) from pg_catalog . pg_class as c join pg_catalo psql | 127 . 0 . 0 . 1 | SELECT application_name , client_ip , substr ( query , $ 1 , $ 2 ) as query FROM pg_stat_monitor pgbench | 127 . 0 . 0 . 1 | select count ( * ) from pgbench_branches ( 13 rows )","title":"Query information"},{"location":"USER_GUIDE.html#query-timing-information_1","text":"SELECT userid , total_time , min_time , max_time , mean_time , query FROM pg_stat_monitor ; userid | total_time | min_time | max_time | mean_time | query --------+--------------------+--------------------+--------------------+--------------------+------------------------------------------------------------------ 10 | 0 . 14 | 0 . 14 | 0 . 14 | 0 . 14 | select * from pg_stat_monitor_reset () 10 | 0 . 19 | 0 . 19 | 0 . 19 | 0 . 19 | select userid , dbid , queryid , query from pg_stat_monitor 10 | 0 . 30 | 0 . 13 | 0 . 16 | 0 . 15 | select bucket , bucket_start_time , query from pg_stat_monitor 10 | 0 . 29 | 0 . 29 | 0 . 29 | 0 . 29 | select userid , dbid , queryid , query , calls from pg_stat_monitor 10 | 11277 . 79 | 11277 . 79 | 11277 . 79 |","title":"Query timing information"},{"location":"USER_GUIDE.html#query-execution-plan","text":"postgres =# SELECT substr ( query , 0 , 50 ), query_plan from pg_stat_monitor limit 10 ; substr | query_plan ---------------------------------------------------+--------------------------------------------------------------------------------------------------------------- select o . n , p . partstrat , pg_catalog . count ( i . inhpa | Limit + | -> GroupAggregate + | Group Key : ( array_position ( current_schemas ( true ), n . nspname )), p . partstrat + | -> Sort + | Sort Key : ( array_position ( current_schemas ( true ), n . nspname )), p . partstrat + | -> Nested Loop Left Join + | -> Nested Loop Left Join + | -> Nested Loop + | Join Filter : ( c . relnamespace = n . oid ) + | -> Index Scan using pg_class_relname_nsp_index on pg_class c + | Index Cond : ( relname = 'pgbench_accounts' :: name ) + | -> Seq Scan on pg_namespace n + | Filter : ( array_position ( current_schemas ( true ), nspname ) IS NOT NULL ) + | -> Index Scan using pg_partitioned_table_partrelid_index on pg_partitioned_table p + | Index Cond : ( partrelid = c . oid ) + | -> Bitmap Heap Scan on pg_inherits i + | R SELECT abalance FROM pgbench_accounts WHERE aid = | Index Scan using pgbench_accounts_pkey on pgbench_accounts + | Index Cond : ( aid = 102232 ) BEGIN ; | END ; | SELECT substr ( query , $ 1 , $ 2 ), query_plan from pg_st | SELECT substr ( query , $ 1 , $ 2 ), calls , planid , query_pl | Limit + | -> Subquery Scan on pg_stat_monitor + | -> Result + | -> Sort + | Sort Key : p . bucket_start_time + | -> Hash Join + | Hash Cond : ( p . dbid = d . oid ) + | -> Function Scan on pg_stat_monitor_internal p + | -> Hash + | -> Seq Scan on pg_database d + | SubPlan 1 + | -> Function Scan on pg_stat_monitor_internal s + | Filter : ( queryid = p . top_queryid ) select count ( * ) from pgbench_branches | Aggregate + | -> Seq Scan on pgbench_branches UPDATE pgbench_tellers SET tbalance = tbalance + | vacuum pgbench_tellers | UPDATE pgbench_accounts SET abalance = abalance + | ( 10 rows ) The plan column does not contain costing, width and other values. This is an expected behavior as each row is an accumulation of statistics based on plan and amongst other key columns. Plan is only available when the pgsm_enable_query_plan configuration parameter is enabled.","title":"Query execution plan"},{"location":"USER_GUIDE.html#query-type-filtering_1","text":"pg_stat_monitor monitors queries per type (SELECT, INSERT, UPDATE OR DELETE) and classifies them accordingly in the cmd_type column thus reducing your efforts. postgres =# SELECT bucket , substr ( query , 0 , 50 ) AS query , cmd_type FROM pg_stat_monitor WHERE elevel = 0 ; bucket | query | cmd_type --------+---------------------------------------------------+---------- 4 | END | 4 | SELECT abalance FROM pgbench_accounts WHERE aid = | SELECT 4 | vacuum pgbench_branches | 4 | select count ( * ) from pgbench_branches | SELECT 4 | UPDATE pgbench_accounts SET abalance = abalance + | UPDATE 4 | truncate pgbench_history | 4 | INSERT INTO pgbench_history ( tid , bid , aid , delta | INSERT 5 | SELECT relations query FROM pg_stat_monitor | SELECT 9 | SELECT bucket , substr ( query , $ 1 , $ 2 ) AS query , cmd | 4 | vacuum pgbench_tellers | 4 | BEGIN | 5 | SELECT relations , query FROM pg_stat_monitor | SELECT 4 | UPDATE pgbench_tellers SET tbalance = tbalance + | UPDATE 4 | UPDATE pgbench_branches SET bbalance = bbalance + | UPDATE ( 14 rows )","title":"Query type filtering"},{"location":"USER_GUIDE.html#query-metadata_1","text":"The comments column contains any text wrapped in \u201c/*\u201d and \u201c*/\u201d comment tags. The pg_stat_monitor extension picks up these comments and makes them available in the comments column. Please note that only the latest comment value is preserved per row. The comments may be put in any format that can be parsed by a tool. CREATE EXTENSION hstore ; CREATE FUNCTION text_to_hstore ( s text ) RETURNS hstore AS $$ BEGIN RETURN hstore ( s :: text []); EXCEPTION WHEN OTHERS THEN RETURN NULL ; END ; $$ LANGUAGE plpgsql STRICT ; postgres =# SELECT 1 AS num /* { \"application\", java_app, \"real_ip\", 192.168.1.1} */ ; num ----- 1 ( 1 row ) postgres =# SELECT 1 AS num1 , 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ ; num1 | num2 ------+------ 1 | 2 ( 1 row ) postgres =# SELECT 1 AS num1 , 2 AS num2 , 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ ; num1 | num2 | num3 ------+------+------ 1 | 2 | 3 ( 1 row ) postgres =# SELECT 1 AS num1 , 2 AS num2 , 3 AS num3 , 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ ; num1 | num2 | num3 | num4 ------+------+------+------ 1 | 2 | 3 | 4 ( 1 row ) postgres =# select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; query | comments_tags ---------------------------------------------------------------------------------------------------------------+----------------------------------------------------- SELECT $ 1 AS num /* { \"application\", psql_app, \"real_ip\", 192.168.1.3) */ | \"real_ip\" => \"192.168.1.1\" , \"application\" => \"java_app\" SELECT pg_stat_monitor_reset (); | select query , comments , text_to_hstore ( comments ) from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ | \"real_ip\" => \"192.168.1.3\" , \"application\" => \"java_app\" select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ | \"real_ip\" => \"192.168.1.2\" , \"application\" => \"java_app\" SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 , $ 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ | \"real_ip\" => \"192.168.1.3\" , \"application\" => \"psql_app\" ( 7 rows ) postgres =# select query , text_to_hstore ( comments ) -> 'application' as application_name from pg_stat_monitor ; query | application_name ---------------------------------------------------------------------------------------------------------------+---------- SELECT $ 1 AS num /* { \"application\", psql_app, \"real_ip\", 192.168.1.3) */ | java_app SELECT pg_stat_monitor_reset (); | select query , text_to_hstore ( comments ) -> \"real_ip\" as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> $ 1 from pg_stat_monitor | select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> \"application\" as comments_tags from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ | java_app SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ | java_app select query , comments , text_to_hstore ( comments ) from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 , $ 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ | psql_app ( 10 rows ) postgres =# select query , text_to_hstore ( comments ) -> 'real_ip' as real_ip from pg_stat_monitor ; query | real_ip ---------------------------------------------------------------------------------------------------------------+------------- SELECT $ 1 AS num /* { \"application\", psql_app, \"real_ip\", 192.168.1.3) */ | 192 . 168 . 1 . 1 SELECT pg_stat_monitor_reset (); | select query , text_to_hstore ( comments ) -> \"real_ip\" as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> $ 1 from pg_stat_monitor | select query , text_to_hstore ( comments ) as comments_tags from pg_stat_monitor ; | select query , text_to_hstore ( comments ) -> \"application\" as comments_tags from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 /* { \"application\", java_app, \"real_ip\", 192.168.1.2} */ | 192 . 168 . 1 . 2 SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 /* { \"application\", java_app, \"real_ip\", 192.168.1.3} */ | 192 . 168 . 1 . 3 select query , comments , text_to_hstore ( comments ) from pg_stat_monitor ; | SELECT $ 1 AS num1 , $ 2 AS num2 , $ 3 AS num3 , $ 4 AS num4 /* { \"application\", psql_app, \"real_ip\", 192.168.1.3} */ | 192 . 168 . 1 . 3 ( 10 rows )","title":"Query metadata"},{"location":"USER_GUIDE.html#top-query-tracking_1","text":"In the following example we create a function add2 that adds one parameter value to another one and call this function to calculate 1+2. CREATE OR REPLACE function add2 ( int , int ) RETURNS int as $$ BEGIN return ( select $ 1 + $ 2 ); END ; $$ language plpgsql ; SELECT add2 ( 1 , 2 ); add2 ----- 3 ( 1 row ) The `` pg_stat_monitor `` view shows all executed queries and shows the very first query in a row - calling the ` add2 ` function . postgres =# SELECT queryid , top_queryid , query , top_query FROM pg_stat_monitor ; queryid | top_queryid | query . | top_query ------------------+------------------+-------------------------------------------------------------------------+------------------- 3408 CA84B2353094 | | select add2 ( $ 1 , $ 2 ) | 762 B99349F6C7F31 | 3408 CA84B2353094 | SELECT ( select $ 1 + $ 2 ) | select add2 ( $ 1 , $ 2 ) ( 2 rows )","title":"Top query tracking"},{"location":"USER_GUIDE.html#relations_1","text":"Example 1: List all the table names involved in the query. postgres =# SELECT relations , query FROM pg_stat_monitor ; relations | query -------------------------------+------------------------------------------------------------------------------------------------------ | END { public . pgbench_accounts } | SELECT abalance FROM pgbench_accounts WHERE aid = $ 1 | vacuum pgbench_branches { public . pgbench_branches } | select count ( * ) from pgbench_branches { public . pgbench_accounts } | UPDATE pgbench_accounts SET abalance = abalance + $ 1 WHERE aid = $ 2 | truncate pgbench_history { public . pgbench_history } | INSERT INTO pgbench_history ( tid , bid , aid , delta , mtime ) VALUES ( $ 1 , $ 2 , $ 3 , $ 4 , CURRENT_TIMESTAMP ) { public . pg_stat_monitor , pg_catalog . pg_database } | SELECT relations query FROM pg_stat_monitor | vacuum pgbench_tellers | BEGIN { public . pgbench_tellers } | UPDATE pgbench_tellers SET tbalance = tbalance + $ 1 WHERE tid = $ 2 { public . pgbench_branches } | UPDATE pgbench_branches SET bbalance = bbalance + $ 1 WHERE bid = $ 2 ( 12 rows ) Example 2: List all the views and the name of the table in the view. Here we have a view \u201ctest_view\u201d \\ d + test_view View \"public.test_view\" Column | Type | Collation | Nullable | Default | Storage | Description --------+---------+-----------+----------+---------+---------+------------- foo_a | integer | | | | plain | bar_a | integer | | | | plain | View definition : SELECT f . a AS foo_a , b . a AS bar_a FROM foo f , bar b ; Now when we query the pg_stat_monitor , it will show the view name and also all the table names in the view. Note that the view name is followed by an asterisk (*). SELECT relations , query FROM pg_stat_monitor ; relations | query ---------------------+---------------------------------------------------- { test_view * , foo , bar } | select * from test_view { foo , bar } | select * from foo , bar ( 2 rows )","title":"Relations"},{"location":"USER_GUIDE.html#queries-terminated-with-errors","text":"SELECT substr ( query , 0 , 50 ) AS query , decode_error_level ( elevel ) AS elevel , sqlcode , calls , substr ( message , 0 , 50 ) message FROM pg_stat_monitor ; query | elevel | sqlcode | calls | message ---------------------------------------------------+--------+---------+-------+--------------------------------------------------- select substr ( query , $ 1 , $ 2 ) as query , decode_error | | 0 | 1 | select bucket , substr ( query , $ 1 , $ 2 ), decode_error_le | | 0 | 3 | | LOG | 0 | 1 | database system is ready to accept connections select 1 / 0 ; | ERROR | 130 | 1 | division by zero | LOG | 0 | 1 | database system was shut down at 2020 - 11 - 11 11 : 37 select $ 1 / $ 2 | | 0 | 1 | ( 6 rows ) 11277 . 79 | SELECT * FROM foo","title":"Queries terminated with errors"},{"location":"USER_GUIDE.html#histogram_1","text":"Histogram (the resp_calls parameter) provides a visual representation of query performance. With the help of the histogram function, you can view a timing/calling data histogram in response to a SQL query. SELECT resp_calls , query FROM pg_stat_monitor ; resp_calls | query --------------------------------------------------+---------------------------------------------- { 1 , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" } | select client_ip , query from pg_stat_monitor { 3 , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 1\" } | select * from pg_stat_monitor_reset () { 3 , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 0\" , \" 1\" } | SELECT * FROM foo postgres =# SELECT * FROM histogram ( 0 , 'F44CD1B4B33A47AF' ) AS a ( range TEXT , freq INT , bar TEXT ); range | freq | bar --------------------+------+-------------------------------- ( 0 - 3 ) } | 2 | \u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0 ( 3 - 10 ) } | 0 | ( 10 - 31 ) } | 1 | \u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0\u25a0 ( 31 - 100 ) } | 0 | ( 100 - 316 ) } | 0 | ( 316 - 1000 ) } | 0 | ( 1000 - 3162 ) } | 0 | ( 3162 - 10000 ) } | 0 | ( 10000 - 31622 ) } | 0 | ( 31622 - 100000 ) } | 0 | ( 10 rows ) There are 10 time based buckets of the time generated automatically based on total buckets in the field resp_calls . The value in the field shows how many queries run in that period of time.","title":"Histogram"},{"location":"setup.html","text":"Setting up pg_stat_monitor \u00b6 Supported platforms \u00b6 The PostgreSQL YUM repository supports pg_stat_monitor for all supported versions for the following platforms: Red Hat Enterprise/Rocky/CentOS/Oracle Linux 7 and 8 Fedora 33 and 34 Find the list of supported platforms for pg_stat_monitor within Percona Distribution for PostgreSQL on the Percona Release Lifecycle Overview page. Installation guidelines \u00b6 You can install pg_stat_monitor from the following sources: Percona repositories , PostgreSQL PGDG yum repositories , PGXN and source code . Installing from Percona repositories \u00b6 To install pg_stat_monitor from Percona repositories, you need to use the percona-release repository management tool. Install percona-release following the instructions relevant to your operating system Enable Percona repository: percona-release setup ppgXX Replace XX with the desired PostgreSQL version. For example, to install pg_stat_monitor for PostgreSQL 13, specify ppg13 . Install pg_stat_monitor package For Debian and Ubuntu: apt-get install percona-pg-stat-monitor13 For RHEL and CentOS: yum install percona-pg-stat-monitor13 Installing from PostgreSQL yum repositories \u00b6 Install the PostgreSQL repositories following the instructions in the Linux downloads (Red Hat family) chapter in PostgreSQL documentation. Install pg_stat_monitor : dnf install -y pg_stat_monitor_<VERSION> Replace the VERSION variable with the PostgreSQL version you are using (e.g. specify pg_stat_monitor_13 for PostgreSQL 13) Installing from PGXN \u00b6 You can install pg_stat_monitor from PGXN (PostgreSQL Extensions Network) using the PGXN client . Use the following command: pgxn install pg_stat_monitor Building from source \u00b6 To build pg_stat_monitor from source code, you require the following: git make gcc pg_config You can download the source code of the latest release of pg_stat_monitor from the releases page on GitHub or using git: git clone git://github.com/Percona/pg_stat_monitor.git Compile and install the extension cd pg_stat_monitor make USE_PGXS=1 make USE_PGXS=1 install Setup \u00b6 You can enable pg_stat_monitor when your postgresql instance is not running. pg_stat_monitor needs to be loaded at the start time. The extension requires additional shared memory; therefore, add the pg_stat_monitor value for the shared_preload_libraries parameter and restart the postgresql instance. Use the ALTER SYSTEM command from psql terminal to modify the shared_preload_libraries parameter. ALTER SYSTEM SET shared_preload_libraries = 'pg_stat_monitor' ; NOTE : If you\u2019ve added other modules to the shared_preload_libraries parameter (for example, pg_stat_statements ), list all of them separated by commas for the ALTER SYSTEM command. For PostgreSQL 13 and earlier versions, pg_stat_monitor must follow pg_stat_statements . For example, ALTER SYSTEM SET shared_preload_libraries = 'foo, pg_stat_statements, pg_stat_monitor' . In PostgreSQL 14, you can specify pg_stat_statements and pg_stat_monitor in any order. However, due to the extensions\u2019 architecture, if both pg_stat_statements and pg_stat_monitor are loaded, only the last listed extension captures utility queries, CREATE TABLE, Analyze, etc. The first listed extension captures most common queries like SELECT, UPDATE, INSERT, but does not capture utility queries. Thus, to collect the whole statistics with pg_stat_monitor, we recommend to specify the extensions as follows: ALTER SYSTEM SET shared_preload_libraries = \u2018pg_stat_statements, pg_stat_monitor\u2019. Start or restart the postgresql instance to apply the changes. On Debian and Ubuntu: sudo systemctl restart postgresql.service On Red Hat Enterprise Linux and CentOS: sudo systemctl restart postgresql-13 Create the extension using the CREATE EXTENSION command. Using this command requires the privileges of a superuser or a database owner. Connect to psql as a superuser for a database and run the following command: CREATE EXTENSION pg_stat_monitor ; This allows you to see the stats collected by pg_stat_monitor . By default, pg_stat_monitor is created for the postgres database. To access the statistics from other databases, you need to create the extension for every database. -- Select some of the query information, like client_ip, username and application_name etc. postgres=# SELECT application_name, userid AS user_name, datname AS database_name, substr(query,0, 50) AS query, calls, client_ip FROM pg_stat_monitor; application_name | user_name | database_name | query | calls | client_ip ------------------+-----------+---------------+---------------------------------------------------+-------+----------- psql | vagrant | postgres | SELECT application_name, userid::regrole AS user_ | 1 | 127.0.0.1 psql | vagrant | postgres | SELECT application_name, userid AS user_name, dat | 3 | 127.0.0.1 psql | vagrant | postgres | SELECT application_name, userid AS user_name, dat | 1 | 127.0.0.1 psql | vagrant | postgres | SELECT application_name, userid AS user_name, dat | 8 | 127.0.0.1 psql | vagrant | postgres | SELECT bucket, substr(query,$1, $2) AS query, cmd | 1 | 127.0.0.1 (5 rows) To learn more about pg_stat_monitor features and usage, see User Guide . To view all other data elements provided by pg_stat_monitor , please see the pg_stat_monitor view reference . Configuration \u00b6 You can find the configuration parameters of the pg_stat_monitor extension in the pg_stat_monitor_settings view. To change the default configuration, specify new values for the desired parameters using the GUC (Grant Unified Configuration) system. To learn more, refer to the Configuration section of the user guide. Remove pg_stat_monitor \u00b6 To uninstall pg_stat_monitor , do the following: Disable statistics collection. Establish the psql session and run the following command : ALTER SYSTEM SET pg_stat_monitor . pgsm_enable = 0 ; Drop pg_stat_monitor extension: DROP EXTENSION pg_stat_monitor ; Remove pg_stat_monitor from the shared_preload_libraries configuration parameter: ALTER SYSTEM SET shared_preload_libraries = '' ; Important If the shared_preload_libraries parameter includes other modules, specify them all for the ALTER SYSTEM SET command to keep using them. Restart the postgresql instance to apply the changes. The following command restarts PostgreSQL 13. Replace the version value with the one you are using. On Debian and Ubuntu: sudo systemctl restart postgresql.service On Red Hat Enterprise Linux and CentOS: sudo systemctl restart postgresql-13","title":"Setting up `pg_stat_monitor`"},{"location":"setup.html#setting-up-pg_stat_monitor","text":"","title":"Setting up pg_stat_monitor"},{"location":"setup.html#supported-platforms","text":"The PostgreSQL YUM repository supports pg_stat_monitor for all supported versions for the following platforms: Red Hat Enterprise/Rocky/CentOS/Oracle Linux 7 and 8 Fedora 33 and 34 Find the list of supported platforms for pg_stat_monitor within Percona Distribution for PostgreSQL on the Percona Release Lifecycle Overview page.","title":"Supported platforms"},{"location":"setup.html#installation-guidelines","text":"You can install pg_stat_monitor from the following sources: Percona repositories , PostgreSQL PGDG yum repositories , PGXN and source code .","title":"Installation guidelines"},{"location":"setup.html#installing-from-percona-repositories","text":"To install pg_stat_monitor from Percona repositories, you need to use the percona-release repository management tool. Install percona-release following the instructions relevant to your operating system Enable Percona repository: percona-release setup ppgXX Replace XX with the desired PostgreSQL version. For example, to install pg_stat_monitor for PostgreSQL 13, specify ppg13 . Install pg_stat_monitor package For Debian and Ubuntu: apt-get install percona-pg-stat-monitor13 For RHEL and CentOS: yum install percona-pg-stat-monitor13","title":"Installing from Percona repositories"},{"location":"setup.html#installing-from-postgresql-yum-repositories","text":"Install the PostgreSQL repositories following the instructions in the Linux downloads (Red Hat family) chapter in PostgreSQL documentation. Install pg_stat_monitor : dnf install -y pg_stat_monitor_<VERSION> Replace the VERSION variable with the PostgreSQL version you are using (e.g. specify pg_stat_monitor_13 for PostgreSQL 13)","title":"Installing from PostgreSQL yum repositories"},{"location":"setup.html#installing-from-pgxn","text":"You can install pg_stat_monitor from PGXN (PostgreSQL Extensions Network) using the PGXN client . Use the following command: pgxn install pg_stat_monitor","title":"Installing from PGXN"},{"location":"setup.html#building-from-source","text":"To build pg_stat_monitor from source code, you require the following: git make gcc pg_config You can download the source code of the latest release of pg_stat_monitor from the releases page on GitHub or using git: git clone git://github.com/Percona/pg_stat_monitor.git Compile and install the extension cd pg_stat_monitor make USE_PGXS=1 make USE_PGXS=1 install","title":"Building from source"},{"location":"setup.html#setup","text":"You can enable pg_stat_monitor when your postgresql instance is not running. pg_stat_monitor needs to be loaded at the start time. The extension requires additional shared memory; therefore, add the pg_stat_monitor value for the shared_preload_libraries parameter and restart the postgresql instance. Use the ALTER SYSTEM command from psql terminal to modify the shared_preload_libraries parameter. ALTER SYSTEM SET shared_preload_libraries = 'pg_stat_monitor' ; NOTE : If you\u2019ve added other modules to the shared_preload_libraries parameter (for example, pg_stat_statements ), list all of them separated by commas for the ALTER SYSTEM command. For PostgreSQL 13 and earlier versions, pg_stat_monitor must follow pg_stat_statements . For example, ALTER SYSTEM SET shared_preload_libraries = 'foo, pg_stat_statements, pg_stat_monitor' . In PostgreSQL 14, you can specify pg_stat_statements and pg_stat_monitor in any order. However, due to the extensions\u2019 architecture, if both pg_stat_statements and pg_stat_monitor are loaded, only the last listed extension captures utility queries, CREATE TABLE, Analyze, etc. The first listed extension captures most common queries like SELECT, UPDATE, INSERT, but does not capture utility queries. Thus, to collect the whole statistics with pg_stat_monitor, we recommend to specify the extensions as follows: ALTER SYSTEM SET shared_preload_libraries = \u2018pg_stat_statements, pg_stat_monitor\u2019. Start or restart the postgresql instance to apply the changes. On Debian and Ubuntu: sudo systemctl restart postgresql.service On Red Hat Enterprise Linux and CentOS: sudo systemctl restart postgresql-13 Create the extension using the CREATE EXTENSION command. Using this command requires the privileges of a superuser or a database owner. Connect to psql as a superuser for a database and run the following command: CREATE EXTENSION pg_stat_monitor ; This allows you to see the stats collected by pg_stat_monitor . By default, pg_stat_monitor is created for the postgres database. To access the statistics from other databases, you need to create the extension for every database. -- Select some of the query information, like client_ip, username and application_name etc. postgres=# SELECT application_name, userid AS user_name, datname AS database_name, substr(query,0, 50) AS query, calls, client_ip FROM pg_stat_monitor; application_name | user_name | database_name | query | calls | client_ip ------------------+-----------+---------------+---------------------------------------------------+-------+----------- psql | vagrant | postgres | SELECT application_name, userid::regrole AS user_ | 1 | 127.0.0.1 psql | vagrant | postgres | SELECT application_name, userid AS user_name, dat | 3 | 127.0.0.1 psql | vagrant | postgres | SELECT application_name, userid AS user_name, dat | 1 | 127.0.0.1 psql | vagrant | postgres | SELECT application_name, userid AS user_name, dat | 8 | 127.0.0.1 psql | vagrant | postgres | SELECT bucket, substr(query,$1, $2) AS query, cmd | 1 | 127.0.0.1 (5 rows) To learn more about pg_stat_monitor features and usage, see User Guide . To view all other data elements provided by pg_stat_monitor , please see the pg_stat_monitor view reference .","title":"Setup"},{"location":"setup.html#configuration","text":"You can find the configuration parameters of the pg_stat_monitor extension in the pg_stat_monitor_settings view. To change the default configuration, specify new values for the desired parameters using the GUC (Grant Unified Configuration) system. To learn more, refer to the Configuration section of the user guide.","title":"Configuration"},{"location":"setup.html#remove-pg_stat_monitor","text":"To uninstall pg_stat_monitor , do the following: Disable statistics collection. Establish the psql session and run the following command : ALTER SYSTEM SET pg_stat_monitor . pgsm_enable = 0 ; Drop pg_stat_monitor extension: DROP EXTENSION pg_stat_monitor ; Remove pg_stat_monitor from the shared_preload_libraries configuration parameter: ALTER SYSTEM SET shared_preload_libraries = '' ; Important If the shared_preload_libraries parameter includes other modules, specify them all for the ALTER SYSTEM SET command to keep using them. Restart the postgresql instance to apply the changes. The following command restarts PostgreSQL 13. Replace the version value with the one you are using. On Debian and Ubuntu: sudo systemctl restart postgresql.service On Red Hat Enterprise Linux and CentOS: sudo systemctl restart postgresql-13","title":"Remove pg_stat_monitor"}]}
\ No newline at end of file
diff --git a/REL_1_STABLE/sitemap.xml.gz b/REL_1_STABLE/sitemap.xml.gz
index f02d6e5..4965538 100644
Binary files a/REL_1_STABLE/sitemap.xml.gz and b/REL_1_STABLE/sitemap.xml.gz differ