pgBadger - A fast PostgreSQL Log Analyzer
pgBadger - a fast PostgreSQL log analysis report
Usage: pgbadger [options] logfile […]
PostgreSQL log analyzer with fully detailed reports and graphs.
logfile can be a single log file, a list of files, or a shell command returning a list of files. If you want to pass log content from stdin use - as filename. Note that input from stdin will not work with csvlog.
pgBadger is able to parse a remote log file using a passwordless ssh connection. Use -r or –remote-host to set the host IP address or hostname. There are also some additional options to fully control the ssh connection.
–ssh-program ssh path to the ssh program to use. Default: ssh. –ssh-port port ssh port to use for the connection. Default: 22. –ssh-user username connection login name. Defaults to running user. –ssh-identity file path to the identity file to use. –ssh-timeout second timeout to ssh connection failure. Default: 10 sec. –ssh-option options list of -o options to use for the ssh connection. Options always used: -o ConnectTimeout=$ssh_timeout -o PreferredAuthentications=hostbased,publickey
Log file to parse can also be specified using an URI, supported protocols are http[s] and [s]ftp. The curl command will be used to download the file, and the file will be parsed during download. The ssh protocol is also supported and will use the ssh command like with the remote host use. See examples bellow.
0: on success 1: die on error 2: if it has been interrupted using ctr+c for example 3: the pid file already exists or can not be created 4: no log file was given at command line
pgbadger /var/log/postgresql.log pgbadger /var/log/postgres.log.2.gz /var/log/postgres.log.1.gz /var/log/postgres.log pgbadger /var/log/postgresql/postgresql-2012-05- pgbadger –exclude-query=“^(COPY|COMMIT)” /var/log/postgresql.log pgbadger -b “2012-06-25 10:56:11” -e “2012-06-25 10:59:11” /var/log/postgresql.log cat /var/log/postgres.log | pgbadger - # Log line prefix with stderr log output pgbadger –prefix ‘%t [%p]: user=%u,db=%d,client=%h’ /pglog/postgresql-2012-08-21* pgbadger –prefix ‘%m %u@%d %p %r %a : ‘ /pglog/postgresql.log # Log line prefix with syslog log output pgbadger –prefix ‘user=%u,db=%d,client=%h,appname=%a’ /pglog/postgresql-2012-08-21* # Use my 8 CPUs to parse my 10GB file faster, much faster pgbadger -j 8 /pglog/postgresql-10.1-main.log
Use URI notation for remote log file:
pgbadger http://184.108.40.206//var/log/postgresql/postgresql-10.1-main.log pgbadger ftp://firstname.lastname@example.org/postgresql-10.1-main.log pgbadger ssh://email@example.com:2222//var/log/postgresql/postgresql-10.1-main.log*
You can use together a local PostgreSQL log and a remote pgbouncer log file to parse:
pgbadger /var/log/postgresql/postgresql-10.1-main.log ssh://firstname.lastname@example.org/pgbouncer.log
Reporting errors every week by cron job:
30 23 * * 1 /usr/bin/pgbadger -q -w /var/log/postgresql.log -o /var/reports/pg_errors.html
Generate report every week using incremental behavior:
0 4 * * 1 /usr/bin/pgbadger -q
find /var/log/ -mtime -7 -name "postgresql.log*"-o /var/reports/pg_errors-
date +\%F.html -l /var/reports/pgbadger_incremental_file.dat
This supposes that your log file and HTML report are also rotated every week.
Or better, use the auto-generated incremental reports:
0 4 * * * /usr/bin/pgbadger -I -q /var/log/postgresql/postgresql.log.1 -O /var/www/pg_reports/
will generate a report per day and per week.
In incremental mode, you can also specify the number of weeks to keep in the reports:
/usr/bin/pgbadger –retention 2 -I -q /var/log/postgresql/postgresql.log.1 -O /var/www/pg_reports/
If you have a pg_dump at 23:00 and 13:00 each day during half an hour, you can use pgBadger as follow to exclude these periods from the report:
pgbadger –exclude-time “2013-09-.* (23|13):.” postgresql.log
This will help avoid having COPY statements, as generated by pg_dump, on top of the list of slowest queries. You can also use –exclude-appname “pg_dump” to solve this problem in a simpler way.
You can also parse journalctl output just as if it was a log file:
pgbadger –journalctl ‘journalctl -u postgresql-9.5’
or worst, call it from a remote host:
pgbadger -r 192.168.1.159 –journalctl ‘journalctl -u postgresql-9.5’
you don’t need to specify any log file at command line, but if you have other PostgreSQL log files to parse, you can add them as usual.
To rebuild all incremental html reports after, proceed as follow:
rm /path/to/reports/.js rm /path/to/reports/*.css pgbadger -X -I -O /path/to/reports/ –rebuild
it will also update all resource files (JS and CSS). Use -E or –explode if the reports were built using this option.
pgBadger also supports Heroku PostgreSQL logs using logplex format:
heroku logs -p postgres | pgbadger -f logplex -o heroku.html -
this will stream Heroku PostgreSQL log to pgbadger through stdin.
pgBadger can auto detect RDS and cloudwatch PostgreSQL logs using rds format:
pgbadger -f rds -o rds_out.html rds.log
Each CloudSQL Postgresql log is a fairly normal PostgreSQL log, but encapsulated in JSON format. It is autodetected by pgBadger but in case you need to force the log format use
pgbadger -f jsonlog -o cloudsql_out.html cloudsql.log
This is the same as with the jsonlog extension, the json format is different but pgBadger can parse both formats.
pgBadger also supports logs produced by CloudNativePG Postgres operator for Kubernetes:
pgbadger -f jsonlog -o cnpg_out.html cnpg.log
To create a cumulative report over a month use command:
pgbadger –month-report 2919-05 /path/to/incremental/reports/
this will add a link to the month name into the calendar view in incremental reports to look at report for month 2019 May. Use -E or –explode if the reports were built using this option.
pgBadger is a PostgreSQL log analyzer built for speed providing fully detailed reports based on your PostgreSQL log files. It’s a small standalone Perl script that outperforms any other PostgreSQL log analyzer.
pgBadger is able to autodetect your log file format (syslog, stderr, csvlog or jsonlog) if the file is long enough. It is designed to parse huge log files as well as compressed files. Supported compressed formats are gzip, bzip2, lz4, xz, zip and zstd. For the xz format you must have an xz version higher than 5.05 that supports the –robot option. lz4 files must be compressed with the –content-size option for pgbadger to determine the uncompressed file size. For the complete list of features, see below.
All charts are zoomable and can be saved as PNG images.
You can also limit pgBadger to only report errors or remove any part of the report using command-line options.
pgBadger supports any custom format set in the log_line_prefix directive of your postgresql.conf file as long as it at least specifies the %t and %p patterns.
pgBadger allows parallel processing of a single log file or multiple files through the use of the -j option specifying the number of CPUs.
If you want to save system performance you can also use log_duration instead of log_min_duration_statement to have reports on duration and number of queries only.
pgBadger reports everything about your SQL queries:
Overall statistics. The most frequent waiting queries. Queries that waited the most. Queries generating the most temporary files. Queries generating the largest temporary files. The slowest queries. Queries that took up the most time. The most frequent queries. The most frequent errors. Histogram of query times. Histogram of sessions times. Users involved in top queries. Applications involved in top queries. Queries generating the most cancellation. Queries most cancelled. The most time consuming prepare/bind queries
The following reports are also available with hourly charts divided into periods of five minutes:
SQL queries statistics. Temporary file statistics. Checkpoints statistics. Autovacuum and autoanalyze statistics. Cancelled queries. Error events (panic, fatal, error and warning). Error class distribution.
There are also some pie charts about distribution of:
Locks statistics. Queries by type (select/insert/update/delete). Distribution of queries type per database/application Sessions per database/user/client/application. Connections per database/user/client/application. Autovacuum and autoanalyze per table. Queries per user and total duration per user.
All charts are zoomable and can be saved as PNG images. SQL queries reported are highlighted and beautified automatically.
pgBadger is also able to parse PgBouncer log files and to create the following reports:
Request Throughput Bytes I/O Throughput Average Query Duration Simultaneous sessions Histogram of sessions times Sessions per database Sessions per user Sessions per host Established connections Connections per database Connections per user Connections per host Most used reserved pools Most Frequent Errors/Events
You can also have incremental reports with one report per day and a cumulative report per week. Two multiprocess modes are available to speed up log parsing, one using one core per log file, and the second using multiple cores to parse a single file. These modes can be combined.
Histogram granularity can be adjusted using the -A command-line option. By default, they will report the mean of each top queries/errors occurring per hour, but you can specify the granularity down to the minute.
pgBadger can also be used in a central place to parse remote log files using a passwordless SSH connection. This mode can be used with compressed files and in the multiprocess per file mode (-J), but cannot be used with the CSV log format.
Examples of reports can be found here: https://pgbadger.darold.net/#reports
If you plan to parse PostgreSQL CSV log files, you might need some Perl Modules:
Text::CSV_XS - to parse PostgreSQL CSV log files.
This module is optional, if you don’t have PostgreSQL log in the CSV format, you don’t need to install it.
If you want to export statistics as JSON file, you need an additional Perl module:
JSON::XS - JSON serialising/deserialising, done correctly and fast
This module is optional, if you don’t select the json output format, you don’t need to install it. You can install it on a Debian-like system using:
sudo apt-get install libjson-xs-perl
and on RPM-like system using:
sudo yum install perl-JSON-XS
Compressed log file format is autodetected from the file extension. If pgBadger finds a gz extension, it will use the zcat utility; with a bz2 extension, it will use bzcat; with lz4, it will use lz4cat; with zst, it will use zstdcat; if the file extension is zip or xz, then the unzip or xz utility will be used.
If those utilities are not found in the PATH environment variable, then use the –zcat command-line option to change this path. For example:
–zcat=“/usr/local/bin/gunzip -c” or –zcat=“/usr/local/bin/bzip2 -dc” –zcat=“C:\tools\unzip -p”
By default, pgBadger will use the zcat, bzcat, lz4cat, zstdcat and unzip utilities following the file extension. If you use the default autodetection of compression format, you can mix gz, bz2, lz4, xz, zip or zstd files. Specifying a custom value of –zcat option will remove the possibility of mixed compression format.
Note that multiprocessing cannot be used with compressed files or CSV files as well as under Windows platform.
Download the tarball from GitHub and unpack the archive as follow:
tar xzf pgbadger-11.x.tar.gz cd pgbadger-11.x/ perl Makefile.PL make && sudo make install
This will copy the Perl script pgbadger to /usr/local/bin/pgbadger by default and the man page into /usr/local/share/man/man1/pgbadger.1. Those are the default installation directories for ‘site’ install.
If you want to install all under /usr/ location, use INSTALLDIRS=‘perl’ as an argument of Makefile.PL. The script will be installed into /usr/bin/pgbadger and the manpage into /usr/share/man/man1/pgbadger.1.
For example, to install everything just like Debian does, proceed as follows:
perl Makefile.PL INSTALLDIRS=vendor
By default, INSTALLDIRS is set to site.
You must enable and set some configuration directives in your postgresql.conf before starting.
You must first enable SQL query logging to have something to parse:
log_min_duration_statement = 0
Here every statement will be logged, on a busy server you may want to increase this value to only log queries with a longer duration. Note that if you have log_statement set to ‘all’, nothing will be logged through the log_min_duration_statement directive. See the next chapter for more information.
pgBadger supports any custom format set in the log_line_prefix directive of your postgresql.conf file as long as it at least specifies a time escape sequence (%t, %m or %n) and a process-related escape sequence (%p or %c).
For example, with ‘stderr’ log format, log_line_prefix must be at least:
log_line_prefix = ‘%t [%p]: ‘
Log line prefix could add user, database name, application name and client ip address as follows:
log_line_prefix = ‘%t [%p]: user=%u,db=%d,app=%a,client=%h ‘
or for syslog log file format:
log_line_prefix = ‘user=%u,db=%d,app=%a,client=%h ‘
Log line prefix for stderr output could also be:
log_line_prefix = ‘%t [%p]: db=%d,user=%u,app=%a,client=%h ‘
or for syslog output:
log_line_prefix = ‘db=%d,user=%u,app=%a,client=%h ‘
You need to enable other parameters in postgresql.conf to get more information from your log files:
log_checkpoints = on log_connections = on log_disconnections = on log_lock_waits = on log_temp_files = 0 log_autovacuum_min_duration = 0 log_error_verbosity = default
Do not enable log_statement as its log format will not be parsed by pgBadger.
Of course your log messages should be in English with or without locale support:
pgBadger parser does not support other locales, like ‘fr_FR.UTF-8’ for example.
Considerations about log_min_duration_statement, log_duration and log_statement configuration directives.
If you want the query statistics to include the actual query strings, you must set log_min_duration_statement to 0 or more milliseconds.
If you just want to report duration and number of queries and don’t want all details about queries, set log_min_duration_statement to -1 to disable it and enable log_duration in your postgresql.conf file. If you want to add the most common query report, you can either choose to set log_min_duration_statement to a higher value or to enable log_statement.
Enabling log_min_duration_statement will add reports about slowest queries and queries that took up the most time. Take care that if you have log_statement set to ‘all’, nothing will be logged with log_min_duration_statement.
Warning: Do not enable both log_min_duration_statement, log_duration and log_statement all together, this will result in wrong counter values. Note that this will also increase drastically the size of your log. log_min_duration_statement should always be preferred.
To enable parallel processing you just have to use the -j N option where N is the number of cores you want to use.
pgBadger will then proceed as follow:
for each log file chunk size = int(file size / N) look at start/end offsets of these chunks fork N processes and seek to the start offset of each chunk each process will terminate when the parser reach the end offset of its chunk each process write stats into a binary temporary file wait for all children processes to terminate All binary temporary files generated will then be read and loaded into memory to build the html output.
With that method, at start/end of chunks pgBadger may truncate or omit a maximum of N queries per log file, which is an insignificant gap if you have millions of queries in your log file. The chance that the query that you were looking for is lost is near 0, this is why I think this gap is livable. Most of the time the query is counted twice but truncated.
When you have many small log files and many CPUs, it is speedier to dedicate one core to one log file at a time. To enable this behavior, you have to use option -J N instead. With 200 log files of 10MB each, the use of the -J option starts being really interesting with 8 cores. Using this method you will be sure not to lose any queries in the reports.
Here is a benchmark done on a server with 8 CPUs and a single file of 9.5GB.
Option | 1 CPU | 2 CPU | 4 CPU | 8 CPU ——–+———+——-+——-+—— -j | 1h41m18 | 50m25 | 25m39 | 15m58 -J | 1h41m18 | 54m28 | 41m16 | 34m45
With 200 log files of 10MB each, so 2GB in total, the results are slightly different:
Option | 1 CPU | 2 CPU | 4 CPU | 8 CPU ——–+——-+——-+——-+—— -j | 20m15 | 9m56 | 5m20 | 4m20 -J | 20m15 | 9m49 | 5m00 | 2m40
So it is recommended to use -j unless you have hundreds of small log files and can use at least 8 CPUs.
IMPORTANT: when you are using parallel parsing, pgBadger will generate a lot of temporary files in the /tmp directory and will remove them at the end, so do not remove those files unless pgBadger is not running. They are all named with the following template tmp_pgbadgerXXXX.bin so they can be easily identified.
pgBadger includes an automatic incremental report mode using option -I or –incremental. When running in this mode, pgBadger will generate one report per day and a cumulative report per week. Output is first done in binary format into the mandatory output directory (see option -O or –outdir), then in HTML format for daily and weekly reports with a main index file.
The main index file will show a dropdown menu per week with a link to each week report and links to daily reports of each week.
For example, if you run pgBadger as follows based on a daily rotated file:
0 4 * * * /usr/bin/pgbadger -I -q /var/log/postgresql/postgresql.log.1 -O /var/www/pg_reports/
you will have all daily and weekly reports for the full running period.
In this mode, pgBadger will create an automatic incremental file in the output directory, so you don’t have to use the -l option unless you want to change the path of that file. This means that you can run pgBadger in this mode each day on a log file rotated each week, and it will not count the log entries twice.
Incremental reports can be rebuilt after a pgbadger report fix or a new feature to update all HTML reports. To rebuild all reports where a binary file is still present, proceed as follow:
rm /path/to/reports/.js rm /path/to/reports/.css pgbadger -X -I -O /path/to/reports/ –rebuild
it will also update all resource files (JS and CSS). Use -E or –explode if the reports were built using this option.
By default, pgBadger in incremental mode only computes daily and weekly reports. If you want monthly cumulative reports, you will have to use a separate command to specify the report to build. For example, to build a report for August 2019:
pgbadger -X –month-report 2019-08 /var/www/pg_reports/
this will add a link to the month name into the calendar view of incremental reports to look at monthly report. The report for a current month can be run every day, it is entirely rebuilt each time. The monthly report is not built by default because it could take a lot of time following the amount of data.
If reports were built with the per-database option ( -E | –explode ), it must be used too when calling pgbadger to build monthly report:
pgbadger -E -X –month-report 2019-08 /var/www/pg_reports/
This is the same when using the rebuild option ( -R | –rebuild ).
Using the binary format it is possible to create custom incremental and cumulative reports. For example, if you want to refresh a pgBadger report each hour from a daily PostgreSQL log file, you can proceed by running the following commands each hour:
pgbadger –last-parsed .pgbadger_last_state_file -o sunday/hourX.bin /var/log/pgsql/postgresql-Sun.log
to generate the incremental data files in binary format. And to generate the fresh HTML report from that binary file:
Or as another example, if you generate one log file per hour and you want reports to be rebuilt each time the log file is rotated, proceed as follows:
pgbadger -o day1/hour01.bin /var/log/pgsql/pglog/postgresql-2012-03-23_10.log pgbadger -o day1/hour02.bin /var/log/pgsql/pglog/postgresql-2012-03-23_11.log pgbadger -o day1/hour03.bin /var/log/pgsql/pglog/postgresql-2012-03-23_12.log …
When you want to refresh the HTML report, for example, each time after a new binary file is generated, just do the following:
pgbadger -o day1_report.html day1/.bin
Adjust the commands to suit your particular needs.
JSON format is good for sharing data with other languages, which makes it easy to integrate pgBadger result into other monitoring tools, like Cacti or Graphite.
pgBadger is an original work from Gilles Darold.
The pgBadger logo is an original creation of Damien Cazeils.
The pgBadger v4.x design comes from the “Art is code” company.
This web site is a work of Gilles Darold.
pgBadger is maintained by Gilles Darold and everyone who wants to contribute.
Many people have contributed to pgBadger, they are all quoted in the Changelog file.
pgBadger is free software distributed under the PostgreSQL Licence.
Copyright © 2012-2023, Gilles Darold
A modified version of the SQL::Beautify Perl Module is embedded in pgBadger with copyright © 2009 by Jonas Kramer and is published under the terms of the Artistic License 2.0.