diff options
Diffstat (limited to 'src/third_party/wiredtiger/src/docs/devdoc-index.dox')
| -rw-r--r-- | src/third_party/wiredtiger/src/docs/devdoc-index.dox | 35 |
1 files changed, 29 insertions, 6 deletions
diff --git a/src/third_party/wiredtiger/src/docs/devdoc-index.dox b/src/third_party/wiredtiger/src/docs/devdoc-index.dox index 7ada556aa1a..d88826cb52d 100644 --- a/src/third_party/wiredtiger/src/docs/devdoc-index.dox +++ b/src/third_party/wiredtiger/src/docs/devdoc-index.dox @@ -1,13 +1,12 @@ /*! @page devdoc-index Developer Documentation +@subpage devdoc-schema + Most applications begin to make use of WiredTiger by creating a table (or other data object) to store their data in. Create is one of several schema operations available in WiredTiger. -For more information on how schema operations are implemented in WiredTiger, -see: - -- @subpage devdoc-schema +@subpage devdoc-dhandle-lifecycle An internal structure called Data Handle (dhandle) is used to represent and access a table in WiredTiger. A dhandle gets created when a table is accessed @@ -15,8 +14,32 @@ for the first time. It is kept in a global list and is shared across the sessions. When a dhandle is not needed anymore and has been idle for a while, it is closed and destroyed, releasing all the resources associated with it. -For more information on the lifecycle of a dhandle, see: +@subpage devdoc-statistics + +WiredTiger can generate statistics that are useful for providing information +necessary when performance tuning your WiredTiger application. Here we focus +on analyzing and reviewing the data generated by the statistics logging +functionality. + +@subpage devdoc-optrack + +The purpose of operation tracking is to visualize WiredTiger's execution so +that correlations between performance anomalies are easily spotted. This +operation tracking tutorial provides a general overview of operation tracking +and describes ways to visualize the data in fine detail. + +@subpage devdoc-perf + +Linux `perf` is a tool that allows counting and sampling of various events in +the hardware and in the kernel. Hardware events are available via performance +monitoring units (PMU); they measure CPU cycles, cache misses, branches, etc. +Kernel events include scheduling context switches, page faults and block I/O. +Here we provide a quick cheat sheet of how to use `perf` with WiredTiger. + +@subpage devdoc-perf-flamegraphs -- @subpage devdoc-dhandle-lifecycle +Why is my CPU busy? FlameGraphs help visually summarize on-CPU call stacks and +allow for the quick identification of hot code paths. Here we explain how to +generate FlameGraphs from WiredTiger `perf` data. */ |