DOCS-1184 indexStats() command

source/core/indexes.txt

@@ -567,6 +567,39 @@ the ``a`` field.
 .. [#hash-size] The hash stored in the ``hashed`` index is 64 bits of the 
    128 bit ``md5`` hash.
 
+.. index:: index; name
+.. _index-names:
+
+Index Names
+-----------
+
+The default name for an index is the concatenation of the indexed keys
+and each key's direction in the index (1 or -1).
+
+.. example:: Issue the following command to create an index on ``item``
+   and ``quantity``:
+
+   .. code-block:: javascript
+
+      db.products.ensureIndex( { item: 1, quantity: -1 } )
+
+   The resulting index is named: ``item_1_quantity_-1``.
+
+Optionally. you can specify a name for an index instead of using the
+default name.
+
+.. example:: Issue the following command to create an index on ``item``
+   and ``quantity`` and specify ``inventory`` as the index name:
+
+   .. code-block:: javascript
+
+      db.products.ensureIndex( { item: 1, quantity: -1 } , {name: "inventory"} )
+
+   The resulting index is named: ``inventory``.
+
+To view the name of an index, use the :method:`getIndexes()
+<db.collection.getIndexes()>` method.
+
 .. index:: index; options
 .. _index-creation-operations:
 .. _index-operations:

source/reference.txt

@@ -44,6 +44,7 @@ Status and Reporting
    reference/database-profiler
    reference/explain
    reference/exit-codes
+   reference/index-stats
 
 Internal Metadata
 -----------------

source/reference/command/indexStats.txt

@@ -0,0 +1,29 @@
+==========
+indexStats
+==========
+
+.. default-domain:: mongodb
+
+.. dbcommand:: indexStats
+
+   The :dbcommand:`indexStats` command aggregates statistics
+   for the B-tree data structure that stores data for a MongoDB index.
+
+   .. warning:: This command is not intended for production deployments.
+
+   The command can be run *only* on a :program:`mongod` instance that uses
+   the ``--enableExperimentalIndexStatsCmd`` option.
+
+   To aggregate statistics, issue the command like so:
+
+   .. code-block:: javascript
+
+      db.runCommand( { indexStats: "<collection>", index: "<index name>" } )
+
+   For more information on the command's limits and output, see the following:
+
+   - The equivalent :method:`db.collection.indexStats()` method
+
+   - :doc:`/reference/index-stats`
+
+   - `https://github.com/10gen-labs/storage-viz#readme <https://github.com/10gen-labs/storage-viz#readme>`_.