brongineers / pgcenter Goto Github PK

pgCenter is a command-line admin tool for observing and troubleshooting Postgres.

• Main goal
• Key features
• Supported statistics
  • PostgreSQL statistics
  • System statistics
• Install notes
• Usage notes
• Development and testing
• Known issues
• Thanks

Postgres provides various activity statistics about its runtime, such as connections, statements, database operations, replication, resources usage and more. General purpose of the statistics is to help DBAs to monitor and troubleshoot Postgres. However, these statistics provided in textual form retrieved from SQL functions and views, and Postgres doesn't provide native tools for working with statistics views.

pgCenter's main goal is to help Postgres DBA working with statistics and provide a convenient way to observe Postgres in runtime.

• Top-like interface that allows you to monitor stats changes as you go. See details here.
• Configuration management function allows viewing and editing of current configuration files and reloading the service, if needed.
• Logfiles functions allow you to quickly check Postgres logs without stopping statistics monitoring.
• "Poor man’s monitoring" allows you to collect Postgres statistics into files and build reports later on. See details here.
• Wait events profiler allows to see what wait events occur during queries execution. See details here.

When troubleshooting Postgres it's always important to keep an eye not only on Postgres metrics, but also system metrics, since Postgres utilizes system resources, such as cpu, memory, storage and network when working. pgCenter allows you to see both kinds of statistics related to Postgres and your system.

pgCenter supports majority of statistics views available in Postgres, and at the same time, uses additional SQL functions applied to statistics to show these in a more convenient way. The following stats are available:

• current summary activity - a compilation/selection of metrics from different sources - postgres uptime, version, recovery status, number of clients grouped by their states, number of (auto)vacuums, statements per second, age of the longest transaction and the longest vacuum;
• pg_stat_activity - information related to the current activity of connected clients and Postgres background processes.
• pg_stat_database - database-wide statistics, such as number of commits/rollbacks, handled tuples, deadlocks, temporary files, etc.
• pg_stat_replication - statistics on replication, connected standby hosts and their activity.
• pg_stat_user_tables, pg_statio_user_tables - statistics on accesses (including IO) to tables.
• pg_stat_user_indexes, pg_statio_user_indexes - statistics on accesses (including IO) to indexes.
• pg_stat_user_functions - statistics on execution of functions.
• pg_stat_statements - statistics on SQL statements executed including time and resources usage.
• statistics on tables sizes based on pg_relation_size() and pg_total_relation_size() functions;
• pg_stat_progress_vacuum - information about progress of (auto)vacuums status.
• pg_stat_progress_cluster - information about progress of CLUSTER and VACUUM FULL operations.
• pg_stat_progress_create_index - information about progress of CREATE INDEX and REINDEX operations.
• pg_stat_progress_analyze - information about progress of ANALYZE operations.
• pg_stat_progress_basebackup - information about progress of basebackup operations.

pgcenter top also provides system usage information based on statistics from procfs filesystem:

• load average and CPU usage time (user, system, nice, idle, iowait, software and hardware interrupts, steal);
• memory and swap usage, amount of cached and dirty memory, writeback activity;
• storage devices statistics: iops, throughput, latencies, average queue and requests size, devices utilization;
• network interfaces statistics: throughput in bytes and packets, different kind of errors, saturation and utilization.

In case of connecting to remote Postgres there is possibility to use additional SQL functions used for retrieving /proc statistics from remote host. For more information see details here.

Check out releases page. Pgcenter could be installed using package managers - RPM, DEB, APK packages are available. Also, a precompiled version is available in .tar.gz archive.

Additional information and usage examples available here.

Fore development and testing purposes, see development notes.

• pgCenter has been developed to work on Linux and hasn't been tested on other OS (operating systems), therefore, it is not recommended to use it on alternative systems because it will not operate properly.
• pgCenter can also be run using Docker.
• pgCenter supports a wide range of PostgreSQL versions, despite of difference in statistics between each version. If pgCenter is unable to read a particular stat, it will show a descriptive error message.
• ideally, pgCenter requires SUPERUSER database privileges, or at least privileges that will allow you to view statistics, read settings, logfiles and send signals to other backends. Roles with such privileges (except reading logs) have been introduced in Postgres 10, see details here.
• it is recommended to run pgCenter on the same host where Postgres is running. This is because for Postgres pgCenter is just a simple client application and it may have the same problems as other applications that work with Postgres, such as network-related problems, slow responses, etc.
• it is possible to run pgCenter on one host and connect to Postgres which runs on another host, but some functions may not work - this fully applies to pgcenter top command.
• pgCenter also supports Amazon RDS for PostgreSQL, but as mentioned above, some functions will not work and also system stats will not be available, because of PostgreSQL RDS instances don't support untrusted procedural languages due to security reasons.

The following notes are important for people who interested in developing new features.

• pgcenter goes with special docker image used for local and CI/CD testing. See testing directory for details.
• see docs about how to deploy environment for local development.

pgCenter is quite stable software, but not all functionality is covered by tests and in some circumstances, errors or panics may occur. When panics occur please do let me know - this helps me in making necessary changes and improve this software. To make sure that I can reproduce an issue you’ve been having and can address it accordingly please follow these steps:

• build pgCenter from the master branch and try to reproduce the bug/crash.
• create an issue using issue template and follow recommendations described in the template.

• Thank you for using pgCenter!
• Sebastien Godard for sysstat.
• Brendan Gregg and Tim Cook for nicstat.
• Pavel Stěhule for his articles.
• Pavel Alexeev, package maintainer on EPEL testing repo (Fedora/Centos).
• Manuel Rüger, ebuild maintainer on mrueg overlay (Gentoo Linux).
• Anton Novojilov, package maintainer on RHEL/CentOS Linux (Essential Kaos repo).
• Nikolay A. Fetisov, package maintainer at Sisyphus ALT Linux.
• Devrim Gündüz, package maintainer on official PostgreSQL yum repo.