]> granicus.if.org Git - pgbadger/commitdiff
Update documentation about log_duration, log_min_duration_statement and log_statement.
authorDarold Gilles <gilles@darold.net>
Mon, 18 Feb 2013 22:19:32 +0000 (23:19 +0100)
committerDarold Gilles <gilles@darold.net>
Mon, 18 Feb 2013 22:19:32 +0000 (23:19 +0100)
README
doc/pgBadger.pod

diff --git a/README b/README
index 0a5373a8f26421a2a9387dd0777990194af23538..16d74f792ffb3b4088809c79cfb45d8e37212818 100644 (file)
--- a/README
+++ b/README
@@ -81,10 +81,6 @@ SYNOPSIS
         --disable-lock         : do not generate lock report.
         --disable-temporary    : do not generate temporary report.
         --disable-checkpoint   : do not generate checkpoint report.
-        --enable-log_duration  : force pgBadger to use log_duration even if
-                                 log_min_duration_statement format is autodetected.
-        --enable-log_min_duration: force pgBadger to use log_min_duration even if
-                                 log_duration format is autodetected.
 
     Examples:
 
@@ -195,15 +191,16 @@ REQUIREMENT
     files.
 
 POSTGRESQL CONFIGURATION
-    You must enable some configuration directives in your postgresql.conf
-    before starting.
+    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
 
-    Note that pgBadger is not compatible with statement logs provided by
-    log_statement and log_duration. See next chapter for more information.
+    Here every statement will be logged, on busy server you may want to
+    increase this value to only log queries with higher duration time. See
+    next chapter for more information.
 
     With 'stderr' log format, log_line_prefix must be at least:
 
@@ -243,6 +240,20 @@ POSTGRESQL CONFIGURATION
 
     but this is not only recommended by pgBadger.
 
+log_min_duration_statement, log_duration and log_statement
+    If you want full statistics reports you must set
+    log_min_duration_statement to 0i 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 request report you can either choose to set
+    log_min_duration_statement to a higher value or choose to enable
+    log_statement.
+
+    Enabling log_min_duration_statement will add reports about slowest
+    queries and queries that took up the most time.
+
 Parallel processing
     To enable parallel processing you just have to use the -j N option where
     N is the number of cores you want to use.
@@ -271,34 +282,6 @@ Parallel processing
     have to use option -J N instead. With 200 log files of 10MB each the use
     of the -J option start being really interesting with 8 Cores.
 
-log_min_duration_statement versus log_duration
-    If you want full statistics reports from your log file you must set
-    log_min_duration_statement = 0. 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 and enable log_duration. If you want to
-    report only queries that took more than 5 seconds for example but still
-    want to report all query durations and number of queries you will need
-    to generate 2 reports. One using the log_min_duration_statement and the
-    second using the log_duration. Proceed as follow:
-
-            pgbadger --enable-log_duration /var/log/postgresql.log
-
-    to generate hourly statistics about the number of queries and duration
-    stats. To generate detailed reports about queries use the following
-    command:
-
-            pgbadger --enable-log_min_duration /var/log/postgresql.log
-
-    Note that enabling log_statement will not help at all and enabling those
-    two options in the same command will report an error.
-
-    Use those options if you don't want to log every query to preserve your
-    I/O but still want to know the slowest queries over a certain duration
-    and still have a report on the number of queries and their duration.
-    Otherwise if you don't have too much of a performance hit with
-    log_min_duration_statement set to 0, do not enable log_duration in your
-    postgresql.conf file.
-
 INSTALLATION
     Download the tarball from github and unpack the archive as follow:
 
index 141a17c3972c9998b196068315351dcd1efc42e7..ea8b3ac0068ba96fb94604cff36971ad59d7fbf6 100644 (file)
@@ -83,10 +83,6 @@ Options:
     --disable-lock         : do not generate lock report.
     --disable-temporary    : do not generate temporary report.
     --disable-checkpoint   : do not generate checkpoint report.
-    --enable-log_duration  : force pgBadger to use log_duration even if
-                             log_min_duration_statement format is autodetected.
-    --enable-log_min_duration: force pgBadger to use log_min_duration even if
-                             log_duration format is autodetected.
 
 Examples:
 
@@ -181,14 +177,16 @@ Note that multiprocessing can not be used with compressed files nor CSV files.
 
 =head1 POSTGRESQL CONFIGURATION
 
-You must enable some configuration directives in your postgresql.conf before starting.
+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
 
-Note that pgBadger is not compatible with statement logs provided by log_statement and log_duration.
-See next chapter for more information.
+Here every statement will be logged, on busy server you may want to increase
+this value to only log queries with higher duration time. See next chapter for
+more information.
 
 With 'stderr' log format, log_line_prefix must be at least:
 
@@ -226,6 +224,20 @@ Of course your log messages should be in English without locale support:
 
 but this is not only recommended by pgBadger.
 
+=head1 log_min_duration_statement, log_duration and log_statement
+
+If you want full statistics reports you must set log_min_duration_statement to
+0i 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 request report you can either choose to set log_min_duration_statement
+to a higher value or choose to enable log_statement.
+
+Enabling log_min_duration_statement will add reports about slowest queries and
+queries that took up the most time.
+
 =head1 Parallel processing
 
 To enable parallel processing you just have to use the -j N option where N is
@@ -254,30 +266,6 @@ 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
 start being really interesting with 8 Cores.
 
-=head1 log_min_duration_statement versus log_duration
-
-If you want full statistics reports from your log file you must set log_min_duration_statement = 0.
-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 and enable log_duration. If you want to report only queries that
-took more than 5 seconds for example but still want to report all query durations and number of
-queries you will need to generate 2 reports. One using the log_min_duration_statement and the second
-using the log_duration. Proceed as follow:
-
-       pgbadger --enable-log_duration /var/log/postgresql.log
-
-to generate hourly statistics about the number of queries and duration stats. To generate detailed
-reports about queries use the following command:
-
-       pgbadger --enable-log_min_duration /var/log/postgresql.log
-
-Note that enabling log_statement will not help at all and enabling those two options in the same
-command will report an error.
-
-Use those options if you don't want to log every query to preserve your I/O but still want to know
-the slowest queries over a certain duration and still have a report on the number of queries and their
-duration. Otherwise if you don't have too much of a performance hit with log_min_duration_statement
-set to 0, do not enable log_duration in your postgresql.conf file.
-
 =head1 INSTALLATION
 
 Download the tarball from github and unpack the archive as follow: