[SERVER-46697] Update logv2 readme with opinionated guidance on writing good log messages Created: 06/Mar/20  Updated: 29/Oct/23  Resolved: 27/Apr/20

Status: Closed
Project: Core Server
Component/s: Logging
Affects Version/s: None
Fix Version/s: 4.4.0-rc0, 4.7.0

Type: Task Priority: Major - P3
Reporter: Andy Schwerin Assignee: Eric Sedor
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Backports
Issue split
split to SERVER-46928 update logv2 README with msg capitali... Closed
Related
related to SERVER-46928 update logv2 README with msg capitali... Closed
Backwards Compatibility: Fully Compatible
Backport Requested:
v4.4
Participants:

 Description   

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.



 Comments   
Comment by Githook User [ 26/Mar/20 ]

Author:

{'name': 'esedor', 'username': 'esedor', 'email': 'eric.sedor@mongodb.com'}

Message: SERVER-46697: Update src/mongo/logv2/README.md

Addition in PR review

Co-Authored-By: Andy Schwerin <schwerin@mongodb.com>
Signed-off-by: Eric Milkie <milkie@10gen.com>

Closes #1354

(cherry picked from commit 0200432348a7b2157bd48590f8cce61e6d3431b1)
Branch: v4.4
https://github.com/mongodb/mongo/commit/5cf2a65e90627840ed314d23fcf21f77a38b80ae

Comment by Githook User [ 17/Mar/20 ]

Author:

{'email': 'eric.sedor@mongodb.com', 'name': 'esedor', 'username': 'esedor'}

Message: SERVER-46697: Update src/mongo/logv2/README.md

Addition in PR review

Co-Authored-By: Andy Schwerin <schwerin@mongodb.com>
Signed-off-by: Eric Milkie <milkie@10gen.com>

Closes #1354
Branch: master
https://github.com/mongodb/mongo/commit/0200432348a7b2157bd48590f8cce61e6d3431b1

Comment by Eric Sedor [ 11/Mar/20 ]

Readme is at https://github.com/mongodb/mongo/blob/45eab9f82a18613b877598a951dc7b95f85f2059/src/mongo/logv2/README.md

Generated at Thu Feb 08 05:12:11 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.