diff options
author | Luke Chen <luke.chen@mongodb.com> | 2017-12-14 11:34:35 -0500 |
---|---|---|
committer | Luke Chen <luke.chen@mongodb.com> | 2017-12-14 11:34:35 -0500 |
commit | ec894eecfba4009e2ccd685e15351e4dae5848ad (patch) | |
tree | b347f774ed408c0ff275d6889cc022ab8afe727b /src/third_party/wiredtiger/src/docs | |
parent | fe40a36217a2b4e4064165340d44cc1442d84e13 (diff) | |
download | mongo-ec894eecfba4009e2ccd685e15351e4dae5848ad.tar.gz |
Import wiredtiger: 1a29eac4dc8cf82de437292da546e3f4039268a4 from branch mongodb-3.8
ref: 596a3c7c01..1a29eac4dc
for: 3.7.1
WT-3079 Make sure eviction visits all trees
WT-3133 Detect or track long latency operations
WT-3295 Allow LSM to merge into custom data sources
WT-3587 Remove HAVE_VERBOSE conditional compilation
WT-3654 Fix warning in Windows build on evergreen
WT-3716 Restore the WT_VERB_TEMPORARY verbose flag.
WT-3720 flags macros cast flags to unsigned values, hiding warnings.
WT-3732 Handle adding WT indices while cursors on the table are open
WT-3734 Fix undefined behavior in verbose output
WT-3738 Review internal session allocation accounting
WT-3753 Building on Windows --enable-java
WT-3772 Hot backup causes uncontrolled growth of WiredTigerPreplog files
WT-3774 Enhance Python lookaside testing to cover cursor modify
WT-3776 Cursor remove operation unpins page too early
WT-3780 Improve error messages on invalid WT_CURSOR::modify usage
WT-3783 Fix transaction isolation to use the correct enum
WT-3786 Transactions with timestamps should read their writes
WT-3787 test_compact02 failed as compaction halted due to eviction pressure
WT-3790 Switch statistics to rdtsc from epoch calls
WT-3793 WiredTiger page debug dump functions should unpack integer keys
WT-3794 Coverity 1383547 and lint
WT-3795 lint cleanups for the op-tracking software, reduce record write size.
Diffstat (limited to 'src/third_party/wiredtiger/src/docs')
5 files changed, 48 insertions, 8 deletions
diff --git a/src/third_party/wiredtiger/src/docs/build-posix.dox b/src/third_party/wiredtiger/src/docs/build-posix.dox index 3e7f8f37acd..7192a9c2322 100644 --- a/src/third_party/wiredtiger/src/docs/build-posix.dox +++ b/src/third_party/wiredtiger/src/docs/build-posix.dox @@ -142,10 +142,6 @@ Build the WiredTiger <a href="http://www.python.org">Python</a> API. Configure WiredTiger for <a href="http://code.google.com/p/snappy/">snappy</a> compression; see @ref compression for more information. -@par \c --enable-verbose -Configure WiredTiger to support the \c verbose configuration string to -::wiredtiger_open. - @par \c --enable-zlib Configure WiredTiger for <a href="http://www.zlib.net/">zlib</a> compression; see @ref compression for more information. diff --git a/src/third_party/wiredtiger/src/docs/build-windows.dox b/src/third_party/wiredtiger/src/docs/build-windows.dox index 79df6b9712d..dcd16e30ad1 100644 --- a/src/third_party/wiredtiger/src/docs/build-windows.dox +++ b/src/third_party/wiredtiger/src/docs/build-windows.dox @@ -89,6 +89,10 @@ Configure WiredTiger to sleep and wait for a debugger to attach on failure. Configure WiredTiger to perform various run-time diagnostic tests. <b>DO NOT</b> configure this option in production environments. +@par \c --enable-java +Build the WiredTiger <a href="http://www.java.com">Java</a> API, +requires path to swig.exe and path to Java JDK directory, comma separated. + @par \c --enable-python Build the WiredTiger <a href="http://www.python.org">Python</a> API, requires path to swig.exe on Windows. @@ -97,10 +101,6 @@ requires path to swig.exe on Windows. Configure WiredTiger for <a href="http://code.google.com/p/snappy/">snappy</a> compression; see @ref compression for more information. -@par \c --enable-verbose -Configure WiredTiger to support the \c verbose configuration string to -::wiredtiger_open. - @par \c --enable-zlib Configure WiredTiger for <a href="http://www.zlib.net/">zlib</a> compression; see @ref compression for more information. diff --git a/src/third_party/wiredtiger/src/docs/operation_tracking.dox b/src/third_party/wiredtiger/src/docs/operation_tracking.dox new file mode 100644 index 00000000000..b49ec1aa91a --- /dev/null +++ b/src/third_party/wiredtiger/src/docs/operation_tracking.dox @@ -0,0 +1,39 @@ +/*! @m_page{{c,java},operation_tracking,Track function calls} + +When this option is enabled, WiredTiger tracks all API calls as well as certain +functions that are deemed important for performance, such as eviction-related +functions. Tracking is performed by generating a log record when the WiredTiger +library enters and exits a tracked function. A log record contains a function +name and its timestamp. For the purposes of efficiency, the timestamp on most +platforms is obtained directly from the CPU register, so the units of time +correspond to processor clock ticks. + +By default, the log files are produced in the sub-directory +`operation_tracking` of the database home directory. To change the +destination directory, use the `path` sub-option of the +`operation_tracking` option. + +Operation tracking produces two kinds of files: the binary log files +and the map file. The map file is needed to convert the binary logs +into text. The map file contains the mapping between numeric function +ids used in the log files and the human-readable function name. The +map file is called `optrack-map.<pid>`, where `pid` is the id of +the process that generated the map file. Log files have names that +look like `optrack.<pid>.<tid>`, where `tid` is the numeric id of the +WiredTiger session that generated the log file. + +To convert binary log files to text, run the wt_optrack_decode.py script in the +tools directory of the WiredTiger distribution. The script takes as arguments +the list of log files and the name of the map file with the `-m` option. Suppose +you would like to convert the log files generated by a process with `pid +1234`. Then you would run the script as follows: + +``` +python wt_optrack_decode.py -m optrack-map.1234 optrack.1234.* +``` + +Enabling operation tracking may generate performance overhead if the tracked +functions are executed frequently. Please be aware of this consequence and +measure your performance before deciding whether to enable operation tracking. + +*/ diff --git a/src/third_party/wiredtiger/src/docs/programming.dox b/src/third_party/wiredtiger/src/docs/programming.dox index 7274fb8078a..3ddb0c376c5 100644 --- a/src/third_party/wiredtiger/src/docs/programming.dox +++ b/src/third_party/wiredtiger/src/docs/programming.dox @@ -44,6 +44,7 @@ each of which is ordered by one or more columns. - @subpage in_memory - @subpage cursor_join - @subpage cursor_log +- @subpage operation_tracking - @ref transaction_named_snapshots - @subpage rebalance - @subpage shared_cache diff --git a/src/third_party/wiredtiger/src/docs/spell.ok b/src/third_party/wiredtiger/src/docs/spell.ok index 112e5e815fe..d5347709248 100644 --- a/src/third_party/wiredtiger/src/docs/spell.ok +++ b/src/third_party/wiredtiger/src/docs/spell.ok @@ -44,6 +44,7 @@ Google's HyperDex HyperLevelDB IEC +JDK JavaScript KMS LD @@ -368,6 +369,7 @@ objectsin ol oltp oob +optrack optype os outlier @@ -382,6 +384,7 @@ pget php plantuml png +pid posix pre prepends @@ -462,6 +465,7 @@ substring superset sys sz +tid tRuE tablename tcl |