[SERVER-62595] Migrate logv2/README.md to docs/logging.md Created: 13/Jan/22  Updated: 29/Oct/23  Resolved: 08/Mar/22

Status: Closed
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: 6.0.0-rc0

Type: Task Priority: Minor - P4
Reporter: Alexander Golin (Inactive) Assignee: Alexander Golin (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Duplicate
duplicates SERVER-46547 Update Server Logging Rules and move ... Closed
duplicates SERVER-48441 Put assertion and log severity select... Closed
Gantt Dependency
has to be done before SERVER-63184 Update and combine docs/logging.md an... Needs Scheduling
Related
is related to SERVER-61801 Clarify tasserts in the exception arc... Closed
Backwards Compatibility: Fully Compatible
Participants:

 Description   

This ticket is the first of two tickets that capture the effort to update logging documentation and collate it into a single location in the repo at docs/logging.md.
In this ticket we will:

  • Move the existing logv2/README.md to a new file at docs/logging.md
  • Update any references to point to the new location
  • Point the Repo Wiki logging doc to the new location

After this ticket is complete we plan to review and update the documentation in SERVER-63184



 Comments   
Comment by Githook User [ 08/Mar/22 ]

Author:

{'name': 'Alexander Golin', 'email': 'agolin95@gmail.com', 'username': 'agolin95'}

Message: SERVER-62595 Migrate logv2 README to docs/logging.md and update references
Branch: master
https://github.com/mongodb/mongo/commit/2207a3236b5174eedaa4b079129629149fd64cf1

Comment by Alexander Golin (Inactive) [ 01/Feb/22 ]

Update: I did some Jira'ing and split this out into two tickets in order to maintain the one PR per ticket best practice. I've moved review/update tasks to SERVER-63184 and am continuing the search for a point person for that effort.

Comment by Alexander Golin (Inactive) [ 14/Jan/22 ]

Thank you for the heads up schwerin!

I'm corresponding with billy.donahue in the draft PR and it's sounding like for the sake of clean commit history we'll plan to merge with just the migration from logv2/README.md to docs/logging.md and then follow up with content edits in a subsequent PR.

Comment by Andy Schwerin [ 13/Jan/22 ]

That sounds like a good plan. Keep an eye on SERVER-61801, which is about updating the documentation about assertions.

Comment by Alexander Golin (Inactive) [ 13/Jan/22 ]

Thanks for commenting Andy! In my first pass at the ticket description I shedded the content updates in the final bullet about review, I'll break this out into more detail!

I wanted to get this aggregate ticket filed so I could reference it in a draft PR so we'd have something tangible to work towards merging, currently it just migrates the logV2 README to the new docs/logging.md: https://github.com/mongodb/mongo/pull/1441
I have a thread going with several of the server leads and I'm going to reach back out to them seeking someone who can take point on reviewing the content in logging.md and the Log Severity Selection Policy for any staleness and to offer suggestions on how to integrate the content.

If you have any suggestions for a better way to go about the review I would love to hear!

Comment by Andy Schwerin [ 13/Jan/22 ]

Which of the tasks mentioned in the description corresponds to the work of SERVER-48441, which is not only to move the policy, but to update it?

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