From 416c5578b7b3590176cae7f5e88ba31d992c8775 Mon Sep 17 00:00:00 2001 From: Balachandar Namasivayam Date: Mon, 9 Dec 2019 18:36:29 -0800 Subject: [PATCH] Add transaction logging option to python api documentation. --- documentation/sphinx/source/api-common.rst.inc | 8 ++++++++ documentation/sphinx/source/api-python.rst | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/documentation/sphinx/source/api-common.rst.inc b/documentation/sphinx/source/api-common.rst.inc index 23b2b22045..854d8a5baf 100644 --- a/documentation/sphinx/source/api-common.rst.inc +++ b/documentation/sphinx/source/api-common.rst.inc @@ -441,6 +441,14 @@ Sets the maximum escaped length of key and value fields to be logged to the trace file via the LOG_TRANSACTION option, after which the field will be truncated. A negative value disables truncation. One can set the default max field length for all transactions by calling |transaction-logging-max-field-length-database-option|. +.. |option-set--debug-transaction-identifier| replace:: + + Sets a client provided identifier for the transaction that will be used in scenarios like tracing or profiling. Client trace logging or transaction profiling must be separately enabled. + +.. |option-set-log-transaction| replace:: + + Enables tracing for this transaction and logs results to the client trace logs. The DEBUG_TRANSACTION_IDENTIFIER option must be set before using this option, and client trace logging must be enabled and to get log output. + .. |future-blurb1| replace:: Many FoundationDB API functions return "future" objects. A brief overview of futures is included in the :doc:`class scheduling tutorial `. Most future objects behave just like a normal object, but block when you use them for the first time if the asynchronous function which returned the future has not yet completed its action. A future object is considered ready when either a value is available, or when an error has occurred. diff --git a/documentation/sphinx/source/api-python.rst b/documentation/sphinx/source/api-python.rst index 7ba7b4421e..24bad9d318 100644 --- a/documentation/sphinx/source/api-python.rst +++ b/documentation/sphinx/source/api-python.rst @@ -881,6 +881,14 @@ Transaction options |option-set-transaction-logging-max-field-length-blurb| +.. method:: Transaction.options.set_debug_transaction_identifier(identifier) + + |option-set--debug-transaction-identifier| + +.. method:: Transaction.options.set_log_transaction() + + |option-set-log-transaction| + .. _api-python-future: Future objects