cat doc/pgBadger.pod | grep "=head1 " | sed 's/^=head1 \(.*\)/- [\1](#\1)/' | sed 's/ /-/g' | sed 's/--/- /' > $@.md
sed -i '1s/^/### TABLE OF CONTENTS\n\n/' $@.md
echo >> $@.md
- pod2markdown $^ | sed 's/^# /### /' >> $@.md
+ pod2markdown $^ | sed 's/^## /#### /' | sed 's/^# /### /' >> $@.md
endif
.INTERMEDIATE: doc/synopsis.pod
rm /path/to/reports/*.css
pgbadger -X -I -O /path/to/reports/ --rebuild
- it will also update all resource files (JS and CSS).
+ it will also update all resource files (JS and CSS). Use -E or --explode
+ if the reports were built using this option.
pgBadger also support Heroku PostgreSQL logs using logplex format:
pgbadger --month-report 2919-05 /path/to/incremantal/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.
+ incremental reports to look at report for month 2019 May. Use -E or
+ --explode if the reports were built using this option.
DESCRIPTION
pgBadger is a PostgreSQL log analyzer built for speed with fully reports
files in the output directory. The resources will then be loaded using
script and link tags.
+ Rebuilding reports
+ 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.
+
+ Monthly reports
By default pgBadger in incremental mode only compute 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 is not built by default because it could take 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 2919-08 /var/www/pg_reports/
+
+ This is the same when using the rebuild option ( -R | --rebuild ).
+
BINARY FORMAT
Using the binary format it is possible to create custom incremental and
cumulative reports. For example, if you want to refresh a pgBadger
rm /path/to/reports/*.css
pgbadger -X -I -O /path/to/reports/ --rebuild
-it will also update all resource files (JS and CSS).
+it will also update all resource files (JS and CSS). Use -E or --explode
+if the reports were built using this option.
pgBadger also support Heroku PostgreSQL logs using logplex format:
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.
### DESCRIPTION
the output directory. The resources will then be loaded using script and
link tags.
+#### Rebuilding reports
+
+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.
+
+#### Monthly reports
+
By default pgBadger in incremental mode only compute 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:
every day it is entirely rebuilt each time. The monthly report is not built by
default because it could take 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 2919-08 /var/www/pg_reports/
+
+This is the same when using the rebuild option ( -R | --rebuild ).
+
### BINARY FORMAT
Using the binary format it is possible to create custom incremental and
rm /path/to/reports/*.css
pgbadger -X -I -O /path/to/reports/ --rebuild
-it will also update all resource files (JS and CSS).
+it will also update all resource files (JS and CSS). Use -E or --explode
+if the reports were built using this option.
pgBadger also support Heroku PostgreSQL logs using logplex format:
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.
=head1 DESCRIPTION
the output directory. The resources will then be loaded using script and
link tags.
+=head2 Rebuilding reports
+
+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.
+
+=head2 Monthly reports
+
By default pgBadger in incremental mode only compute 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:
every day it is entirely rebuilt each time. The monthly report is not built by
default because it could take 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 2919-08 /var/www/pg_reports/
+
+This is the same when using the rebuild option ( -R | --rebuild ).
+
=head1 BINARY FORMAT
Using the binary format it is possible to create custom incremental and
rm /path/to/reports/*.css
pgbadger -X -I -O /path/to/reports/ --rebuild
-it will also update all resource files (JS and CSS).
+it will also update all resource files (JS and CSS). Use -E or --explode
+if the reports were built using this option.
pgBadger also support Heroku PostgreSQL logs using logplex format:
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.
};
# Note that usage must be terminated by an extra newline
projects / pgbadger / commitdiff