Added documentation for wtstats.py

5 files changed, 42 insertions, 0 deletions

diff --git a/src/docs/images/wtstats.png b/src/docs/images/wtstats.png
new file mode 100644
index 00000000000..f65a2871b6f
--- /dev/null
+++ b/src/docs/images/wtstats.png
diff --git a/src/docs/performance.dox b/src/docs/performance.dox
index 5b9d6c40e7b..2284e1e1d4f 100644
--- a/src/docs/performance.dox
+++ b/src/docs/performance.dox
@@ -24,4 +24,7 @@ investigate performance and tune their WiredTiger applications.
 <h2>Simulating workloads</h2>
 - @subpage wtperf
 
+<h2>Visualizing performance</h2>
+- @subpage wtstats
+
  */
diff --git a/src/docs/spell.ok b/src/docs/spell.ok
index 2fd7e5f0ad2..56d1aa1170f 100644
--- a/src/docs/spell.ok
+++ b/src/docs/spell.ok
@@ -76,6 +76,7 @@ WiredTigerException
 WiredTigerLog
 WiredTigerPanicException
 WiredTigerRollbackException
+WiredTigerStat
 WiredTigerTestCase
 Za
 aR
@@ -442,6 +443,7 @@ writelock
 writelocks
 wrlock
 wtperf
+wtstats
 xa
 yieldcpu
 zlib
diff --git a/src/docs/statistics.dox b/src/docs/statistics.dox
index 067cf342111..7fdc4125254 100644
--- a/src/docs/statistics.dox
+++ b/src/docs/statistics.dox
@@ -153,4 +153,8 @@ A Python script that parses the default logging output and uses the
 Portable Network Graphics (PNG) format graphs is included in the
 WiredTiger distribution in the file \c tools/statlog.py.
 
+@m_if{c}
+To interactively examine statistics results, see @ref wtstats.
+@m_endif
+
 */
diff --git a/src/docs/wtstats.dox b/src/docs/wtstats.dox
new file mode 100644
index 00000000000..608adc2c4f1
--- /dev/null
+++ b/src/docs/wtstats.dox
@@ -0,0 +1,33 @@
+/*! @page wtstats Visualizing performance with wtstats
+
+The WiredTiger distribution includes the \b wtstats tool that can be used to examine
+information generated using statistics logging (see @ref statistics_log).
+
+After running an application with statistics logging configured, the statistics output files will be in the database home directory.  By default, these are named \c WiredTigerStat.* .  In the database home directory, run this command, replacing \c ... with the path to the WiredTiger installation directory:
+\code{.sh}
+python .../tools/wtstats.py WiredTigerStat.*
+\endcode
+
+This will generate a \c wtstats.html file that you can open in your browser to examine statistics.
+
+Here is a sample of what is displayed using \c wtstats.html:
+
+\image html wtstats.png "wtstats.html"
+
+Some things to note about the interface:
+
+- The left sidebar has statistics groups that can each be expanded
+to show individual statistics.  Clicking on a circle toggles whether an
+individual statistic or statistics group is displayed or not.
+
+- The search box at the upper left can be used to search for statistics
+matching a string.
+
+- Hovering over values in the graph will show what the value is, and what
+statistic is being shown.
+
+- The graph can be panned using two fingered scroll or mouse wheel.
+
+- Scaling of the entire graph can be changed using the buttons at the right top.
+
+*/