Skip to content

Commit

Permalink
pre-release edits: fix typos, runglish, tiny improves
Browse files Browse the repository at this point in the history
  • Loading branch information
lesovsky committed Sep 1, 2016
1 parent 47817b5 commit 3217176
Show file tree
Hide file tree
Showing 4 changed files with 135 additions and 171 deletions.
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#### README: pgCenter [![Build Status](https://travis-ci.org/lesovsky/pgcenter.svg)](https://travis-ci.org/lesovsky/pgcenter)

PostgreSQL provides various statistics which includes information about tables, indexes, functions and other database objects and their usage. Moreover, statistics has detailed information about connections, current queries and database operations (INSERT/DELETE/UPDATE). But most of this statistics are provided as permanently incremented counters. The pgcenter provides convenient interface to this statistics and allow viewing statistics changes in time interval, eg. per second. The pgcenter provides fast access for database management task, such as editing configuration files, reloading services, viewing log files and canceling or terminating database backends (by pid or using state mask). However if need execute some specific operations, pgcenter can start psql session for this purposes.
PostgreSQL provides various statistics which include information about tables, indexes, functions and other database objects and their usage. Moreover, statistics has detailed information about connections, current queries and database operations (INSERT/DELETE/UPDATE). But most of these statistics are provided as permanently incremented counters. The pgCenter provides convenient interface to postgres statistics and allow viewing statistics changes in time interval, eg. per second. Also pgCenter provides fast access for database management task, such as editing configuration files, reloading postgres service, viewing log files and canceling or terminating database backends (by pid or using state mask). However, if need to execute some specific operations, pgCenter able to start psql session for this purposes.

#### Features:
- top-like interface with sorting and filtration functions;
Expand All @@ -9,16 +9,17 @@ PostgreSQL provides various statistics which includes information about tables,
- show current system load and cpu/memory/swap usage;
- show input/output statistics for devices and partitions like iostat;
- show network traffic statistics for network interfaces like nicstat;
- show current postgres state (connections state, longest transaction, autovacuum)
- show statistics about tables, indexes, functions, activity, replication;
- show current postgres state (connections, longest transaction, autovacuum)
- show statistics about tables, indexes, functions, current activity, replication;
- show pg_stat_statements statistics: calls, rows;
- show pg_stat_statements statistics: cpu timings, io timings;
- show pg_stat_statements statistics: blks i/o (hits, reads, dirtied, written, temp);
- show pg_stat_statements statistics: cpu timings, IO timings;
- show pg_stat_statements statistics: block IO (hits, reads, dirtied, written, temp);
- show pg_stat_statements statistics: local (temp tables) IO, temp (temp files) IO;
- show relations sizes info;
- show vacuum progress (since 9.6);
- configuration files editor and postgres reload;
- log files viewing (full log or tail);
- cancel/terminate queries or processes by pid or whole group;
- log files viewing (view entire log or tail last lines);
- cancel queries or terminate processes by their pid or handle whole group using state mask;
- query reporting;

#### Statistics:
Expand All @@ -41,12 +42,12 @@ PostgreSQL provides various statistics which includes information about tables,
- Cancel queries or terminate group of backends using state of backends;
- Toggle displaying system tables and indexes for tables and indexes statistics;
- Reset PostgreSQL statistics counters;
- Show detailed report about query;
- Show detailed report about query (based on pg_stat_statements);
- Start psql session.

#### Recommendations:
- run pgCenter on the same host with PostgreSQL. When pgCenter works with remote PostgreSQL, some features will not work, eg. config editing, logfile viewing, system monitoring functions or iostat/nicstat.
- run pgCenter under database SUPERUSER account, eg. postgres. Some internal PostgreSQL information, system functions or data from views is available only for privileged accounts.
- run pgCenter under database SUPERUSER account, eg. postgres. Some internal PostgreSQL information, system functions or data from views are available only for privileged accounts.

#### Install notes:

Expand All @@ -60,8 +61,8 @@ $ sudo apt-get install pgcenter
Debian users can create package using this [link](https://wiki.debian.org/CreatePackageFromPPA) or download deb package from [Launchpad page](https://launchpad.net/~lesovsky/+archive/ubuntu/pgcenter/+packages) and install pgCenter with *dpkg -i*.
**Warning**: *Launchpad uses it's own buildfarm for packages creating and pgCenter installed from Launchpad crashes in some circumstances.*

##### Install from RHEL6/CentOS6
- install pgCenter from Essential Kaos testing repo.
##### Install from RHEL/CentOS
- install pgCenter from Essential Kaos testing repo. Also pgCenter is available in EPEL testing repo.
```
$ sudo yum install http://release.yum.kaos.io/i386/kaos-repo-6.8-0.el6.noarch.rpm
$ sudo yum --enablerepo=kaos-testing install pgcenter
Expand All @@ -88,14 +89,14 @@ $ pgcenter <dbname> <username>
$ pgcenter <dbname>
$ pgcenter
```
- Allowed to use libpq environment variables, such as PGHOST, PGPORT, PGUSER, PGDATABASE, PGPASSWORD. This settings have the lowest priority and used in case when no connections settings specified via input arguments and connection file (.pgcenterrc) not found or not specified.
- Connection file stores connection settings and limited by eight connections (max number of tabs). This file used when input arguments are not specified. If connection options are specified at startup, connection starts in the first tab, other connections from the file start in the next tabs.
- Allowed to use libpq environment variables, such as PGHOST, PGPORT, PGUSER, PGDATABASE, PGPASSWORD. These settings have the lowest priority and used in case when no connections settings specified via input arguments and connection file (.pgcenterrc) not found or not specified.
- Connection file stores connection settings and their number is limited by eight connections (max number of tabs). This file is used when input arguments are not specified. If connection options are specified at startup, connection starts in the first tab, other connections from the file start in the next tabs.
- Connection settings specified with input arguments have top priority, connection with these settings will opens in the first tab.

#### Known issues
- mainly developed and tested under PostgreSQL 9.5/9.6 (but tested with others 9.x releases).
- this is beta software, in some circumstances may occurs segfaults. When segfaults occur, you may help me to do this software better:
- Build pgcenter from latest sources (see above instructions).
- this is beta software, in some circumstances may occurs segfaults. When segfaults occur, you may help me to make this software better:
- Build pgcenter from latest sources (see instructions above).
- Enable coredump with ```ulimit -c unlimited```
- Reproduce segafult (after pgcenter crash, coredump file will be created in current directory).
- Run pgcenter with gdb ```gdb ./pgcenter <coredump>```
Expand Down
3 changes: 3 additions & 0 deletions doc/Changelog
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
pgcenter (devel) unstable; urgency=low

* fix runglish, typos and cosmetic changes.
* change long queries min age from 500ms to 0ms.
* replace min() and max() functions with macros.
* add filtration feature.
* allow to use connection settings from libpq env vars.
* add install-man section into Makefile.
Expand Down
Loading

0 comments on commit 3217176

Please sign in to comment.