Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-3707

Document diaglog and its usage

    XMLWordPrintableJSON

Details

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major - P3 Major - P3
    • v1.3.14, mongodb-3.0
    • None
    • manual
    • None

    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/

      Attachments

        Activity

          People

            sam.kleinman Sam Kleinman (Inactive)
            david.hows David Hows
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              9 years, 9 weeks ago