[DOCS-3707] Document diaglog and its usage Created: 04/Jul/14  Updated: 16/Mar/15  Resolved: 11/Nov/14

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: None
Fix Version/s: v1.3.14, mongodb-3.0

Type: Task Priority: Major - P3
Reporter: David Hows Assignee: Sam Kleinman (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to SERVER-14474 diagLogging command should be deprecated Closed
is related to SERVER-12149 Deprecate --diaglog server option and... Closed
Participants:
Days since reply: 9 years, 9 weeks ago

 Description   

It appears that all our documentation on diaglog has gone missing. IIRC we had a full page of documentation on diaglog historically including when and how to use it;

We should re-create this documentation page and provide:

  1. What diaglog is
  2. What options are used to enable/disable it
  3. What purpose it serves
  4. What data it provides
  5. When you should/should not use it (don't run it in production, etc)

Additionally we should fix the following issues:
http://docs.mongodb.org/manual/reference/command/diagLogging/

  1. Inconsistent spelling of diagLogging, if this is a command name then the casing is important. We should also be consistent within this document - we have diagLogging and diaglogging on the same page
  2. Have the warning consistently displayed on all versions of doc's. 2.2 and 2.4 doc's have a "Warning". The 2.6 version has the text, but not the red warning
    http://docs.mongodb.org/v2.2/reference/command/diagLogging/


 Comments   
Comment by Githook User [ 17/Dec/14 ]

Author:

{u'username': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: DOCS-3707: adding deprecation notice to diagLogging command
Branch: master
https://github.com/mongodb/docs/commit/dab1d13d2014213cf2a5a0fcf63dab55b547cbed

Comment by Sam Kleinman (Inactive) [ 08/Jul/14 ]

We'll leave the docs as they are until 2.8 and add the deprecation notice at that point.

Comment by David Hows [ 04/Jul/14 ]

If its deprecated we should note with a banner on the page. IMO our customers are hurt more when we don't tell them about a feature as they can enable it, without understanding what it does and what the impact is.

There are no doc's on the correct usage of diaglog on the 2.4 or 2.2 pages, which should also be addressed.

Comment by Stennie Steneker (Inactive) [ 04/Jul/14 ]

Diaglog was deprecated in 2.6, so this is expected: SERVER-12149.

Cheers,
Stephen

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