From 77c637a74df21f697dac76eb5c55ac5a45fde257 Mon Sep 17 00:00:00 2001 From: Justin Pryzby Date: Sat, 26 Mar 2022 00:26:33 -0500 Subject: [PATCH 07/19] doc review: pgbench retries 4a39f87acd6e681e5ded1239391d8a92645b43d6 --- doc/src/sgml/ref/pgbench.sgml | 40 +++++++++++++++++------------------ 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/src/sgml/ref/pgbench.sgml b/doc/src/sgml/ref/pgbench.sgml index 659fe2d984d..f855249a3dd 100644 --- a/doc/src/sgml/ref/pgbench.sgml +++ b/doc/src/sgml/ref/pgbench.sgml @@ -541,11 +541,11 @@ pgbench options d skipped. - When the option is used, the transaction with - serialization or deadlock error cannot be retried if the total time of + When the option is used, a transaction with + serialization or deadlock error will not be retried if the total time of all its tries is greater than limit ms. To limit only the time of tries and not their number, use - --max-tries=0. By default option + --max-tries=0. By default, the option is set to 1 and transactions with serialization/deadlock errors are not retried. See for more information about retrying @@ -622,7 +622,7 @@ pgbench options d throttling (), the latency is computed with respect to the transaction scheduled start time, not the actual transaction beginning time, thus it also includes the average schedule lag time. - When is used to enable transactions retries + When is used to enable transaction retries after serialization/deadlock errors, the report includes the number of retried transactions and the sum of all retries. @@ -818,7 +818,7 @@ pgbench options d Print messages about all errors and failures (errors without retrying) - including which limit for retries was violated and how far it was + including which limit for retries was exceeded and how far it was exceeded for the serialization/deadlock failures. (Note that in this case the output can be significantly increased.). See for more information. @@ -2433,7 +2433,7 @@ END; - If option is used, the type of + If the option is used, the type of failure is reported in the time like this: 3 0 47423 0 1499414498 34501 3 @@ -2773,12 +2773,12 @@ statement latencies in milliseconds, failures and retries: Errors of the main program. They are the most serious and always result - in an immediate exit from the pgbench with + in an immediate exit from pgbench with the corresponding error message. They include: - errors at the beginning of the pgbench + errors at the beginning of pgbench (e.g. an invalid option value); @@ -2791,7 +2791,7 @@ statement latencies in milliseconds, failures and retries: errors before starting threads (e.g. we could not connect to the - database server / the syntax error in the meta command / thread + database server / syntax error in the meta command / thread creation failure); @@ -2813,7 +2813,7 @@ statement latencies in milliseconds, failures and retries: - Direct client errors. They lead to immediate exit from the + Direct client errors. They lead to immediate exit from pgbench with the corresponding error message only in the case of an internal pgbench error (which are supposed to never occur...). Otherwise in the worst @@ -2829,11 +2829,11 @@ statement latencies in milliseconds, failures and retries: - Client's run is aborted in case of a serious error, for example, the - connection with the database server was lost or the end of script reached - without completing the last transaction. In addition, if an execution of SQL + A client's run is aborted in case of a serious error; for example, the + connection with the database server was lost or the end of script was reached + without completing the last transaction. In addition, if execution of an SQL or meta command fails for reasons other than serialization or deadlock errors, - the client is aborted. Otherwise, if an SQL fails with serialization or + the client is aborted. Otherwise, if an SQL command fails with serialization or deadlock errors, the client is not aborted. In such cases, the current transaction is rolled back, which also includes setting the client variables as they were before the run of this transaction (it is assumed that one @@ -2845,21 +2845,21 @@ statement latencies in milliseconds, failures and retries: time of retries (specified by the option) / the end of benchmark (specified by the option). If the last trial run fails, this transaction will be reported as failed but - the client is not aborted and continue to work. + the client is not aborted and continues to work. - Without specifying the option a transaction will + Without specifying the option, a transaction will never be retried after a serialization or deadlock error because its default - values is 1. Use an unlimited number of tries (--max-tries=0) + value is 1. Use an unlimited number of tries (--max-tries=0) and the option to limit only the maximum time of tries. You can also use the option to limit the benchmark duration under an unlimited number of tries. Be careful when repeating scripts that contain multiple transactions: the - script is always retried completely, so the successful transactions can be + script is always retried completely, so successful transactions can be performed several times. @@ -2879,7 +2879,7 @@ statement latencies in milliseconds, failures and retries: The main report contains the number of failed transactions. If the option is not equal to 1, the main report also - contains the statistics related to retries: the total number of retried + contains statistics related to retries: the total number of retried transactions and total number of retries. The per-script report inherits all these fields from the main report. The per-statement report displays retry statistics only if the option is not equal to 1. @@ -2890,7 +2890,7 @@ statement latencies in milliseconds, failures and retries: aggregation logs, as well as in the main and per-script reports, use the option. If you also want to distinguish all errors and failures (errors without retrying) by type including which - limit for retries was violated and how far it was exceeded for the + limit for retries was exceeded and how much it was exceeded by for the serialization/deadlock failures, use the option. -- 2.17.1