Command line tool for PostgreSQL server activity monitoring.

Installation

From distribution packages

The simplest way to install pg_activity is through the package manager of your
Linux distribution, if it ships with a package. E.g., on Debian-based
distributions (e.g. Debian, Ubuntu, Mint...):

$ sudo apt install pg-activity

(on Debian bullseye, the current stable version, a backport is available: apt install pg-activity/bullseye-backports).

The PostgreSQL Global Development Group (PGDG) also provides packages for
RPM-based (https://yum.postgresql.org/) and Debian-based distributions
(https://wiki.postgresql.org/wiki/Apt).

Note: distribution packages may not be up to date with the latest
pg_activity releases. Before submitting a bug report here:

• check the package version, compare that to our latest release and then
  review the change log to see if the bug has been fixed;
• if the issue is about packaging, e.g. missing dependencies, reach out
  the package maintainer (or PGDG) first.

From PyPI

pg_activity can be installed using pip on Python 3.7 or later along with
psycopg:

$ python3 -m pip install "pg_activity[psycopg]"

Alternatively, pipx can be used to install
and run pg_activity in an isolated environment:

$ pipx install "pg_activity[psycopg]"

In case your $PATH does not already contain it, the full path is:

$ ~/.local/bin/pg_activity

From source, using git

This is only necessary to test development versions. First, clone the repository:

$ git clone https://github.com/dalibo/pg_activity.git

Change the branch if necessary. Then create a dedicated environment,
and install pg_activity with the psycopg database driver:

$ cd pg_activity
$ python3 -m venv .venv
$ . .venv/bin/activate
(.venv) $ pip install ".[psycopg]"
(.venv) $ pg_activity

To quit this env and destroy it:

$ deactivate
$ rm -r .venv

Usage

pg_activity works locally or remotely. In local execution context, to obtain
sufficient rights to display system information, the system user running
pg_activity must be the same user running postgresql server (postgres by
default), or have more rights like root. The PostgreSQL user used to connect
to the database must be super-user in order to get as much data as possible.
Otherwise, pg_activity can fall back to a degraded mode where some data like
system information or temporary file data are not displayed.

ex:

sudo -u postgres pg_activity -U postgres

Options

pg_activity [options] [connection string]

Options:
  --blocksize BLOCKSIZE
                        Filesystem blocksize (default: 4096).
  --rds                 Enable support for AWS RDS (implies --no-tempfiles and filters out the rdsadmin database from space calculation).
  --output FILEPATH     Store running queries as CSV.
  --no-db-size          Skip total size of DB.
  --no-tempfiles        Skip tempfile count and size.
  --no-walreceiver      Skip walreceiver checks.
  -w, --wrap-query      Wrap query column instead of truncating.
  --duration-mode DURATION_MODE
                        Duration mode. Values: 1-QUERY(default), 2-TRANSACTION, 3-BACKEND.
  --min-duration SECONDS
                        Don't display queries with smaller than specified duration (in seconds).
  --filter FIELD:REGEX  Filter activities with a (case insensitive) regular expression applied on selected fields. Known fields are: dbname.
  --debug-file DEBUG_FILE
                        Enable debug and write it to DEBUG_FILE.
  --version             show program's version number and exit.
  --help                Show this help message and exit.

Connection Options:
  connection string     A valid connection string to the database, e.g.: 'host=HOSTNAME port=PORT user=USER dbname=DBNAME'.
  -h HOSTNAME, --host HOSTNAME
                        Database server host or socket directory.
  -p PORT, --port PORT  Database server port.
  -U USERNAME, --username USERNAME
                        Database user name.
  -d DBNAME, --dbname DBNAME
                        Database name to connect to.

Process table display options:
  These options may be used hide some columns from the processes table.

  --no-pid              Disable PID.
  --no-database         Disable DATABASE.
  --no-user             Disable USER.
  --no-client           Disable CLIENT.
  --no-cpu              Disable CPU%.
  --no-mem              Disable MEM%.
  --no-read             Disable READ/s.
  --no-write            Disable WRITE/s.
  --no-time             Disable TIME+.
  --no-wait             Disable W.
  --no-app-name         Disable App.

Other display options:
  --hide-queries-in-logs
                        Disable log_min_duration_statements and log_min_duration_sample for pg_activity.
  --no-inst-info        Display instance information in header.
  --no-sys-info         Display system information in header.
  --no-proc-info        Display workers process information in header.
  --refresh REFRESH     Refresh rate. Values: 0.5, 1, 2, 3, 4, 5 (default: 2).

Configuration

pg_activity may be configured through configuration file, in INI format,
read from ${XDG_CONFIG_HOME:~/.config}/pg_activity.conf or
/etc/pg_activity.conf in that order. Command-line options may override
configuration file settings.
This is used to control how columns in the processes table are rendered, e.g.:

[client]
hidden = yes

[database]
width = 9

Notes

Length of SQL query text that pg_activity reports relies on PostgreSQL
parameter track_activity_query_size. Default value is 1024 (expressed in
bytes). If your SQL query text look truncated, you should increase
track_activity_query_size.

Interactives commands

Navigation mode

FAQ

I can't see my queries only TPS is shown

pg_activity scans the view pg_stat_activity with a user defined refresh
time comprised between 0.5 and 5 seconds. It can be modified in the interface
with the + and - keys. Any query executed between two scans won't be
displayed.

What is more, pg_activity uses different queries to get :

• settings from pg_settings
• version info using version()
• queries and number of connections from pg_stat_activity
• locks from pg_locks
• tps from pg_database using pg_stat_get_db_xact_commit() and
  pg_stat_get_db_xact_rollback()
• and more ( eg : pg_cancel_backend() and pg_terminate_backend() )

Those queries cannot be seen in the query tab because all queries issued from
the pg_activity backend are considered as noise and are not displayed . On
the other hand, the transactions used to get the info for pg_activity's
reporting are still accounted for by postgres in pg_stat_get_db_xact_commit()
and pg_stat_get_db_xact_commit(). Therefore pg_activity will display a non
zero TPS even with no activity on the database, and/or no activity displayed on
screen.

How can I specify a password for authentication ?

pg_activity uses libpq to access to PostgreSQL therefore all the traditional
methods are available.

You can pass the password for the database connection in a password file.
Information can also be given via PostgreSQL's environment variables
(PGPASSFILE or PGPASSWORD) or via the connection string parameters.

The password file is preferred since it's more secure (security is deferred to
the OS). Please avoid password in connection strings at all cost.

Hacking

In order to work on pg_activity source code, in particular to run the tests
suite, a temporary PostgreSQL database cluster will be created; accordingly,
PostgreSQL server binaries (e.g. initdb, pg_ctl) need to be available. For
instance, on a Debian system, this means simply having the postgresql package
installed.

To set up a development environment, get the source repository:

$ git clone https://github.com/dalibo/pg_activity
$ cd pg_activity

and then create a virtual environment, activate it and install the
project along with development dependencies:

$ python3 -m venv .venv
$ .venv/bin/activate
(.venv) $ pip install -e ".[dev]"

The source code is formatted with black and isort and typed checked with
mypy (all those are included in the development environment). Make sure to
respect this, e.g. by configuring your editor, before committing changes.
Alternatively, you can install pre-commit hooks so that this will be checked
automatically:

(.venv) $ pre-commit install

To run the tests suite, simply invoke:

(.venv) $ pytest
================================ test session starts =================================
platform linux -- Python 3.11.2, pytest-7.3.1, pluggy-1.0.0
psycopg: 3.1.8
configfile: pytest.ini
plugins: cov-4.0.0, accept-0.1.9, postgresql-4.1.1
collected 70 items

pgactivity/activities.py ..                                                    [  2%]
pgactivity/config.py ..                                                        [  5%]
pgactivity/data.py ..                                                          [  8%]
pgactivity/handlers.py .....                                                   [ 15%]
pgactivity/keys.py .                                                           [ 17%]
pgactivity/types.py ..............                                             [ 37%]
pgactivity/utils.py .........                                                  [ 50%]
pgactivity/views.py .....                                                      [ 57%]
tests/test_activities.py ...                                                   [ 61%]
tests/test_config.py ..                                                        [ 64%]
tests/test_data.py ................                                            [ 87%]
tests/test_scroll.txt .                                                        [ 88%]
tests/test_types.py .                                                          [ 90%]
tests/test_ui.txt .                                                            [ 91%]
tests/test_views.py ....                                                       [ 97%]
tests/test_views.txt .                                                         [ 98%]
tests/test_widgets.txt .                                                       [100%]

================================ 70 passed in 11.89s =================================

Change log

See CHANGELOG.md.