pg_stat_monitor

Query Performance Monitoring Tool for PostgreSQL

distpg hacktoberfest percona percona-distribution pg postgres postgresql statistics statistics-collector

Go to file

Ibrar Ahmed 106a4ba741 Update README.md		2020-11-25 03:57:01 +05:00
docs	Update USER_GUIDE.md	2020-11-25 03:43:29 +05:00
expected	Issue - (#34 ): PostgreSQL Version 13 support added.	2020-06-23 17:24:21 +00:00
percona-packaging	Update packaging license	2020-10-15 16:19:17 +03:00
sql	Issue - (#33 ): Display all the custom configuration parameters used for pg_stat_monitor.	2020-05-25 11:58:22 +00:00
.gitignore	Issue - (#1 ): Initial Commit for PostgreSQL's (pg_stat_statement).	2019-11-19 11:34:34 +00:00
LICENSE	Update LICENSE	2020-10-15 18:11:56 +05:00
Makefile	Issue(30): Code refactoring.	2020-09-14 22:26:19 +00:00
README.md	Update README.md	2020-11-25 03:57:01 +05:00
guc.c	Issue - (#21 ): Show objects(tables) involved in the query.	2020-11-24 20:10:49 +00:00
hash_query.c	Issue - (#21 ): Show objects(tables) involved in the query.	2020-11-24 20:10:49 +00:00
pg_stat_monitor--1.0.sql	PG-153: Log application name.	2020-11-24 21:03:32 +00:00
pg_stat_monitor.c	PG-153: Log application name.	2020-11-24 21:03:32 +00:00
pg_stat_monitor.conf	Issue - (#2 ): Extended pg_stat_statement to provide new features.	2019-11-20 10:30:57 +00:00
pg_stat_monitor.control	Issue - (#2 ): Extended pg_stat_statement to provide new features.	2019-11-20 10:30:57 +00:00
pg_stat_monitor.h	PG-153: Log application name.	2020-11-24 21:03:32 +00:00

README.md

What is pg_stat_monitor?

The pg_stat_monitor is the statistics collection 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.

Documentation

Supported PostgreSQL Versions
Installation
Setup
User Guide
Release Notes
License
Copyright Notice

Supported PostgreSQL Versions

The pg_stat_monitor should work on the latest version of PostgreSQL but is only tested with these PostgreSQL versions:

Distribution	Version	Supported
PostgreSQL	Version < 11	❌
PostgreSQL	Version 11	✔️
PostgreSQL	Version 12	✔️
PostgreSQL	Version 13	✔️
Percona Distribution	Version < 11	❌
Percona Distribution	Version 11	✔️
Percona Distribution	Version 12	✔️
Percona Distribution	Version 13	✔️

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.

The source code of latest release of pg_stat_monitor can be downloaded from this GitHub page or it can be downloaded using the 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

pg_stat_monitor cannot be installed in your running PostgreSQL instance. It should be set 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 do from psql terminal using the alter system command.

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 restart the PostgreSQL instance.

postgres=# ALTER SYSTEM SET shared_preload_libraries = 'pg_stat_monitor';
ALTER SYSTEM

sudo systemctl restart postgresql-13

Create the extension using the CREATE EXTENSION command.

postgres=# CREATE EXTENSION pg_stat_monitor;
CREATE EXTENSION

README.md Unescape Escape