Uploaded image for project: 'Core Server'
  1. Core Server
  2. SERVER-46697

Update logv2 readme with opinionated guidance on writing good log messages

    • Type: Icon: Task Task
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 4.4.0-rc0, 4.7.0
    • Affects Version/s: None
    • Component/s: Logging
    • Labels:
      None
    • Fully Compatible
    • v4.4

      This ticket is to edit the logv2 readme file as follows:

      • Move the style guide to the top, so developers start by learning about how we want log messages to look
      • Provide clear guidance about what makes good log messages
      • Add concrete examples of interesting, good log messages

      It would probably be good to justify the use of substitution-free, literal strings for messages, and talk a little about selecting good attribute names, as well.

            Assignee:
            eric.sedor@mongodb.com Eric Sedor
            Reporter:
            schwerin@mongodb.com Andy Schwerin
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: