diff options
Diffstat (limited to 'src/docs/wtstats.dox')
| -rw-r--r-- | src/docs/wtstats.dox | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/src/docs/wtstats.dox b/src/docs/wtstats.dox new file mode 100644 index 00000000000..1a792849124 --- /dev/null +++ b/src/docs/wtstats.dox @@ -0,0 +1,47 @@ +/*! @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 \<wiredtiger\> with the path to the +WiredTiger installation directory: +\code{.sh} +python <wiredtiger>/tools/wtstats.py WiredTigerStat.* +\endcode + +Another way to process all the stats files in a directory is: + +\code{.sh} +python <wiredtiger>/tools/wtstats.py <directory> +\endcode +In either case, a \c wtstats.html file will be generated in the \e current +directory that you can open in your browser to examine statistics. + +Additional options are available, use <tt>wtstats.py --help</tt> +to display them. + +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. + +*/ |