Extensions
- pg_stat_monitor 0.7.2
- PostgreSQL Query Performance Monitoring Tool
Documentation
- USER_GUIDE
- User Guide
- RELEASE_NOTES
- Release Notes
README
Contents
What is pg_stat_monitor?
The pg_stat_monitor is a PostgreSQL Query Performance Monitoring tool, based on PostgreSQL's contrib module pg_stat_statements
. PostgreSQL’s pg_stat_statements provides the basic statistics, which is sometimes not enough. The major shortcoming in pg_stat_statements is that it accumulates all the queries and their statistics and does not provide aggregated statistics nor histogram information. In this case, a user needs to calculate the aggregate which is quite expensive.
pg_stat_monitor is developed on the basis of pg_stat_statements as its more advanced replacement. It provides all the features of pg_stat_statements plus its own feature set.
How pg_stat_monitor works?
pg_stat_monitor accumulates the information in the form of buckets. All the aggregated information is bucket based. The size of a bucket and the number of buckets should be configured using GUC (Grand Unified Configuration). When a bucket time elapses, pg_stat_monitor resets all the statistics and switches to the next bucket. After the last bucket elapses, pg_stat_monitor goes back to the first bucket. All the data on the first bucket will vanish; therefore, users must read the buckets before that to not lose the data.
Documentation
Installation
pg_stat_monitor
is supplied as part of Percona Distribution for PostgreSQL. The rpm/deb packages are available from Percona repositories. Refer to Percona Documentation for installation instructions.
Installing from PGXN
You can install pg_stat_monitor
from PGXN (PostgreSQL Extensions Network) using the PGXN client.
Use the following command:
sh
pgxn install pg_stat_monitor
Installing from source code
You can download the source code of the latest release of pg_stat_monitor
from this GitHub page or using git:
sh
git clone git://github.com/Percona/pg_stat_monitor.git
Compile and install the extension
sh
cd pg_stat_monitor
make USE_PGXS=1
make USE_PGXS=1 install
Setup
pg_stat_monitor
cannot be enabled in your running PostgreSQL instance. pg_stat_monitor
needs to be loaded at the start time. This requires adding the pg_stat_monitor
extension for the shared_preload_libraries
parameter and restarting the PostgreSQL instance.
You can set the pg_stat_monitor
extension in the postgresql.conf
file.
``` - Shared Library Preloading -
shared_preload_libraries = 'pg_stat_monitor' # (change requires restart) local_preload_libraries = '' session_preload_libraries = '' ```
Or you can set it from psql
terminal using the alter system
command.
```sql
ALTER SYSTEM SET shared_preload_libraries = 'pg_stat_monitor'; ALTER SYSTEM
```
```sh
sudo systemctl restart postgresql-13
```
Create the extension using the CREATE EXTENSION
command.
```sql
CREATE EXTENSION pg_stat_monitor; CREATE EXTENSION
```
To learn more about pg_stat_monitor
configuration and usage, see User Guide.
Submitting Bug Reports
If you found a bug in pg_stat_monitor
, please submit the report to the Jira issue tracker
Start by searching the open tickets for a similar report. If you find that someone else has already reported your issue, then you can upvote that report to increase its visibility.
If there is no existing report, submit your report following these steps:
Sign in to Jira issue tracker. You will need to create an account if you do not have one.
In the Summary, Description, Steps To Reproduce, Affects Version fields describe the problem you have detected.
As a general rule of thumb, try to create bug reports that are:
Reproducible: describe the steps to reproduce the problem.
Unique: check if there already exists a JIRA ticket to describe the problem.
Scoped to a Single Bug: only report one bug in one JIRA ticket.
Copyright Notice
Portions Copyright © 2018-2020, Percona LLC and/or its affiliates
Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
Portions Copyright (c) 1994, The Regents of the University of California