[DOCS-1184] Document output of indexStats() command Created: 01/Mar/13  Updated: 10/Jan/18  Resolved: 25/Apr/13

Status: Closed
Project: Documentation
Component/s: production
Affects Version/s: None
Fix Version/s: mongodb-2.4

Type: Task Priority: Minor - P4
Reporter: sam.helman@10gen.com Assignee: Bob Grabar
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 6 years, 5 weeks ago

 Description   

There is currently no documentation explaining the output of the indexStats() command. https://github.com/10gen-labs/storage-viz#readme is a readme for the usage of the command and visualizer, but there is no field-by-field explanation of the json object the command returns when run manually. This can be placed in the same github repo rather than in the manual.



 Comments   
Comment by Githook User [ 10/Jan/18 ]

Author:

{'email': 'allison.moore@10gen.com', 'name': 'Allison Moore', 'username': 'schmalliso'}

Message: DOCS-1184: 3.6.2 GA
Branch: master
https://github.com/mongodb/docs/commit/89d155fe63acafd919f1aa7eeb832f4243da1ec2

Comment by auto [ 26/Apr/13 ]

Author:

{u'date': u'2013-04-26T19:15:05Z', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: DOCS-1184 index stat reorganization pre-publication
Branch: master
https://github.com/mongodb/docs/commit/c07bf2ab46ffdac6bf8b7b6fa36492fae0f0f659

Comment by auto [ 26/Apr/13 ]

Author:

{u'date': u'2013-04-04T23:27:22Z', u'name': u'Bob Grabar', u'email': u'bob.grabar@10gen.com'}

Message: DOCS-1184 indexStats() command

Signed-off-by: Sam Kleinman <samk@10gen.com>
Branch: master
https://github.com/mongodb/docs/commit/8f19ac5aed90012ee85004ce1911a44a018e69e5

Comment by Bob Grabar [ 18/Apr/13 ]

We've included this in the doc:
.. warning:: The :method:`db.collection.indexStats()` method is not intended for
production deployments.

Comment by Daniel Pasette (Inactive) [ 18/Apr/13 ]

we should have the commands doc'd and of course stress it's experimental nature.

Comment by Daniel Pasette (Inactive) [ 12/Apr/13 ]

Are we also going to document diskStorageStats() and pagesInRam() via the --enableExperimentalStorageDetailsCmd parameter

Generated at Thu Feb 08 07:40:27 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.