pgBadger 13.2 Documentation on PIG.CENTER

Download and Installation

Mon, 01 Jan 0001 00:00:00 +0000

Choose a distribution channel

Channel	Use it for	Location
Official release	Source tarballs and release notes	GitHub Releases
RPM package	RPM-based Linux distributions	PostgreSQL Yum Repository
Debian/Ubuntu package	APT-based Linux distributions	PostgreSQL Apt Repository
Development source	Current unreleased code	darold/pgbadger

The documentation snapshot in this site is based on the 13.2 source tree. Always check the release page before downloading: the local snapshot is intentionally fixed, while upstream releases continue to change.

Command-Line Reference

Mon, 01 Jan 0001 00:00:00 +0000

This page preserves the command reference generated from the pinned upstream source. Option names and help text remain verbatim so they can be compared directly with pgbadger --help.

Usage and options

Usage: pgbadger [options] logfile […]

PostgreSQL log analyzer with fully detailed reports and graphs.

Arguments:

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.

Options:

PostgreSQL Logging Configuration

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger can only report information that PostgreSQL writes to the log. Start with a parseable prefix and a deliberate statement-logging policy, then add the operational events you want to analyze.

Minimum query logging

To include query text and duration, enable duration-based statement logging:

log_min_duration_statement = 0

0 logs every completed statement. On a busy server, choose a higher threshold in milliseconds to control log volume. Measure the overhead and storage growth before enabling a low threshold in production.

Parallel Processing

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger has two complementary multiprocessing modes. Choose according to the shape of the input, not simply the number of CPUs.

Option	Parallel unit	Best fit	Main constraint
`-j N` / `--jobs N`	chunks of one log file	one large, seekable log	chunk boundaries can duplicate or omit a small number of queries
`-J N` / `--Jobs N`	whole log files	many independent logs	useful only when enough files are available to keep workers busy

Split one large file with `-j`

$ pgbadger -j 8 /var/log/postgresql/postgresql.log

The upstream algorithm divides each file into N byte ranges, forks one parser per range, writes temporary binary statistics, then merges those statistics into the final report.

Incremental Reports

Mon, 01 Jan 0001 00:00:00 +0000

Incremental mode stores parsed statistics in binary form, then builds one HTML report per day, a cumulative report per week, and a calendar-style index linking them together. It is intended for repeated processing of rotated logs without counting the same entries again.

Build daily and weekly reports

Run pgBadger after the daily log rotation and provide a persistent output directory:

0 4 * * * /usr/bin/pgbadger -I -q /var/log/postgresql/postgresql.log.1 -O /var/www/pg_reports/

-I enables incremental mode and -O selects the directory that holds the binary state, calendar index, and generated reports. pgBadger maintains its own incremental state in that directory, so --last-parsed is unnecessary unless you deliberately want the state file elsewhere.

Output Formats

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger selects output from the filename extension or from -x / --extension. Use -o / --outfile more than once to create multiple formats from the same parse.

Format	Typical extension	Best use
HTML	`.html`	interactive, human-readable report with charts
Text	`.txt`	terminal review and plain archival output
Binary	`.bin`	mergeable intermediate statistics and report rebuilds
JSON	`.json`	integration with other software; requires `JSON::XS`
Raw CSV	chosen output file	row-oriented extraction with `--dump-raw-csv`

HTML and text

The default output is out.html:

Sample Reports

Mon, 01 Jan 0001 00:00:00 +0000

The example content was generated by pgBadger 11.8 in May 2022. The original examples are stored with this site, so report navigation, charts, styles, and scripts remain available without reaching the upstream server.

Example	What it demonstrates	Local copy
Complete report	PostgreSQL activity together with PgBouncer statistics	Open the complete report
Incremental report	Calendar index, weekly aggregation, and daily pages	Open the incremental index
Errors and events	A report restricted to errors and operational events	Open the error report

Complete report

The complete report is a self-contained HTML document. Use its top navigation to inspect global statistics, queries, sessions, connections, temporary files, checkpoints, autovacuum activity, locks, and PgBouncer-specific charts.

Support and Contributing

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger is maintained as an open project. Bug reports, feature proposals, documentation fixes, and patches are handled through the upstream GitHub repository.

Bugs and feature requests

Upgrade to the newest released version and confirm the behavior still occurs.
Search open issues and closed issues for an existing answer.
Reduce the problem to the smallest safe log sample and command line that still reproduces it.
Remove credentials, sensitive SQL, bind values, host names, addresses, and business data.
Open a new issue with the pgBadger version, operating system, input format, exact options, observed result, and expected result.

For crashes or parser mistakes, include only the minimum sanitized log lines needed to reproduce the boundary. A complete production log or generated report is rarely appropriate for a public issue.

License and Credits

Mon, 01 Jan 0001 00:00:00 +0000

pgBadger is free and open-source software distributed under the PostgreSQL License. It may be used, copied, modified, and distributed without a fee, subject to retaining the copyright and license notices.

PostgreSQL License

Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.

pgBadger 13.2 Documentation on PIG.CENTER

Download and Installation

Choose a distribution channel

Command-Line Reference

Usage and options

PostgreSQL Logging Configuration

Minimum query logging

Parallel Processing

Split one large file with -j

Incremental Reports

Build daily and weekly reports

Output Formats

HTML and text

Sample Reports

Complete report

Support and Contributing

Bugs and feature requests

License and Credits

PostgreSQL License

Split one large file with `-j`